Functions

Below is a list of Global Mapper python functions, listed by category.

Note

Functions not listed here that are part of the Global Mapping Scripting language can be accessed using the ‘RunScript’ function.

Layer Load Functions

CloseLayer(aLayer)

CloseLayer(GM_LayerHandle_t32 aLayer) -> GM_Error_t32

ClosePackage(aPackage)

ClosePackage(GM_PackageHandle_t32 aPackage) -> GM_Error_t32

FlushLayerCache(aLayer)

FlushLayerCache(GM_LayerHandle_t32 aLayer) -> GM_Error_t32

GetAvailableOnlineSourceList()

GetAvailableOnlineSourceList() -> GM_OnlineSourceInfo_t, uint32

GetLayerInfo(aLayer)

GetLayerInfo(GM_LayerHandle_t32 aLayer) -> GM_LayerInfo_t

GetLoadedLayerList()

GetLoadedLayerList() -> GM_LayerHandle_t32, int

GetOnlineSourceInfo(*args)

GetOnlineSourceInfo(str aSourceName, uint32 aReserved=0) -> GM_Error_t32, GM_OnlineSourceInfo_t

GetPackageLayerList(aPackage)

GetPackageLayerList(GM_PackageHandle_t32 aPackage) -> GM_LayerHandle_t32

LoadGenericAsciiTextLayer(aFilename, ...)

LoadGenericAsciiTextLayer(str aFilename, GM_LoadFlags_t32 aLoadFlags, GM_AsciiFormatInfo_t aFormatInfo, GM_Projection_t aProj) -> GM_Error_t32, GM_LayerHandle_t32

LoadLayer(aFilename, aLoadFlags)

LoadLayer(str aFilename, GM_LoadFlags_t32 aLoadFlags) -> GM_Error_t32, GM_LayerHandle_t

LoadLayerList(aFilename, aLoadFlags)

LoadLayerList(str aFilename, GM_LoadFlags_t32 aLoadFlags) -> GM_Error_t32, GM_LayerHandle_t32, unint32

LoadLayerListEx(aFilename, aLoadFlags, ...)

LoadLayerListEx(str aFilename, GM_LoadFlags_t32 aLoadFlags, str aExtraLoadOptions) -> GM_Error_t32, GM_LayerHandle_t32, uint32

LoadMapLayoutFile(*args)

LoadMapLayoutFile(str aFilename, uint32 aReserved=0) -> GM_Error_t32

LoadOnlineLayer(aSourceName, aLatLonRect, ...)

LoadOnlineLayer(str aSourceName, GM_Rectangle_t aLatLonRect, str aExtraLoadOptions) -> GM_Error_t32, GM_LayerHandle_t32

LoadPackage(aFilename, aLoadFlags)

LoadPackage(str aFilename, GM_LoadFlags_t32 aLoadFlags) -> GM_Error_t32, GM_PackageHandle_t32

LoadRectifiedLayer(aFilename, aLoadFlags, ...)

LoadRectifiedLayer(str aFilename, GM_LoadFlags_t32 aLoadFlags, GM_GroundControlPoint_t aGCPList, uint32 aNumGCPs, GM_Projection_t aProj) -> GM_Error_t32, GM_LayerHandle_t32

RepositionLayer(aLayer, aGCPList, aNumGCPs, ...)

RepositionLayer(GM_LayerHandle_t32 aLayer, GM_GroundControlPoint_t aGCPList, uint32 aNumGCPs, GM_Projection_t aProj) -> GM_Error_t32

RunScript(*args)

RunScript(str aFilenameOrText, GM_LoadFlags_t32 aLoadFlags, uint32 aReserved=0) -> GM_Error_t32, GM_LayerHandle_t32, uint32

SaveWorkspace(*args)

SaveWorkspace(str aFilename, uint32 aReserved=0) -> GM_Error_t32

SaveWorkspaceEx(*args)

SaveWorkspaceEx(str aFilename, [GM_LayerHandle_t32] aLayerList, uint32 aReserved=0) -> GM_Error_t32

SetChildLayerOpCallback(aCallbackFunc)

SetChildLayerOpCallback((function aCallbackFunc, object aUserData)) -> None

SelectFile(aFilterStr, aInitialDir, aParentWnd)

SelectFile(str aFilterStr, str aInitialDir, HWND aParentWnd) -> GM_Error_t32, str

Display Options/Drawing Functions

AddCustomShader(aShader, aReserved)

AddCustomShader(GM_CustomShader_t aShader, uint32 aReserved=0) -> GM_Error_t32

CropLayerCollar(aLayer, aCropCollar)

CropLayerCollar(GM_LayerHandle_t32 aLayer, boolean aCropCollar) -> GM_Error_t32

DrawGridLines(aDC, aLatLonGrid, ...)

DrawGridLines(HDC aDC, boolean aLatLonGrid, float aGridSpacing, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight) -> GM_Error_t32

DrawGridLinesEx(aDC, aLatLonGrid, ...)

DrawGridLinesEx(HDC aDC, boolean aLatLonGrid, float aGridSpacing, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight, GM_Rectangle_t aMaxGridBounds) -> GM_Error_t32

DrawLayer(aDC, aLayer, aWorldBounds, ...)

DrawLayer(HDC aDC, GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight) -> GM_Error_t32

DrawLayerList(aDC, aLayerList, aDrawFlags, ...)

DrawLayerList(HDC aDC, [GM_LayerHandle_t32] aLayerList, GM_DrawFlags_t32 aDrawFlags, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight) -> GM_Error_t32

DrawLayerListToMemory(aLayerList, ...)

DrawLayerListToMemory([GM_LayerHandle_t32] aLayerList, GM_DrawFlags_t32 aDrawFlags, GM_Rectangle_t aWorldBounds, GM_ColorFormat_t32 aColorFormat, sint32 aPixelWidth, sint32 aPixelHeight, int aDataBuf, sint32 aRowWidthBytes) -> GM_Error_t32

DrawLayerListEx(aDC, aLayerList, aDrawFlags, ...)

DrawLayerListEx(HDC aDC, [GM_LayerHandle_t32] aLayerList, GM_DrawFlags_t32 aDrawFlags, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight, str aExtraOpts) -> GM_Error_t32

DrawPackageList(aDC, aPackageList, ...)

DrawPackageList(HDC aDC, GM_PackageHandle_t32 aPackageList, GM_DrawFlags_t32 aDrawFlags, GM_Rectangle_t aWorldBounds, sint32 aLeftPixel, sint32 aTopPixel, sint32 aPixelWidth, sint32 aPixelHeight) -> GM_Error_t32

GetBackgroundColor()

GetBackgroundColor() -> COLORREF

GetElevationOverrides(aLayer)

GetElevationOverrides(GM_LayerHandle_t32 aLayer) -> GM_Error_t32, GM_ElevationOverrides_t

GetElevationShaders(aCustomOnly)

GetElevationShaders(boolean aCustomOnly) -> GM_CustomShader_t

GetLastDrawnScale(aDC)

GetLastDrawnScale(HDC aDC) -> float

GetLastDrawnMapBounds()

GetLastDrawnMapBounds() -> GM_Error_t32, GM_Rectangle_t, GM_PixelRect_t

GetLastDrawnMapBoundsEx(*args)

GetLastDrawnMapBoundsEx(uint32 aReserved=0) -> GM_Error_t32, GM_Rectangle_t, GM_PixelRect_t

GetOnlineLayerZoomScale(*args)

GetOnlineLayerZoomScale(GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, boolean aForExport, str aExtraOpts, uint32 aReserved=0) -> GM_Error_t32, uint32

