C++ Function Reference

Functions listed by category

Functions By category

Layer Load Functions

GM_CloseLayer - Close a Previously Opened Layer
GM_ClosePackage - Close a Previously Opened Package
GM_FlushLayerCache - Flush In-Memory Cache for Layer
GM_GetAvailableOnlineSourceList - Retrieves List of Available Online Sources
GM_GetLayerInfo - Retrieve Layer Metadata
GM_GetLoadedLayerList - Returns a List of the Loaded Layers
GM_GetOnlineSourceInfo - Get Detailed Information about Online Source and Check Availability
GM_GetPackageLayerList - Retrieve List of Layers in a Package
GM_LoadGenericAsciiTextLayer - Loads Data from a formatted ASCII Text File
GM_LoadLayer (DEPRECATED) - Loads a Data File
GM_LoadLayerList - Loads a Data File
GM_LoadLayerListEx - Loads a Data File with Extra Load Flags
GM_LoadMapLayoutFile - Loads a File to Setup Map Layout Items
GM_LoadOnlineLayer - Loads data from an online source, like WMS or TerraServer-USA
GM_LoadPackage Loads a Global Mapper Package File
GM_LoadRectifiedLayer - Rectify and Load Imagery with Specified Ground Control Points and Projection
GM_LoadTerraServerLayer (DEPRECATED) - Loads data from the TerraServer-USA, including DRG, DOQ, and urban area imagery
GM_RepositionLayer - Reposition Previously Loaded Imagery with New Ground Control Points and/or Projection
GM_RunScript - Runs a Global Mapper Script (.gms) File
GM_SaveWorkspace - Save Current List of Loaded Layers to Workspace (GMW) File
GM_SaveWorkspaceEx - Save List of Loaded Layers to Workspace (GMW) File
GM_SetChildLayerOpCallback - Sets Callback Function for Whenever a Child Layer is Loaded

Display Options/Drawing Functions

GM_AddCustomShader - Add New Custom Elevation or Slope Shader
GM_CropLayerCollar - (DEPRECATED) Crop the Collar off of a DRG or DOQQ Layer
GM_DrawGridLines - Draw Grid Lines to a Device Context
GM_DrawGridLinesEx - Draw Grid Lines to a Device Context Clamped to a Given Rectangle
GM_DrawLayer - Draw One or All Layers to a Device Context
GM_DrawLayerList - Draw One or More Layers to a Device Context
GM_DrawLayerListToMemory - Draw One or More Layers to a Memory Buffer
GM_DrawPackageList - Draw One or More Packages to a Device Context
GM_GetElevationOverrides - Retrieve Elevation Adjustments for Layer
GM_GetLastDrawnScale - Returns the Scale Data was Last Drawn At
GM_GetLastDrawnMapBounds - Gets the most recently drawn map bounds (only supported in Global Mapper Extension SDK)
GM_GetLastDrawnMapBoundsEx - Gets the most recently drawn map bounds, including rotation (only supported in Global Mapper Extension SDK)
GM_GetOnlineLayerZoomScale - Determines the Zoom Scale That a Tiled Online Layer Will Be Accessed at for Draw/Export
GM_GetRasterDisplayOptions - Retrieves the Display Options for a Given Raster or Elevation Layer
GM_GetShaderDisplayOptions - Retrieves the Options to use for the Elevation Shaders
GM_GetVerticalDisplayOptions - Retrieve the Current Vertical Display Options
GM_RemoveCustomShader - Remove a Custom Shader
GM_SetBackgroundColor - Sets the Draw Background Color
GM_SetElevationOverrides - Set Elevation Adjustments for Layer
GM_SetLayerEnabled - Controls Whether or Not a Layer is Displayable
GM_SetLayerPalette - Updates the Palette for a Palette-Based Image Layer
GM_SetOrientation - Sets the Rotation Angle for the Map Display
GM_SetRasterDisplayOptions - Sets the Display Options for a Given Raster or Elevation Layer
GM_SetShaderDisplayOptions - Sets the Options to use for the Elevation Shaders
GM_SetVectorDrawScale - Specify Extra Scaling Factor for Line Widths and Point Symbols
GM_SetVerticalDisplayOptions - Sets the Vertical Display Options
GM_ShowLayerOptionsDialog - Show Display Options Dialog for Layer

Coordinate Conversion/Measurement Functions

GM_CalcBearing - Calculates the Bearing Between Two Points
GM_CalcDistance - Calculates the Distance Between Two Points
GM_CalcEnclosedArea - Calculates the Enclosed Area of a Region
GM_CalcProjectedLocation - Projects Along a Bearing from a Start Point to a New Point
GM_CalcScaleRectangle - Calculate the Ground Rectangle Required to Draw at a Given Scale
GM_CalcWorldRectSize - Calculates the Width and Height of a Bounding Box in Meters
GM_ConvertCoordGroundToPixel - Convert coordinate from ground to pixel coordinates
GM_ConvertCoordGroundToPixelWithOrientation - Convert coordinate from ground to pixel coordinates with orientation
GM_ConvertCoordLayerGroundToPixel - Convert coordinate from ground to layer pixel coordinates
GM_ConvertCoordLayerPixelToGround - Convert coordinate from layer pixel space to ground coordinates
GM_ConvertCoordPixelToGround - Convert coordinate from pixel to ground coordinates
GM_ConvertCoordPixelToGroundWithOrientation - Convert coordinate from pixel to ground coordinates with orientation

Projection/Datum Functions

GM_AddCustomDatum - Adds a New Custom Datum Transformation
GM_AddCustomEllipsoid - Adds a New Custom Ellipsoid
GM_AreProjectionsEquivalent - Checks to See if Two Projections are Equivalent
GM_DecodeMGRSCoordinates - Decode a MGRS Coordinate String into a XY Location
GM_GetAvailableProjectionList - Retrieve the List of Projections that are Available for Use
GM_GetDatumInfo - Gets the Transformation Parameters for a Datum
GM_GetMGRSCoordinates - Get the MGRS Coordinates for a Location
GM_GetProjection - Retrieve the Current View/Export Projection
GM_LoadProjectionFile - Load a Projection from a File
GM_LoadProjectionFromEPSGCode - Initializes a GM_Projection_t structure from an EPSG code
GM_LoadProjectionFromWKTString - Initializes a GM_Projection_t structure from an WKT String
GM_ProjectionGetBase - Retrieves the Underlying Base Projection that Forms the Basis for a Given Projection.
GM_ProjectPoint - Projects a Point from one Projection/Datum to Another
GM_ProjectPointAtElev - Projects a Point from one Projection/Datum to Another at an Elevation Above the Ellipsoid
GM_ProjectPointFromECEF - Projects a Point from ECEF Coordinates
GM_ProjectPointList - Projects a List of Points from one Projection/Datum to Another
GM_ProjectPointToECEF - Projects a Point to ECEF Coordinates
GM_ProjectRectangle - Projects a Rectangle from one Projection/Datum to Another
GM_SaveProjectionToFile - Saves a GM_Projection_t structure to a projection (PRJ) file.
GM_SaveProjectionToString - Saves a GM_Projection_t structure to a WKT string.
GM_SelectProjection - Prompt User for Projection
GM_SelectProjectionEx - Prompt User for Projection with Additional Options
GM_SetQueryProjectionCallback - Sets the Function to Call to Select a Projection
GM_SetProjection - Sets the View/Export Projection/Datum
GM_SetProjectionEx - Sets the View/Export Projection/Datum (w/ Automatic Zone Selection)

Export Functions