GetOnlineLayerLocationMetadata(*args)

GetOnlineLayerLocationMetadata(GM_LayerHandle_t32 aLayer, float aXCoord, float aYCoord, uint32 aReserved=0) -> GM_Error_t32, str

GetOrientation()

GetOrientation() -> float

GetRasterDisplayOptions(aLayer)

GetRasterDisplayOptions(GM_LayerHandle_t32 aLayer) -> GM_Error_t32, GM_RasterDisplayOptions_t

GetShaderDisplayOptions()

GetShaderDisplayOptions() -> GM_ShaderOptions_t

GetVerticalDisplayOptions()

GetVerticalDisplayOptions() -> GM_VerticalDisplayOptions_t

RecenterMapDisplay(aCenterPoint)

RecenterMapDisplay(GM_Point_t aCenterPoint) -> GM_Error_t32

RedrawMapDisplay(aNewExtents)

RedrawMapDisplay(GM_Rectangle_t aNewExtents) -> GM_Error_t32

RefreshMapDisplay(aDrawFullExtent)

RefreshMapDisplay(boolean aDrawFullExtent) -> GM_Error_t32

RemoveCustomShader(aShaderName)

RemoveCustomShader(str aShaderName) -> GM_Error_t32

SetBackgroundColor(aBgColor)

SetBackgroundColor(COLORREF aBgColor) -> COLORREF

SetElevationOverrides(aLayer, aOptions)

SetElevationOverrides(GM_LayerHandle_t32 aLayer, GM_ElevationOverrides_t aOptions) -> GM_Error_t32

SetLayerEnabled(aLayer, aEnable)

SetLayerEnabled(GM_LayerHandle_t32 aLayer, boolean aEnable) -> GM_Error_t32

SetLayerPalette(*args)

SetLayerPalette(GM_LayerHandle_t32 aLayer, GM_PaletteEntry_t aNewPalette, uint32 aReserved=0) -> GM_Error_t32

SetOrientation(aOrientation)

SetOrientation(float aOrientation) -> GM_Error_t32

SetRasterDisplayOptions(aLayer, aOptions)

SetRasterDisplayOptions(GM_LayerHandle_t32 aLayer, GM_RasterDisplayOptions_t aOptions) -> GM_Error_t32

SetShaderDisplayOptions(aOptions)

SetShaderDisplayOptions(GM_ShaderOptions_t aOptions) -> GM_Error_t32

SetVectorDrawScale(aDrawScale)

SetVectorDrawScale(float aDrawScale) -> float

SetVerticalDisplayOptions(aVertDispOpts)

SetVerticalDisplayOptions(GM_VerticalDisplayOptions_t aVertDispOpts) -> GM_Error_t32

ShowLayerOptionsDialog(aLayerList)

ShowLayerOptionsDialog([GM_LayerHandle_t32] aLayerList) -> GM_Error_t32

Coordinate Conversion/Measurement Functions

AddCustomDatum(aDatumInfo)

AddCustomDatum(GM_DatumInfo_t aDatumInfo) -> GM_Error_t32, DATUM

AddCustomEllipsoid(aEllipsoidName, ...)

AddCustomEllipsoid(str aEllipsoidName, float aSemiMajor, float aSemiMinor) -> GM_Error_t32

AreProjectionsEquivalent(aProj1, aProj2)

AreProjectionsEquivalent(GM_Projection_t aProj1, GM_Projection_t aProj2) -> GM_Error_t32, boolean

CalcBearing(aFromX, aFromY, aToX, aToY, aFlags)

CalcBearing(float aFromX, float aFromY, float aToX, float aToY, GM_CalcBearingFlags_t8 aFlags) -> GM_Error_t32, float

CalcDistance(aFromX, aFromY, aToX, aToY, aLatLon)

CalcDistance(float aFromX, float aFromY, float aToX, float aToY, boolean aLatLon) -> GM_Error_t32, float

CalcEnclosedArea(aPtList, aNumPoints, aProj)

CalcEnclosedArea(GM_Point_t_array aPtList, int aNumPoints, GM_Projection_t aProj) -> GM_Error_t32, double

CalcProjectedLocation(aFromX, aFromY, ...)

CalcProjectedLocation(float aFromX, float aFromY, float aBearing, float aDist, boolean aLatLon) -> GM_Error_t32, float, float

CalcScaleRectangle(aCenterPoint, aScale, ...)

CalcScaleRectangle(GM_Point_t aCenterPoint, float aScale, HDC aDC, sint32 aPixWidth, sint32 aPixHeight) -> GM_Error_t32, GM_Rectangle_t

CalcWorldRectSize(aWorldBounds)

CalcWorldRectSize(GM_Rectangle_t aWorldBounds) -> GM_Error_t32, float, float

ConvertCoordGroundToPixel(aGroundX, ...)

ConvertCoordGroundToPixel(float aGroundX, float aGroundY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect) -> GM_Error_t32, sint32, sint32

ConvertCoordGroundToPixelDouble(aGroundX, ...)

ConvertCoordGroundToPixelDouble(float aGroundX, float aGroundY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect) -> GM_Error_t32, float, float

ConvertCoordGroundToPixelWithOrientation(...)

ConvertCoordGroundToPixelWithOrientation(float aGroundX, float aGroundY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, float aOrientation) -> GM_Error_t32, sint32, sint32

ConvertCoordGroundToPixelWithOrientationDouble(...)

ConvertCoordGroundToPixelWithOrientationDouble(float aGroundX, float aGroundY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, float aOrientation) -> GM_Error_t32, float, float

ConvertCoordLayerGroundToPixel(aLayer, ...)

ConvertCoordLayerGroundToPixel(GM_LayerHandle_t32 aLayer, float aGroundX, float aGroundY) -> GM_Error_t32, float, float

ConvertCoordLayerPixelToGround(aLayer, ...)

ConvertCoordLayerPixelToGround(GM_LayerHandle_t32 aLayer, float aPixelX, float aPixelY) -> GM_Error_t32, float, float

ConvertCoordPixelToGround(aPixelX, aPixelY, ...)

ConvertCoordPixelToGround(sint32 aPixelX, sint32 aPixelY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect) -> GM_Error_t32, float, float

ConvertCoordPixelToGroundDouble(aPixelX, ...)

ConvertCoordPixelToGroundDouble(float aPixelX, float aPixelY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect) -> GM_Error_t32, float, float

ConvertCoordPixelToGroundWithOrientation(...)

ConvertCoordPixelToGroundWithOrientation(sint32 aPixelX, sint32 aPixelY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, float aOrientation) -> GM_Error_t32, float, float

ConvertCoordPixelToGroundWithOrientationDouble(...)

ConvertCoordPixelToGroundWithOrientationDouble(float aPixelX, float aPixelY, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, float aOrientation) -> GM_Error_t32, float, float

DecodeMGRSCoordinates(aMgrsStr, aLatLon)

DecodeMGRSCoordinates(str aMgrsStr, boolean aLatLon) -> GM_Error_t32, float, float

GetAvailableProjectionList()

GetAvailableProjectionList() -> [GM_ProjectionInfo_t]

GetDatumInfo(aDatumCode)

GetDatumInfo(DATUM aDatumCode) -> GM_Error_t32, GM_DatumInfo_t

GetMGRSCoordinates(aX, aY, aLatLon)

GetMGRSCoordinates(float aX, float aY, boolean aLatLon) -> GM_Error_t32, string

GetProjection()

GetProjection() -> GM_Error_t32, GM_Projection_t

LoadProjectionFile(aFilename)