GM_ExportElevation - Export One or More Gridded Elevation Layers to a New Elevation Grid File
GM_ExportElevationEx - Export One or More Gridded Elevation Layers to a New Elevation Grid File
GM_ExportMapLayoutComponent - Export a Map Layout Component (i.e. Scale, Legend, etc.) to a BMP File
GM_ExportPackage - Exports Loaded Layers to a New Global Mapper Package (GMP) File
GM_ExportPDF - Exports Loaded Layers to a New Geo-Enabled PDF File
GM_ExportRaster - Export One or More Layers to a New Raster (i.e. GeoTIFF, JPG, etc.) File
GM_ExportRasterEx - Export One or More Layers to a New Raster (i.e. GeoTIFF, JPG, etc.) File
GM_ExportRasterFromBitmap - Export a New Raster (i.e. GeoTIFF, JPG, etc.) File from a Bitmap Handle
GM_ExportVector - Export One or More Layers to a New Vector (i.e. DXF, Shapefile, etc.) File
GM_ExportVectorEx - Export One or More Layers to a New Vector (i.e. DXF, Shapefile, etc.) File
GM_ExportVectorList - Export One or More Layers to a New Vector (i.e. DXF, Shapefile, etc.) File
GM_ExportWebFormat - Export One or More Layers in a Web Browser Format (Google Maps, Virtual Earth, etc.)
GM_SetExportCropAreas - Sets List of Area Features to Crop to During Export

Raster/Elevation Layer Query Functions

GM_GetLocationColor - Retrieve the Pixel Color at a Given Location
GM_GetLocationElevation - Retrieve the Elevation at a Given Location
GM_GetPixelBandValue - Retrieve the Raw Band Value at a Given Pixel Location in a Layer
GM_GetPixelColor - Retrieve the Pixel Color at a Given Pixel Location in a Layer
GM_GetPixelColorRow - Retrieve an Entire Row of Color Values from a Layer
GM_GetPixelElevation - Retrieve the Elevation at a Given Pixel Location in a Layer
GM_GetPixelElevationRow - Retrieve an Entire Row of Elevation Values from a Layer

Vector Layer Query Functions

GM_FindFeaturesInArea - Find Features Inside an Area
GM_FindNearestAddress - Find Address Closest to a Location
GM_FindNearestFeatures - Find Drawn Vector Features Near a Location
GM_FreeAreaFeature - Free the Memory Used by the Area Returned by GM_GetAreaFeature
GM_FreeFeatureResultList - Free Previously Returned Result List
GM_FreeLineFeature - Free the Memory Used by the Line Returned by GM_GetLineFeature
GM_FreePointFeature - Free the Memory Used by the Point Returned by GM_GetPointFeature
GM_GetAreaFeature - Return the Requested Area Feature from the Layer
GM_GetAreaFeatureEx - Return the Requested Area Feature from the Layer
GM_GetFeatureElevation - Get the Elevation for a Feature
GM_GetLineFeature - Return the Requested Line Feature from the Layer
GM_GetLineFeatureEx - Return the Requested Line Feature from the Layer
GM_GetPointFeature - Return the Requested Point Feature from the Layer
GM_GetPointFeatureEx - Return the Requested Point Feature from the Layer
GM_GetSelectedFeatures - Retrieves a list of the features that are currently selected in the Global Mapper display. This function is only supported in a Global Mapper Extension DLL.

Lidar Functions

GM_AddLidarQueryToQuery - Adds a Lidar Query to Another Query
GM_AddRemovePointToLidarQuery - Adds or Removes a Single Point To/From a Lidar Query
GM_CreateEmptyLidarQuery - Creates an Empty Lidar Query
GM_CreateLidarQuery - Create a Lidar Query Result for Fast Data Access and Editing
GM_FreeLidarQuery - Frees a Lidar Query Result
GM_GetLayerLidarStats - Retrieve Lidar Statistics for a Layer
GM_GetLidarPoint - Retrieves the Requested Lidar Point from the Layer
GM_GetLidarQueryInfo - Retrieves Information about a Lidar Query
GM_GetNextLidarQueryPoints - Retrieve the Next Chunk of Points from a Lidar Query
GM_InitLidarQueryFilter - Initialize a Lidar Query Filter to Defaults
GM_LidarClassFilter_IsClassEnabled - Check if Lidar Class is in Class Filter
GM_LidarClassFilter_SetClassEnabled - Enable/Disable Lidar Class in Filter
GM_SetLidarPoint - Updates a Point in a Lidar Point Cloud
GM_UpdateLidarQueryPoints - Edit the Points in a Lidar Query with New Values