LoadProjectionFile(str aFilename) -> GM_Error_t32, GM_Projection_t

LoadProjectionFromEPSGCode(aEpsgCode)

LoadProjectionFromEPSGCode(uint32 aEpsgCode) -> GM_Error_t32, GM_Projection_t

LoadProjectionFromWKTString(aStr)

LoadProjectionFromWKTString(str aStr) -> GM_Error_t32, GM_Projection_t

ProjectionGetBase(aProjIn)

ProjectionGetBase(GM_Projection_t aProjIn) -> GM_Error_t32, GM_Projection_t

ProjectPoint(aXIn, aYIn, aProjIn, aProjTo)

ProjectPoint(float aXIn, float aYIn, GM_Projection_t aProjFrom, GM_Projection_t aProjTo) -> GM_Error_t32, float, float

ProjectPointAtElev(aXIn, aYIn, aProjIn, ...)

ProjectPointAtElev(float aXIn, float aYIn, GM_Projection_t aProjIn, GM_Projection_t aProjOut, float aElev) -> GM_Error_t32, float, float

ProjectPointFromECEF(aX, aY, aZ, aDatum, aProjTo)

ProjectPointFromECEF(float aX, float aY, float aZ, DATUM aDatum, GM_Projection_t aProjOut) -> GM_Error_t32, float, float, float

ProjectPointList(INOUT, IN_LIST, aProjIn, ...)

ProjectPointList([GM_Point_t] aPointList, [float] aElevationsList, GM_Projection_t aProjIn, GM_Projection_t aProjTo) -> GM_Error_t32

ProjectPointListArr(aPointArray, ...)

ProjectPointListArr(GM_Point_t aPointArray, uint32 aPointArraySize, float aElevations, GM_Projection_t aProjIn, GM_Projection_t aProjOut) -> GM_Error_t32

ProjectPointToECEF(aXIn, aYIn, aZIn, aDatum, ...)

ProjectPointToECEF(float aXIn, float aYIn, float aZIn, DATUM aDatum, GM_Projection_t aProjIn) -> GM_Error_t32, float, float, float

ProjectRectangle(aRectIn, aProjIn, aProjTo)

ProjectRectangle(GM_Rectangle_t aRectIn, GM_Projection_t aProjIn, GM_Projection_t aProjOut) -> GM_Error_t32, GM_Rectangle_t

SaveProjectionToFile(aFilename, aProj, aReserved)

SaveProjectionToFile(str aFilename, GM_Projection_t aProj, uint32 aReserved=0) -> GM_Error_t32

SaveProjectionToString(aProj, aBufferLen, ...)

SaveProjectionToString(GM_Projection_t aProj, uint32 aBufSize, uint32 aReserved=0) -> GM_Error_t32, str

SelectProjection(aInitProj)

SelectProjection(GM_Projection_t aInitProj) -> GM_Error_t32, GM_Projection_t

SelectProjectionEx(*args)

SelectProjectionEx(GM_Projection_t aInitProj, POINT aDlgPos, GM_SelectProjFlags_t32 aFlags, uint32 aReserved=0) -> GM_Error_t32, GM_Projection_t

SetQueryProjectionCallback(aCallbackFunc)

SetQueryProjectionCallback(GM_QueryProjectionCallbackFunc aCallbackFunc) -> None

SetProjection(aProj)

SetProjection(GM_Projection_t aProj) -> GM_Error_t32

SetProjectionEx(*args)

SetProjectionEx(GM_Projection_t aProj, GM_Rectangle_t aLatLonRect, uint32 aReserved=0) -> GM_Error_t32

Export Functions

ExportElevation(aFilename, aFormat, aLayer, ...)

ExportElevation(str aFilename, GM_ElevationExportFormat_t32 aFormat, GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, sint32 aPixelWidth, sint32 aPixelHeight, GM_RasterExportFlags_t32 aFlags, GM_ElevUnits_t8 aElevUnits) -> GM_Error_t32

ExportElevationEx(aFilename, aFormat, ...)

ExportElevationEx(str aFilename, GM_ElevationExportFormat_t32 aFormat, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, sint32 aPixelWidth, sint32 aPixelHeight, GM_RasterExportFlags_t32 aFlags, GM_ElevUnits_t8 aElevUnits, str aExtraFlags) -> GM_Error_t32

ExportGeoPackage(aFilename, aLayerList, ...)

ExportGeoPackage(str aFilename, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, GM_ExportOptsGeoPackage_t aExportOpts) -> GM_Error_t32

ExportMapLayoutComponent(*args)

ExportMapLayoutComponent(str aFilename, GM_MapLayoutPiece_t8 aPiece, GM_Rectangle_t aWorldBounds, sint32 aPixelWidth, sint32 aPixelHeight, uint32 aReserved=0) -> GM_Error_t32

ExportPackage(aFilename, aLayerList, ...)

ExportPackage(str aFilename, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, float aSimpThreshold, GM_PackageExportFlags_t32 aFlags) -> GM_Error_t32

ExportPDF(aFilename, aLayerList, ...)

ExportPDF(str aFilename, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, GM_ExportOptsPDF_t aExportOpts) -> GM_Error_t32

ExportRaster(aFilename, aFormat, aLayer, ...)

ExportRaster(str aFilename, GM_RasterExportFormat_t32 aFormat, GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, sint32 aPixelWidth, sint32 aPixelHeight, GM_RasterExportFlags_t32 aFlags) -> GM_Error_t32

ExportRasterEx(aFilename, aFormat, ...)

ExportRasterEx(str aFilename, GM_RasterExportFormat_t32 aFormat, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, sint32 aPixelWidth, sint32 aPixelHeight, GM_RasterExportFlags_t32 aFlags, str aExtraFlags) -> GM_Error_t32

ExportRasterFromBitmap(aFilename, aBitmap, ...)

ExportRasterFromBitmap(str aFilename, HBITMAP aBitmap, HDC aDC, GM_RasterExportFormat_t32 aFormat, GM_Rectangle_t aWorldBounds, GM_RasterExportFlags_t32 aFlags) -> GM_Error_t32

ExportVector(aFilename, aFormat, aLayer, ...)

ExportVector(str aFilename, GM_VectorExportFormat_t32 aFormat, GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, GM_VectorExportFlags_t32 aFlags, int aFormatOptions) -> GM_Error_t32

ExportVectorEx(aFilename, aFormat, aLayer, ...)

ExportVectorEx(str aFilename, GM_VectorExportFormat_t32 aFormat, GM_LayerHandle_t32 aLayer, GM_Rectangle_t aWorldBounds, GM_VectorExportFlags_t32 aFlags, int aFormatOptions, str aExtraFlags) -> GM_Error_t32

ExportVectorList(*args)

ExportVectorList(str aFilename, GM_VectorExportFormat_t32 aFormat, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, GM_VectorExportFlags_t32 aFlags, int aFormatOptions, str aExtraFlags, uint32 aReserved=0) -> GM_Error_t32

ExportWebFormat(aFilename, aWebFormat, ...)

ExportWebFormat(str aFilename, GM_WebExportFormat_t32 aWebFormat, [GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, GM_WebFormatExportOpts_t aExportOpts, str aExtraFlags) -> GM_Error_t32

SetExportCropAreas(aAreaList, aNumAreas, ...)

SetExportCropAreas(GM_AreaFeature_t aAreaList, uint32 aNumAreas, GM_Projection_t aAreaProj) -> GM_Error_t32

Raster/Elevation Layer Query Functions

GetLocationColor(aLayer, aXCoord, aYCoord)

GetLocationColor(GM_LayerHandle_t32 aLayer, float aXCoord, float aYCoord) -> GM_Error_t32, GM_Color_t

GetLocationElevation(aLayer, aXCoord, aYCoord)

GetLocationElevation(GM_LayerHandle_t32 aLayer, float aXCoord, float aYCoord) -> GM_Error_t32, float

GetLocationElevationEx(aLayerList, aXCoord, ...)

GetLocationElevationEx([GM_LayerHandle_t32] aLayerList, float aXCoord, float aYCoord) -> GM_Error_t32, float

GetPixelBandValue(aLayer, aRow, aCol, aBand)

GetPixelBandValue(GM_LayerHandle_t32 aLayer, sint32 aRow, sint32 aCol, sint32 aBand) -> GM_Error_t32, sint32

GetPixelColor(aLayer, aRow, aCol)

GetPixelColor(GM_LayerHandle_t32 aLayer, sint32 aRow, sint32 aCol) -> GM_Error_t32, GM_Color_t

GetPixelColorRow(aLayer, aRow, aColorRow, ...)

GetPixelColorRow(GM_LayerHandle_t32 aLayer, sint32 aRow, COLORREF aInvalidVal) -> GM_Error_t32, COLORREF

GetPixelDataInRect(*args)

GetPixelDataInRect(GM_LayerHandle_t32 aLayer, GM_PixelRect_t aPixelRect, GM_RasterLayout_t aRasterLayout, int aDataBuf, uint32 aReserved=0) -> GM_Error_t32

GetPixelElevation(aLayer, aRow, aCol)

GetPixelElevation(GM_LayerHandle_t32 aLayer, sint32 aRow, sint32 aCol) -> GM_Error_t32, float

GetPixelElevationRow(aLayer, aRow, aElevRow, ...)

GetPixelElevationRow(GM_LayerHandle_t32 aLayer, sint32 aRow, float_array aElevRow, float aInvalidVal) -> GM_Error_t32

toRGB(r, g, b)

toRGB(uint8 r, uint8 g, uint8 b) -> COLORREF

toRGBA(r, g, b, a)

toRGBA(uint8 r, uint8 g, uint8 b, uint8 a) -> COLORREF

Vector Layer Query Functions

FindFeaturesInArea(*args)

FindFeaturesInArea([GM_LayerHandle_t32] aLayerList, GM_FindFlags_t32 aFindFlags, GM_AreaFeature_t aAreaToSearch, GM_Projection_t aAreaProj, uint32 aReserved=0) -> GM_Error_t32, GM_FoundFeatureResults_t

FindNearestAddress(*args)

FindNearestAddress(GM_Point_t aSearchPt, [GM_LayerHandle_t32] aLayerList, float aMaxDistMeters, uint32 aReserved=0) -> GM_Error_t32, str

FindNearestFeatures(aPixelSearchPt, ...)

FindNearestFeatures(GM_Point_t aPixelSearchPt, [GM_LayerHandle_t32] aLayerList, GM_FindFlags_t32 aFindFlags, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, uint32 MAX_OUTPUT_LEN, uint32 aMaxDistPixels) -> GM_Error_t32, GM_FoundFeature_t, uint32

FreeAreaFeature(aAreaFeature)

FreeAreaFeature(GM_AreaFeature_t aAreaFeature) -> None

FreeFeatureResultList(aResultList)

FreeFeatureResultList(GM_FoundFeatureResults_t aResultList) -> GM_Error_t32

FreeLineFeature(aLineFeature)

FreeLineFeature(GM_LineFeature_t aLineFeature) -> None

FreePointFeature(aPointFeature)

FreePointFeature(GM_PointFeature_t aPointFeature) -> None

GetAreaFeature(aLayer, aAreaIndex)

GetAreaFeature(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex) -> GM_AreaFeature_t

GetAreaFeatureEx(*args)

GetAreaFeatureEx(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, GM_GetFeatureFlags_t32 aFlags, uint32 aReserved=0) -> GM_AreaFeature_t

GetFeatureElevation(aLayer, ...)

GetFeatureElevation(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex) -> GM_Error_t32, float

GetLineFeature(aLayer, aLineIndex)

GetLineFeature(GM_LayerHandle_t32 aLayer, uint32 aLineIndex) -> GM_LineFeature_t

GetLineFeatureEx(*args)

GetLineFeatureEx(GM_LayerHandle_t32 aLayer, uint32 aLineIndex, GM_GetFeatureFlags_t32 aFlags, uint32 aReserved=0) -> GM_LineFeature_t

GetPointFeature(aLayer, aPointIndex)

GetPointFeature(GM_LayerHandle_t32 aLayer, uint32 aPointIndex) -> GM_PointFeature_t

GetPointFeatureEx(*args)

GetPointFeatureEx(GM_LayerHandle_t32 aLayer, uint32 aPointIndex, GM_GetFeatureFlags_t32 aFlags, uint32 aReserved=0) -> GM_PointFeature_t

GetSelectedFeatures(*args)

GetSelectedFeatures(GM_SelectFlags_t32 aFlags, uint32 aReserved=0) -> GM_Error_t32, GM_FoundFeatureResults_t

Lidar Functions

AddLidarQueryToQuery(*args)

AddLidarQueryToQuery(GM_LidarQueryHandle_t aAddToLidarQuery, GM_LidarQueryHandle_t aAddFromLidarQuery, uint32 aReserved=0) -> GM_Error_t32

AddRemovePointToLidarQuery(aLidarQuery, ...)

AddRemovePointToLidarQuery(GM_LidarQueryHandle_t aLidarQuery, GM_LayerHandle_t32 aLayer, uint64 aPointIndex, boolean aAddPoint) -> GM_Error_t32

CreateEmptyLidarQuery()

CreateEmptyLidarQuery() -> GM_Error_t32, GM_LidarQueryHandle_t

CreateLidarQuery(aLayerList, aWorldBounds, ...)

CreateLidarQuery([GM_LayerHandle_t32] aLayerList, GM_Rectangle_t aWorldBounds, GM_LidarQueryFilter_t aFilter) -> GM_Error_t32, GM_LidarQueryHandle_t

CreateSwathSeparationImage(*args)

CreateSwathSeparationImage(str aOutputImageFilename, GM_SwathSeparationImageSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32, GM_LayerHandle_t32

FreeLidarQuery(aLidarQuery)

FreeLidarQuery(GM_LidarQueryHandle_t aLidarQuery) -> GM_Error_t32

GetLayerLidarStats(*args)

GetLayerLidarStats(GM_LayerHandle_t32 aLayer, uint32 aReserved=0) -> GM_Error_t32, GM_LidarStats_t

GetLidarClassFilter()

GetLidarClassFilter() -> GM_Error_t32, GM_LidarClassFilter_t

GetLidarClassInfo(aLidarClass, aGetDefault)

GetLidarClassInfo(GM_LidarClass_t8 aLidarClass, boolean aGetDefault) -> GM_Error_t32, GM_LidarClassInfo_t

GetLidarPoint(*args)

GetLidarPoint(GM_LayerHandle_t32 aLayer, uint64 aPointIndex, GM_GetFeatureFlags_t32 aFlags, uint32 aReserved=0) -> GM_Error_t32, GM_LidarPoint_t

GetLidarQueryInfo(aLidarQuery)

GetLidarQueryInfo(GM_LidarQueryHandle_t aLidarQuery) -> GM_Error_t32, GM_LidarQueryInfo_t

GetNextLidarQueryPoints(*args)

GetNextLidarQueryPoints(GM_LidarQueryHandle_t aLidarQuery, GM_LidarPoint_array aPointList, uint32 aListSize, GM_GetFeatureFlags_t32 aFlags, uint32 aReserved=0) -> GM_Error_t32, uint32

InitLidarQueryFilter(aEmptyClassFilter)

InitLidarQueryFilter(boolean aEmptyClassFilter) -> GM_Error_t32, GM_LidarQueryFilter_t

LidarClassFilter_EnableGroups(INOUT, ...)

LidarClassFilter_EnableGroups(GM_LidarClassFilter_t aClassFilter, GM_LidarClassGroup_t16 aGroupMask, boolean aMatchAny) -> GM_Error_t32, GM_LidarClassFilter_t

LidarClassFilter_Init(aEnableAll)

LidarClassFilter_Init(boolean aEnableAll) -> GM_Error_t32, GM_LidarClassFilter_t

LidarClassFilter_IsClassEnabled(...)

LidarClassFilter_IsClassEnabled(GM_LidarClassFilter_t aClassFilter, GM_LidarClass_t8 aClass) -> boolean

LidarClassFilter_SetClassEnabled(INOUT, ...)

LidarClassFilter_SetClassEnabled(GM_LidarClassFilter_t aClassFilter, GM_LidarClass_t8 aClass, boolean aEnable) -> GM_Error_t32, GM_LidarClassFilter_t

LidarClassifyBuildingVeg(*args)

LidarClassifyBuildingVeg([GM_LayerHandle_t32] aLayerList, GM_ClassifyNonGroundSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyBuildingVegFromQuery(*args)

LidarClassifyBuildingVegFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_ClassifyNonGroundSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyGraph(*args)

LidarClassifyGraph([GM_LayerHandle_t32] aLayerList, GM_ClassifyGraphSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyGraphFromQuery(*args)

LidarClassifyGraphFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_ClassifyGraphSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyGround(*args)

LidarClassifyGround([GM_LayerHandle_t32] aLayerList, GM_ClassifyGroundSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyGroundFromQuery(*args)

LidarClassifyGroundFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_ClassifyGroundSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyNoise(*args)

LidarClassifyNoise([GM_LayerHandle_t32] aLayerList, GM_ClassifyNoiseSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyNoiseFromQuery(*args)

LidarClassifyNoiseFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_ClassifyNoiseSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyPolePower(*args)

LidarClassifyPolePower([GM_LayerHandle_t32] aLayerList, GM_ClassifyPolePowerSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarClassifyPolePowerFromQuery(*args)

LidarClassifyPolePowerFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_ClassifyPolePowerSetup_t aSettings, uint32 aReserved=0) -> GM_Error_t32

LidarColorize(*args)

LidarColorize(GM_LayerHandle_t32 aLidarLayer, [GM_LayerHandle_t32] aLayerList, GM_LidarColorizeSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

LidarColorizeQuery(*args)

LidarColorizeQuery(GM_LidarQueryHandle_t aLidarQuery, [GM_LayerHandle_t32] aLayerList, GM_LidarColorizeSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

LidarCompare(*args)

LidarCompare([GM_LayerHandle_t32] aLayerList, [GM_LayerHandle_t32] aLayerList2, GM_LidarCompareSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

LidarCompareQuery(*args)

LidarCompareQuery(GM_LidarQueryHandle_t aQueryCompareTo, GM_LidarQueryHandle_t aQueryCompare, GM_LidarCompareSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

LidarExtractFeatures(*args)

LidarExtractFeatures([GM_LayerHandle_t32] aLayerList, GM_LidarExtractSetup_t aExtractOpts, uint32 aReserved=0) -> GM_Error_t32, GM_LidarExtractOutput_t

LidarExtractFeaturesFromQuery(*args)

LidarExtractFeaturesFromQuery(GM_LidarQueryHandle_t aLidarQuery, GM_LidarExtractSetup_t aExtractOpts, uint32 aReserved=0) -> GM_Error_t32, GM_LidarExtractOutput_t

LidarThin(*args)

LidarThin(GM_LayerHandle_t32 aLayer, GM_LidarSpatialThinSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

PixelsToPoints(*args)

PixelsToPoints(GM_P2PSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32

PixelsToPointsInitSetup()

PixelsToPointsInitSetup() -> GM_Error_t32, GM_P2PSetup_t

SetLidarClassFilter(aClassFilter)

SetLidarClassFilter(GM_LidarClassFilter_t aClassFilter) -> GM_Error_t32

SetLidarClassInfo(aLidarClass, aClassInfo)

SetLidarClassInfo(GM_LidarClass_t8 aLidarClass, GM_LidarClassInfo_t aClassInfo) -> GM_Error_t32

SetLidarPoint(*args)

SetLidarPoint(GM_LayerHandle_t32 aLayer, uint64 aPointIndex, GM_LidarPoint_t aLidarPoint, uint32 aReserved=0) -> GM_Error_t32

UpdateLidarQueryPoints(*args)

UpdateLidarQueryPoints(GM_LidarQueryHandle_t aLidarQuery, GM_LidarFieldMask_t32 aValidFields, GM_LidarPoint_t aNewPointData, uint32 aReserved=0) -> GM_Error_t32

Vector Layer Edit Functions

AddHoleInArea(aLayer, aAreaIndex, ...)

AddHoleInArea(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, GM_HoleInArea_t aNewHoleDef, boolean aCheckHoleInParent) -> GM_Error_t32

DeleteFeature(aLayer, aFeatureClassType, ...)

DeleteFeature(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, boolean aDelete) -> GM_Error_t32

DeleteHoleInArea(aLayer, aAreaIndex, ...)

DeleteHoleInArea(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, uint32 aHoleIndex, boolean aDelete) -> GM_Error_t32

IsFeatureDeleted(aLayer, aFeatureClassType, ...)

IsFeatureDeleted(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex) -> GM_Error_t32, boolean

IsHoleInAreaDeleted(aLayer, aAreaIndex, ...)

IsHoleInAreaDeleted(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, uint32 aHoleIndex) -> GM_Error_t32, boolean

SetAreaFeaturePointList(aLayer, aAreaIndex, ...)

SetAreaFeaturePointList(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, uint32 aHoleIndex, GM_Point_t aPointList, boolean aPosInLayerCoords) -> GM_Error_t32

SetAreaFeaturePointListEx(aLayer, ...)

SetAreaFeaturePointListEx(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, uint32 aHoleIndex, [GM_Point_t] aPointList, boolean aPosInLayerCoords, float_array aElevList) -> GM_Error_t32

SetFeatureAttrList(aLayer, ...)

SetFeatureAttrList(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, GM_AttrValue_t aAttrList, uint16 aNumAttrs) -> GM_Error_t32

SetFeatureClass(aLayer, aFeatureClassType, ...)

SetFeatureClass(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, FeatureClass_t16 aFeatureClass) -> GM_Error_t32

SetFeatureDescription(aLayer, ...)

SetFeatureDescription(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, str aDesc) -> GM_Error_t32

SetFeatureLabel(aLayer, aFeatureClassType, ...)

SetFeatureLabel(GM_LayerHandle_t32 aLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, str aLabel) -> GM_Error_t32

SetLayerDescription(aLayer, aDesc)

SetLayerDescription(GM_LayerHandle_t32 aLayer, str aDesc) -> GM_Error_t32

SetLayerElevationAttribute(aLayer, ...)

SetLayerElevationAttribute(GM_LayerHandle_t32 aLayer, str aAttrName, uint32 aReserved=0) -> GM_Error_t32

SetLayerHeightAttribute(aLayer, aAttrName, ...)

SetLayerHeightAttribute(GM_LayerHandle_t32 aLayer, str aAttrName, uint32 aReserved=0) -> GM_Error_t32

SetLayerHeightUnits(aLayer, aHeightUnits)

SetLayerHeightUnits(GM_LayerHandle_t32 aLayer, GM_ElevUnits_t8 aHeightUnits) -> GM_Error_t32

SetLayerElevationUnits(aLayer, aElevUnits)

SetLayerElevationUnits(GM_LayerHandle_t32 aLayer, GM_ElevUnits_t8 aElevUnits) -> GM_Error_t32

SetLayerLabelAttribute(aLayer, aAttrName, ...)

SetLayerLabelAttribute(GM_LayerHandle_t32 aLayer, str aAttrName, uint32 aReserved=0) -> GM_Error_t32

SetLayerUserData(aLayer, aUserData)

SetLayerUserData(GM_LayerHandle_t32 aLayer, int aUserData) -> GM_Error_t32

SetLayerUserText(aLayer, aUserText)

SetLayerUserText(GM_LayerHandle_t32 aLayer, str aUserText) -> GM_Error_t32

SetLineFeaturePointList(aLayer, aLineIndex, ...)

SetLineFeaturePointList(GM_LayerHandle_t32 aLayer, uint32 aLineIndex, GM_Point_t aPointList, boolean aPosInLayerCoords) -> GM_Error_t32

SetLineFeaturePointListEx(aLayer, ...)

SetLineFeaturePointListEx(GM_LayerHandle_t32 aLayer, uint32 aLineIndex, [GM_Point_t] aPointList, boolean aPosInLayerCoords, float_array aElevList) -> GM_Error_t32

SetPointFeaturePosition(aLayer, aPointIndex, ...)

SetPointFeaturePosition(GM_LayerHandle_t32 aLayer, uint32 aPointIndex, GM_Point_t aPosition, boolean aPosInLayerCoords) -> GM_Error_t32

Vector Drawing Style Functions

AddCustomAreaClass(aName, aStyle)

AddCustomAreaClass(str aName, GM_AreaStyle_t aStyle) -> GM_Error_t32, AreaFeatureClass_t16

AddCustomBrushStyle(aImageFilename, aStyleName)

AddCustomBrushStyle(str aImageFilename, str aStyleName) -> GM_Error_t32, GM_BrushStyle_t16

AddCustomLineClass(aName, aStyle)

AddCustomLineClass(str aName, GM_LineStyle_t aStyle) -> GM_Error_t32, LineFeatureClass_t16

AddCustomPointClass(aName, aStyle)

AddCustomPointClass(str aName, GM_PointStyle_t aStyle) -> GM_Error_t32, PointFeatureClass_t16

AddCustomSymbol(aSymbolFilename, aSymbolName)

AddCustomSymbol(str aSymbolFilename, str aSymbolName) -> GM_Error_t32

GetAreaFeatureClassDrawStyle(aFeatureClass)

GetAreaFeatureClassDrawStyle(AreaFeatureClass_t16 aFeatureClass) -> GM_Error_t32, GM_AreaStyle_t

GetAvailableSymbolNames()

GetAvailableSymbolNames() -> [str]

GetLineFeatureClassDrawStyle(aFeatureClass)

GetLineFeatureClassDrawStyle(LineFeatureClass_t16 aFeatureClass) -> GM_Error_t32, GM_LineStyle_t

GetPointFeatureClassDrawStyle(aFeatureClass)

GetPointFeatureClassDrawStyle(PointFeatureClass_t16 aFeatureClass) -> GM_Error_t32, GM_PointStyle_t

RemoveCustomBrushStyle(aBrushName)

RemoveCustomBrushStyle(str aBrushName) -> GM_Error_t32

RemoveCustomSymbol(aSymbolName)

RemoveCustomSymbol(str aSymbolName) -> GM_Error_t32

SelectAreaStyle(aAreaStyle)

SelectAreaStyle(GM_AreaStyle_t aAreaStyle) -> GM_Error_t32

SelectFont(aFontDef)

SelectFont(GM_FontDef_t aFontDef) -> GM_Error_t32

SelectLineStyle(aLineStyle)

SelectLineStyle(GM_LineStyle_t aLineStyle) -> GM_Error_t32

SetAreaFeatureClassDrawStyle(aFeatureClass, ...)

SetAreaFeatureClassDrawStyle(AreaFeatureClass_t16 aFeatureClass, GM_AreaStyle_t aAreaStyle) -> GM_Error_t32

SetAreaFeatureDrawStyle(aLayer, aAreaIndex, ...)

SetAreaFeatureDrawStyle(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, GM_AreaStyle_t aAreaStyle) -> GM_Error_t32

SetLineFeatureClassDrawStyle(aFeatureClass, ...)

SetLineFeatureClassDrawStyle(LineFeatureClass_t16 aFeatureClass, GM_LineStyle_t aLineStyle) -> GM_Error_t32

SetLineFeatureDrawStyle(aLayer, aLineIndex, ...)

SetLineFeatureDrawStyle(GM_LayerHandle_t32 aLayer, uint32 aLineIndex, GM_LineStyle_t aLineStyle) -> GM_Error_t32

SetPointFeatureClassDrawStyle(aFeatureClass, ...)

SetPointFeatureClassDrawStyle(PointFeatureClass_t16 aFeatureClass, GM_PointStyle_t aPointStyle) -> GM_Error_t32

SetPointFeatureDrawStyle(aLayer, ...)

SetPointFeatureDrawStyle(GM_LayerHandle_t32 aLayer, uint32 aPointIndex, GM_PointStyle_t aPointStyle) -> GM_Error_t32

SetLayerCodePage(aLayer, aCodePage)

SetLayerCodePage(GM_LayerHandle_t32 aLayer, sint32 aCodePage) -> GM_Error_t32

Vector Feature Filtering Functions

GetFeatureClassInfo(aFeatureClass, ...)

GetFeatureClassInfo(FeatureClass_t16 aFeatureClass, GM_FeatureClassType_t8 aFeatureClassType) -> GM_Error_t32, GM_FeatureClassInfo_t

SetFeatureClassEnabled(aFeatureClass, ...)

SetFeatureClassEnabled(FeatureClass_t16 aFeatureClass, GM_FeatureClassType_t8 aFeatureClassType, boolean aEnable) -> GM_Error_t32

3D View Functions

CloseViewWindow3D()

CloseViewWindow3D() -> GM_Error_t32

GetCameraPosition3D()

GetCameraPosition3D() -> GM_Error_t32, float, float, float, float, float, float

IsWindowOpen3D()

IsWindowOpen3D() -> boolean

PositionCamera3D(aX, aY, aElev, aHeading, ...)

PositionCamera3D(float aX, float aY, float aElev, float aHeading, float aPitch, float aBank) -> GM_Error_t32

SaveViewToFile3D(aFilename, aFormat, ...)

SaveViewToFile3D(str aFilename, GM_RasterExportFormat_t32 aFormat, sint32 aPixWidth, sint32 aPixHeight) -> GM_Error_t32

SetChangeViewCallback3D(aCallbackFunc, aUserData)

SetChangeViewCallback3D(GM_3DChangeViewCallbackFunc aCallbackFunc, int aUserData) -> None

SetView3D(aLayerList, aDrawFlags, ...)

SetView3D([GM_LayerHandle_t32] aLayerList, GM_DrawFlags_t32 aDrawFlags, GM_Rectangle_t aWorldBounds, GM_PixelRect_t aPixelRect, uint32 aReserved=0) -> GM_Error_t32

Surface Analysis Functions

CalcAreaElevStats(*args)

CalcAreaElevStats([GM_LayerHandle_t32] aLayerList, GM_Point_t aPointList, float aXSpacing, float aYSpacing, uint32 aReserved=0) -> GM_Error_t32, GM_AreaElevStats_t

CalcViewShed(aLayer, aViewShedParms)

CalcViewShed(GM_LayerHandle_t32 aLayer, GM_ViewShedParams_t aViewShedParms) -> GM_Error_t32, GM_LayerHandle_t32

CalcVolumeAlongLine(aLayer, aVolumeParms)

CalcVolumeAlongLine(GM_LayerHandle_t32 aLayer, GM_LineVolumeParams_t aVolumeParms) -> GM_Error_t32, float, float

CalcVolumeOfArea(aLayer, aVolumeParms)

CalcVolumeOfArea(GM_LayerHandle_t32 aLayer, GM_AreaVolumeParams_t aVolumeParms) -> GM_Error_t32, float, float

CombineTerrainLayers(*args)

CombineTerrainLayers(GM_GridCombineSetup_t aSetup, uint32 aReserved=0) -> GM_Error_t32, GM_LayerHandle_t32

GenerateAreasFromEqualValues(aLayer, aSetup)

GenerateAreasFromEqualValues(GM_LayerHandle_t32 aLayer, GM_EqualValueAreaSetup_t aSetup) -> GM_Error_t32, GM_LayerHandle_t32

GenerateContours(aLayer, aContourParms)

GenerateContours(GM_LayerHandle_t32 aLayer, GM_ContourParams_t aContourParms) -> GM_Error_t32, GM_LayerHandle_t32

GenerateContoursEx(aLayerList, aContourParms)

GenerateContoursEx([GM_LayerHandle_t32] aLayerList, GM_ContourParams_t aContourParms) -> GM_Error_t32, GM_LayerHandle_t32

GenerateDensityGrid(aPointLayer, aGridParms)

GenerateDensityGrid(GM_LayerHandle_t32 aPointLayer, GM_DensityGridParams_t aGridParms) -> GM_Error_t32, GM_LayerHandle_t32

GenerateElevationGrid(aLayerList, aGridSetup)

GenerateElevationGrid([GM_LayerHandle_t32] aLayerList, GM_GridGenSetup_t aGridSetup) -> GM_Error_t32, GM_LayerHandle_t32, GM_LayerHandle_t32

GenerateElevationGrid2(aLayerList, aGridSetup)

GenerateElevationGrid2([GM_LayerHandle_t32] aLayerList, GM_GridGenSetup_t aGridSetup) -> GM_Error_t32, GM_LayerHandle_t32

GenerateRoughnessGrid(*args)

GenerateRoughnessGrid(GM_LayerHandle_t32 aLandCoverLayer, GM_RoughnessGridParams_t aGridParms, uint32 aReserved=0) -> GM_Error_t32, GM_LayerHandle_t32

GenerateWatershed(*args)

GenerateWatershed([GM_LayerHandle_t32] aLayerList, GM_WatershedParams_t aWatershedParms, uint32 aReserved=0) -> GM_Error_t32, GM_LayerHandle_t32, GM_LayerHandle_t32

GetPathProfile(aLayer, aStartX, aStartY, ...)

GetPathProfile(GM_LayerHandle_t32 aLayer, float aStartX, float aStartY, float aEndX, float aEndY, float_array aElevList, int aListSize, float aDfltElev) -> GM_Error_t32

GetPathProfileLOS(aLayer, aParams)

GetPathProfileLOS(GM_LayerHandle_t32 aLayer, GM_PathProfileLOSParams_t aParams) -> GM_Error_t32

GetPathProfileLOSEx(aLayerList, aParams)

GetPathProfileLOSEx([GM_LayerHandle_t32] aLayerList, GM_PathProfileLOSParams_t aParams) -> GM_Error_t32

Map Catalog Functions

MapCatalogAddFile(aCatalogLayer, aFilename)

MapCatalogAddFile(GM_LayerHandle_t32 aCatalogLayer, str aFilename) -> GM_Error_t32

MapCatalogAddLayer(aCatalogLayer, aMapLayer)

MapCatalogAddLayer(GM_LayerHandle_t32 aCatalogLayer, GM_LayerHandle_t32 aMapLayer) -> GM_Error_t32

MapCatalogChangeMapOrder(*args)

MapCatalogChangeMapOrder(GM_LayerHandle_t32 aCatalogLayer, uint32 aCurMapIndex, uint32 aNewMapIndex, sint32 aNumMapsToMove, uint32 aReserved=0) -> GM_Error_t32

MapCatalogCreate(aDescription, aProj)

MapCatalogCreate(str aDescription, GM_Projection_t aProj) -> GM_LayerHandle_t32

MapCatalogDisableMap(aCatalogLayer, ...)

MapCatalogDisableMap(GM_LayerHandle_t32 aCatalogLayer, uint32 aMapIndex, boolean aDisable) -> GM_Error_t32

MapCatalogGetInfo(aCatalogLayer)

MapCatalogGetInfo(GM_LayerHandle_t32 aCatalogLayer) -> GM_Error_t32, GM_MapCatalogInfo_t

MapCatalogGetMapInfo(aCatalogLayer, aMapIndex)

MapCatalogGetMapInfo(GM_LayerHandle_t32 aCatalogLayer, uint32 aMapIndex) -> GM_LayerInfo_t

MapCatalogRemoveMap(aCatalogLayer, aMapIndex)

MapCatalogRemoveMap(GM_LayerHandle_t32 aCatalogLayer, uint32 aMapIndex) -> GM_Error_t32

MapCatalogSave(aCatalogLayer, aFilename)

MapCatalogSave(GM_LayerHandle_t32 aCatalogLayer, str aFilename) -> GM_Error_t32

MapCatalogSetDisplayInfo(aCatalogLayer, ...)

MapCatalogSetDisplayInfo(GM_LayerHandle_t32 aCatalogLayer, GM_MapCatalogDisplayType_t8 aDisplayType, float aDisplayValue, float aDisplayValue2, boolean aHideBounds) -> GM_Error_t32

MapCatalogSetMapOption(aCatalogLayer, ...)

MapCatalogSetMapOption(GM_LayerHandle_t32 aCatalogLayer, uint32 aMapIndex, GM_MapCatalogMapOpt_t8 aMapOpt, int aOptData) -> GM_Error_t32

Custom Layer and Feature Creation Functions

AddAreaToVectorLayer(aLayer, aArea, aFlags)

AddAreaToVectorLayer(GM_LayerHandle_t32 aLayer, GM_AreaFeature_t aArea, GM_AddFeatureFlags_t8 aFlags) -> GM_Error_t32

AddLineToVectorLayer(aLayer, aLine, aFlags)

AddLineToVectorLayer(GM_LayerHandle_t32 aLayer, GM_LineFeature_t aLine, GM_AddFeatureFlags_t8 aFlags) -> GM_Error_t32

AddPointToVectorLayer(aLayer, aPoint, aFlags)

AddPointToVectorLayer(GM_LayerHandle_t32 aLayer, GM_PointFeature_t aPoint, GM_AddFeatureFlags_t8 aFlags) -> GM_Error_t32

CombineAreas(aAreaList, aNumAreas, ...)

CombineAreas(GM_AreaFeature_t aAreaList, uint32 aNumAreas, GM_Projection_t aAreaProj, GM_LayerHandle_t32 aNewAreaLayer) -> GM_Error_t32

CreateBufferArea(aFeatureLayer, ...)

CreateBufferArea(GM_LayerHandle_t32 aFeatureLayer, GM_FeatureClassType_t8 aFeatureClassType, uint32 aFeatureIndex, float aBufferDistance, GM_LayerHandle_t32 aBufferLayer) -> GM_Error_t32

CreateCustomElevGridLayer(aDescription, ...)

CreateCustomElevGridLayer(str aDescription, GM_Projection_t aProj, GM_Point_t aTopLeft, float aXSampleSize, float aYSampleSize, sint32 aNumSamplesX, sint32 aNumSamplesY, int aElevGrid, GM_GridValType_t8 aGridValType, float aNoDataValue) -> GM_LayerHandle_t32

CreateCustomElevGridLayerEx(*args)

CreateCustomElevGridLayerEx(str aDescription, GM_Projection_t aProj, GM_GridLayout_t aGridLayout, int aElevGrid, uint32 aReserved=0) -> GM_LayerHandle_t32

CreateCustomRasterLayer(aDescription, aProj, ...)

CreateCustomRasterLayer(str aDescription, GM_Projection_t aProj, GM_RasterLayout_t aRasterLayout, int aDataBuf) -> GM_LayerHandle_t32

CreateCustomVectorLayer(aDescription, aProj)

CreateCustomVectorLayer(str aDescription, GM_Projection_t aProj) -> GM_LayerHandle_t32

CreateVectorLayerFromFindResults(...)

CreateVectorLayerFromFindResults(str aDescription, GM_Projection_t aProj, GM_FoundFeatureResults_t aResultList) -> GM_LayerHandle_t32

Spatial Operations

DistanceInit()

DistanceInit() -> GM_Distance_t

RunSpatialScript(aStr)

RunSpatialScript(str aScriptString) -> GM_Error_t32

SpatialBuffer(aLayer, aParams, aDistance, ...)

SpatialBuffer(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_Distance_t aDistance, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialCenter(aLayer, aParams, aGrouping, aStr)

SpatialCenter(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialCentroid(aLayer, aParams, aGrouping, aStr)

SpatialCentroid(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialCircle(aLayer, aParams, aDistance, ...)

SpatialCircle(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_Distance_t aDistance, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialConcaveHull(aLayer, aParams, ...)

SpatialConcaveHull(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, double aSmoothing, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialContains(aLayer1, aLayer2, aParams)

SpatialContains(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialConvexHull(aLayer, aParams, ...)

SpatialConvexHull(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialDifference(aLayer1, aLayer2, aParams)

SpatialDifference(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialDisjoint(aLayer1, aLayer2, aParams)

SpatialDisjoint(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialDissolve(aLayer, aParams, aGrouping, aStr)

SpatialDissolve(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialEquals(aLayer1, aLayer2, aParams)

SpatialEquals(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialIntersection(aLayer1, aLayer2, aParams)

SpatialIntersection(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialIntersects(aLayer1, aLayer2, aParams)

SpatialIntersects(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialMBR(aLayer, aParams, aGrouping, aStr)

SpatialMBR(GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialOperation(aOperation, aLayer1, ...)

SpatialOperation(GM_SpatialOperations_t8 aOperation, GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialOpsParameterInit()

SpatialOpsParameterInit() -> GM_SpatialOps_Params_t

SpatialOverlaps(aLayer1, aLayer2, aParams)

SpatialOverlaps(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialPredicate(aPredicate, aLayer1, ...)

SpatialPredicate(GM_SpatialPredicates_t16 aPredicate, GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialRelate(aLayer1, aLayer2, aParams, aStr)

SpatialRelate(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams, str aStr) -> GM_Error_t32

SpatialSymmetricDifference(aLayer1, aLayer2, ...)

SpatialSymmetricDifference(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialTouches(aLayer1, aLayer2, aParams)

SpatialTouches(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialTransform(aTransform, aLayer, ...)

SpatialTransform(GM_SpatialTransforms_t16 aTransform, GM_LayerHandle_t32 aLayer, GM_SpatialOps_Params_t aParams, GM_FeatureGrouping_t8 aGrouping, str aStr) -> GM_Error_t32

SpatialUnion(aLayer1, aLayer2, aParams)

SpatialUnion(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialUnionSingle(aLayer1, aParams)

SpatialUnionSingle(GM_LayerHandle_t32 aLayer1, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

SpatialWithin(aLayer1, aLayer2, aParams)

SpatialWithin(GM_LayerHandle_t32 aLayer1, GM_LayerHandle_t32 aLayer2, GM_SpatialOps_Params_t aParams) -> GM_Error_t32

Utility Functions

carray_to_list(arr, size)

carray_to_list(uint32 arr, uint32 size) -> list

CreateS63UserPermitFile(aFilename)

CreateS63UserPermitFile(str aFilename) -> GM_Error_t32

free_void(ptr)

free_void(int pointer) -> None

GetFilterString()

GetFilterString() -> str

GetMACAddress()

GetMACAddress() -> str

GetMiscOption(*args)

GetMiscOption(GM_MiscOpt_t32 aOpt, uint32 aReserved=0) -> int

GetProgressCallback()

GetProgressCallback() -> GM_ProgressCallbackFunc

GetSDKBuildDate()

GetSDKBuildDate() -> int

GetSDKVersion()

GetSDKVersion() -> int

gmobject_to_map(self)

gmobject_to_map(void gmobject) -> map

IsRegistered()

IsRegistered() -> boolean

LogMessage(level, message)

LogMessage(GM_LogLevel_t8 level, str message) -> None

malloc_void(nbytes)

malloc_void(uint32 nbytes) -> int

print_module_info()

print_module_info() -> void

SetMemoryLimit(aMemoryLimit)

SetMemoryLimit(uint32 aMemoryLimit) -> None

SetMessageCallback(aCallbackFunc)

SetMessageCallback(GM_MessageCallbackFunc aCallbackFunc) -> None

SetMessageCallbackEx(*args)

SetMessageCallbackEx(GM_MessageCallbackFunc aCallbackFunc, boolean aThreadLocal, uint32 aReserved=0) -> None

SetMiscOption(aOpt, aNewValue)

SetMiscOption(GM_MiscOpt_t32 aOpt, uint8 aNewValue) -> int

SetMiscOptionEx(*args)

SetMiscOptionEx(GM_MiscOpt_t32 aOpt, int aNewValue, uint32 aReserved=0) -> int

SetMiscOptionExString(*args)

SetMiscOptionExString(GM_MiscOpt_t32 aOpt, str aNewValue, uint32 aReserved=0) -> str

SetMiscOptionExBool(*args)

SetMiscOptionExBool(GM_MiscOpt_t32 aOpt, boolean aNewValue, uint32 aReserved=0) -> boolean

SetProgressCallback(aCallbackFunc)

SetProgressCallback(GM_ProgressCallbackFunc aCallbackFunc) -> None

SetProgressCallbackThread(aCallbackFunc)

SetProgressCallbackThread(GM_ProgressCallbackFunc aCallbackFunc) -> None

SetQuickPDFUnlockCode(aUnlockCode)

SetQuickPDFUnlockCode(str aUnlockCode) -> GM_Error_t32

SetRegistryKey(aKeyName)

SetRegistryKey(str aKeyName) -> GM_Error_t32

SetSettingsFilePath(aPathName)

SetSettingsFilePath(str aPathName) -> GM_Error_t32

ShowGlobalMapperHelp(aURL)

ShowGlobalMapperHelp(str aURL) -> GM_Error_t32

strerror(code)

strerror(uint32 code) -> str