Vector Layer Edit Functions

GM_DeleteFeature - Changes the Delete Status of a Vector Feature in a Loaded Layer
GM_IsFeatureDeleted - Queries Delete Status of a Vector Feature in a Loaded Layer
GM_SetAreaFeaturePointList - Sets the List of Point Locations for a Given Area Feature
GM_SetAreaFeaturePointListEx - Sets the List of Point Locations for a Given Area Feature
GM_SetFeatureAttrList - Sets the List of Attribute/Value Pairs to Use for a Feature
GM_SetFeatureClass - Sets the Classification for a Feature
GM_SetFeatureDescription - Sets the Description for a Feature
GM_SetFeatureLabel - Sets the Display Label for a Feature
GM_SetLayerDescription - Sets the Description for the Layer
GM_SetLayerElevationAttribute - Sets the Name of the Elevation Attribute for the Layer
GM_SetLayerElevationUnits - Sets the Elevation Units to use for 3D Vector Features without an Elevation Unit
GM_SetLayerHeightAttribute - Sets the Name of the Height Attribute for the Layer
GM_SetLayerHeightUnits - Sets the Height Units to use for 3D Vector Features without a Height Unit
GM_SetLayerLabelAttribute - Sets the Display Label Attribute
GM_SetLayerUserData - Sets the User Data for the Layer
GM_SetLayerUserText - Sets the User Text for the Layer
GM_SetLineFeaturePointList - Sets the List of Point Locations for a Given Line Feature
GM_SetLineFeaturePointListEx - Sets the List of Point Locations for a Given Line Feature
GM_SetPointFeaturePosition - Sets the Position of a Point Feature

Vector Drawing Style Functions

GM_AddCustomAreaClass - Adds a New Custom Area Classification
GM_AddCustomBrushStyle - Adds a New Custom Brush Style that can be used when Drawing Area Features
GM_AddCustomLineClass - Adds a New Custom Line Classification
GM_AddCustomPointClass - Adds a New Custom Point Classification
GM_AddCustomSymbol - Adds a Custom Symbol that can be Used to Render Point Features
GM_GetAreaFeatureClassDrawStyle - Retrieves the Default Drawing Style for Areas of the Given Type
GM_GetAvailableSymbolNames - Retrieves List of Available Point Symbol Names
GM_GetLidarClassInfo - Retrieves Information about a Given Lidar Class
GM_GetLineFeatureClassDrawStyle - Retrieves the Default Drawing Style for Lines of the Given Type
GM_GetPointFeatureClassDrawStyle - Retrieves the Default Drawing Style for Points of the Given Type
GM_RemoveCustomBrushStyle - Remove a Custom Brush Style
GM_RemoveCustomSymbol - Remove a Custom Symbol
GM_SelectAreaStyle - Displays a Dialog Allowing the User to Graphically Select an Area Style
GM_SelectFont - Displays a Dialog Allowing the User to Graphically Select a Font
GM_SelectLineStyle - Displays a Dialog Allowing the User to Graphically Select a Line Style
GM_SetAreaFeatureClassDrawStyle - Sets the Default Drawing Style for Areas of the Given Type
GM_SetAreaFeatureDrawStyle - Sets the Drawing Style for an Area Feature in a Layer
GM_SetLidarClassInfo - Updates Information about a Given Lidar Class
GM_SetLineFeatureClassDrawStyle - Sets the Default Drawing Style for Lines of the Given Type
GM_SetLineFeatureDrawStyle - Sets the Drawing Style for a Line Feature in a Layer
GM_SetPointFeatureClassDrawStyle - Sets the Default Drawing Style for Points of the Given Type
GM_SetPointFeatureDrawStyle - Sets the Drawing Style for a Point Feature in a Layer

Vector Feature Filtering Functions

GM_GetFeatureClassInfo - Retrieves Information About the Given Feature Class.
GM_SetFeatureClassEnabled - Sets the Drawing Enabled Status of the Given Feature Class

Spatial Database Functions

GM_DBGetTableList - Retrieves List of Tables for Spatial Database
GM_DBIsDatabaseFile - Checks Filename to Check for Spatial Database String
GM_DBMakeConnectionString - Create Connection String for Database
GM_DBSelectTable - Display Dialog for User to Select Table(s) to Load
GM_DBSelectExportTable - Display Dialog for User to Select Table to Export To
GM_DBTableList_Free - Free List of DB Tables
GM_DBTableList_GetCount - Get Count of DB Tables in List
GM_DBTableList_GetTableName - Get DB Table Name from List
GM_DBTestConnection - Test DB Connection String for Validity

GPS Tracking Functions

GM_GPSGetAltitude - Retrieves the Current GPS Altitude
GM_GPSGetBearing - Retrieves the Current GPS Bearing
GM_GPSGetFixInfo - Retrieves the current GPS fix accuracy statistics
GM_GPSGetFixType - Retrieves the Current GPS Fix Type (i.e. No Fix, 2D Fix, 3D Fix, etc.)
GM_GPSGetLocation - Retrieves the Current GPS Location
GM_GPSGetTime - Retrieves the Current GPS Time
GM_GPSGetTimeEx - Retrieves the Current GPS Time w/ Fractional Seconds
GM_GPSGetVelocity - Retrieves the Current GPS Velocity
GM_GPSRenderVessel - Renders a Triangular Vessel at the Current GPS Location
GM_GPSStartTrackingNMEAFile - Replay a Recorded GPS Track from a NMEA Log File
GM_GPSStartTrackingSerial - Starts Tracking a GPS Device Connected on a Serial Port
GM_GPSStartTrackingUSB - Starts Tracking a Garmin USB GPS Device
GM_GPSStopTracking - Stops Tracking any Connected GPS Device

3D View Functions

GM_3DCloseViewWindow - Close 3D View Window
GM_3DGetCameraPosition - Retrieves the Position of the Camera in the Current 3D View
GM_3DIsWindowOpen - Is the 3D View Window Open?
GM_3DPositionCamera - Sets the Position of the Camera in the Current 3D View
GM_3DSaveViewToFile - Saves the Current 3D View to a File
GM_3DSetChangeViewCallback - Set Callback Function for 3D View Requesting New View
GM_3DSetView - Opens 3D View and/or Sets Data to Display

Surface Analysis Functions

GM_CalcAreaElevStats - Calculate the Elevation Statistics Within an Area
GM_CalcViewShed - Performs a View Shed Analysis on Loaded Elevation Layers
GM_CalcVolumeAlongLine - Calculate Cut-and-Fill Volumes Along a Line
GM_CalcVolumeOfArea - Calculate Cut-and-Fill Volumes Within an Area
GM_CombineTerrainLayers - Generate a New Terrain Layer by Combining Two Loaded Terrain Layers with Some Operation
GM_GenerateAreasFromEqualValues - Generate a layer with areas for regions of similar color, elevation, or slope values from a loaded raster or elevation layer
GM_GenerateContours - Generate contour lines using loaded elevation grid layers
GM_GenerateContoursEx - Generate contour lines using one or more loaded elevation grid layers
GM_GenerateDensityGrid - Generates a Density (Heat) Grid from Points of Specified Layer
GM_GenerateElevationGrid - Generates an elevation grid using loaded 3D vector layers
GM_GenerateRoughnessGrid - Generates a Roughness Grid from a Land Cover Layer
GM_GenerateWatershed - Performs a Watershed/Drainage/Stream/Ridge Line Calculation From Loaded Elevation Layers
GM_GetPathProfile - Retrieve a List of Elevations Along a Straight Line
GM_GetPathProfileLOS - Retrieve a 3D Path Profile and Perform Line of Sight Analysis
GM_GetPathProfileLOSEx - Retrieve a 3D Path Profile and Perform Line of Sight Analysis

Map Catalog Functions

GM_MapCatalogAddFile - Add a File to a Map Catalog
GM_MapCatalogAddLayer - Add a Loaded Layer to a Map Catalog
GM_MapCatalogChangeMapOrder - Reorder Maps in a Map Catalog
GM_MapCatalogCreate - Create a New Map Catalog
GM_MapCatalogDisableMap - Disables (or Re-Enables) a Single Map in a Map Catalog
GM_MapCatalogGetInfo - Get Info and Stats About a Loaded Map Catalog
GM_MapCatalogGetMapInfo - Get Info About a Map in a Loaded Map Catalog
GM_MapCatalogRemoveMap - Removes a Map from a Loaded Map Catalog
GM_MapCatalogSave - Saves a Map Catalog to Disk
GM_MapCatalogSetDisplayInfo - Sets when the Layers in a Map Catalog Should be Displayed
GM_MapCatalogSetMapOption - Sets Options for a Single Map in the Map Catalog (i.e. Native Projection)

Custom Layer and Feature Creation Functions

GM_AddAreaToVectorLayer - Adds an Area Feature to a Vector Layer
GM_AddLineToVectorLayer - Adds a Line Feature to a Vector Layer
GM_AddPointToVectorLayer - Adds a Point Feature to a Vector Layer
GM_CombineAreas - Combines Overlapping or Touching Areas
GM_CreateBufferArea - Creates a Buffer Area Some Distance Around Feature
GM_CreateCustomElevGridLayer (DEPRECATED) - Creates a New Custom Elevation Grid Layer based on a user-supplied elevation grid
GM_CreateCustomElevGridLayerEx - Creates a New Custom Elevation Grid Layer based on a user-supplied elevation grid
GM_CreateCustomRasterLayer - Creates a New Custom Raster (Image) Layer based on a user-supplied grid of color values
GM_CreateCustomVectorLayer - Creates a New Custom Layer for Adding Vector Features to
GM_CreateVectorLayerFromFindResults - Creates a New Vector Layer Filled with the Results of a Find Operation

Utility Functions

GM_CreateS63UserPermitFile - Create S63 User Permit File
GM_GetFilterString - Return the File Open Dialog Filter String for Supported Types
GM_GetMiscOption - Gets Current Miscellaneous Option Value
GM_GetProgressCallback - Returns the Current Progress Callback Function
GM_GetSDKBuildDate - Retrieves Build Date of the SDK
GM_GetSDKVersion - Retrieve Version Information
GM_IsRegistered - Is the DLL Registered
GM_SelectFile - Displays a File Open Dialog Allowing the User to Select a File to Open
GM_SetLicenseKey - Sets XML Distribution License Key
GM_SetMessageCallback - Sets the Function to Call to Report Error Messages
GM_SetMiscOption - Sets Miscellaneous Option Value
GM_SetMiscOptionEx - Sets Miscellaneous Option Value (Including Log Filename)
GM_SetProgressCallback - Sets the Function to Call to Report Progress
GM_SetQuickPDFUnlockCode - Sets the QuickPDF Library Unlock Code for PDF Support
GM_SetRegistrationInfo - Use to Provide the DLL Registration Code from Code
GM_SetRegistryKey - Set the Location in the Registry for SDK Settings
GM_SetSettingsFilePath - Set the Path to Look for and Store Settings Files