Type Definitions Reference


                    
                    
                    GLMapAnimationCompletionBlock

GLMapAnimationCompletionBlock is called when the animation ends. finished is set to YES when the animation is finished, and NO when the animation is canceled.

Declaration

Objective-C

typedef void (^GLMapAnimationCompletionBlock)(BOOL)

Swift

typealias GLMapAnimationCompletionBlock = (Bool) -> Void


                    
                    
                    GLMapMarkerDataFillBlock

GLMapMarkerDataFillBlock is called for each marker to fill the needed data.

See

GLMapMarkerSetStyle

See

GLMapMarkerSetText

Declaration

Objective-C

typedef void (^GLMapMarkerDataFillBlock)(id _Nonnull, GLMapMarkerData _Nonnull)

Swift

typealias GLMapMarkerDataFillBlock = (Any, GLMapMarkerData) -> Void


                    
                    
                    GLMapMarkerLocationBlock

GLMapMarkerPositionBlock is called for each marker to get the location of the marker.

Declaration

Objective-C

typedef GLMapPoint (^GLMapMarkerLocationBlock)(id _Nonnull)

Swift

typealias GLMapMarkerLocationBlock = (Any) -> GLMapPoint


                    
                    
                    GLMapMarkerUnionFillBlock

GLMapMarkerUnionBlock is called when the marker layer needs a style for a union of count markers.

Declaration

Objective-C

typedef void (^GLMapMarkerUnionFillBlock)(uint32_t, GLMapMarkerData _Nonnull)

Swift

typealias GLMapMarkerUnionFillBlock = (UInt32, GLMapMarkerData) -> Void


                    
                    
                    GLMapScaleRulerTextFormatterBlock

GLMapScaleRulerTextFormatterBlock is used to change the scale ruler format or localize the unit name.

Declaration

Objective-C

typedef NSString *_Nullable (^GLMapScaleRulerTextFormatterBlock)(int, GLUnits)

Swift

typealias GLMapScaleRulerTextFormatterBlock = (Int32, GLUnits) -> String?


                    
                    
                    GLMapTrackDataCallback

A block is called to get track data for a given bbox.

Declaration

Objective-C

typedef NSArray<GLMapTrackData *> *_Nullable (^GLMapTrackDataCallback)(
    GLMapBBox)

Swift

typealias GLMapTrackDataCallback = (GLMapBBox) -> [GLMapTrackData]?

Parameters


                                bbox

The BBox of the tracks.

Return Value

An array of GLMapTrackData.


                    
                    
                    GLMapTimestampBlock

GLMapTimestampBlock is used to get the timestamp of a resource from a custom place. Return NAN if no resources with such name exist.

Declaration

Objective-C

typedef double (^GLMapTimestampBlock)(NSString *_Nonnull)

Swift

typealias GLMapTimestampBlock = (String) -> Double


                    
                    
                    ColorTransformBlock

ColorTransformBlock is used to transform colors of an image.

Declaration

Objective-C

typedef GLMapColor (^ColorTransformBlock)(GLMapColor)

Swift

typealias ColorTransformBlock = (GLMapColor) -> GLMapColor


                    
                    
                    RectTransformBlock

RectTransformBlock is used to transform the draw rect of an image.

Declaration

Objective-C

typedef CGRect (^RectTransformBlock)(CGRect)

Swift

typealias RectTransformBlock = (CGRect) -> CGRect


                    
                    
                    GLMapTapGestureBlock

GLMapTapGestureBlock is called when the user taps or long presses on the map. Add custom tap handling logic inside this block.

Declaration

Objective-C

typedef void (^GLMapTapGestureBlock)(CGPoint)

Swift

typealias GLMapTapGestureBlock = (CGPoint) -> Void


                    
                    
                    GLMapBBoxChangedBlock

GLMapBBoxChangedBlock is called every time the map is moved or zoomed.

Declaration

Objective-C

typedef void (^GLMapBBoxChangedBlock)(GLMapBBox)

Swift

typealias GLMapBBoxChangedBlock = (GLMapBBox) -> Void


                    
                    
                    GLMapAnimationBlock

GLMapAnimationBlock is created for animations. Map properties modified inside GLMapAnimationBlock will use animation. Animation properties can be changed in the animation object.

Declaration

Objective-C

typedef void (^GLMapAnimationBlock)(GLMapAnimation *_Nonnull)

Swift

typealias GLMapAnimationBlock = (GLMapAnimation) -> Void


                    
                    
                    GLMapVisibleTilesChangedBlock

GLMapVisibleTilesChangedBlock is called when the set of visible tiles changes.

Declaration

Objective-C

typedef void (^GLMapVisibleTilesChangedBlock)(NSSet *_Nonnull)

Swift

typealias GLMapVisibleTilesChangedBlock = (Set<AnyHashable>) -> Void


                    
                    
                    GLMapCaptureFrameBlock

GLMapCaptureFrameBlock is called when a frame is captured.

Declaration

Objective-C

typedef void (^GLMapCaptureFrameBlock)(PlatformImage *_Nullable)

Swift

typealias GLMapCaptureFrameBlock = (NSImage?) -> Void


                    
                    
                    GLMapColor

GLMapColor is color type based on uint32_t

Declaration

Objective-C

typedef struct GLMapColor GLMapColor


                    
                    
                    GLMapResource

Resource information filled by GLMapResourceBlock

Declaration

Objective-C

typedef struct GLMapResource GLMapResource


                    
                    
                    GLMapTilePos

Merkator tile coordinates

Declaration

Objective-C

typedef struct GLMapTilePos GLMapTilePos


                    
                    
                    GLMapResourceBlock

GLMapResourceBlock is used to load resources from custom place.

Declaration

Objective-C

typedef GLMapResource (^GLMapResourceBlock)(NSString *_Nonnull)

Swift

typealias GLMapResourceBlock = (String) -> GLMapResource


                    
                    
                    GLMapRect

Rectangle contains all corner points

Declaration

Objective-C

typedef struct GLMapRect GLMapRect


                    
                    
                    GLTrackPoint

Point of track with color

Declaration

Objective-C

typedef struct GLTrackPoint GLTrackPoint


                    
                    
                    GLRoutePoint

Point of track with color

Declaration

Objective-C

typedef struct GLRoutePoint GLRoutePoint


                    
                    
                    GLMapBBox

Bounding box

Declaration

Objective-C

typedef struct GLMapBBox GLMapBBox


                    
                    
                    GLMapPointSet

Set of GLMapPoint

Declaration

Objective-C

typedef void *GLMapPointSet

Swift

typealias GLMapPointSet = UnsafeMutableRawPointer


                    
                    
                    GLMapBBoxSet

Set of GLMapPoint

Declaration

Objective-C

typedef void *GLMapBBoxSet

Swift

typealias GLMapBBoxSet = UnsafeMutableRawPointer


                    
                    
                    GLTrackSampleResult

Result of track sampling

Declaration

Objective-C

typedef struct GLTrackSampleResult GLTrackSampleResult


                    
                    
                    GLMapGeoPoint

Geo point with latitude and longitude

Declaration

Objective-C

typedef struct GLMapGeoPoint GLMapGeoPoint


                    
                    
                    GLMapDownloadCompletionBlock

Blocks that will be called on the main thread when the task is completed or canceled.

Declaration

Objective-C

typedef void (^GLMapDownloadCompletionBlock)(GLMapDownloadTask *_Nonnull)

Swift

typealias GLMapDownloadCompletionBlock = (GLMapDownloadTask) -> Void


                    
                    
                    GLMapDownloadStatsBlock

Blocks that will be called on the main thread when the subtask is completed or canceled. Download task contains map data download task and navigation data download task inside.

Declaration

Objective-C

typedef void (^GLMapDownloadStatsBlock)(NSString *_Nonnull, NSUInteger, double)

Swift

typealias GLMapDownloadStatsBlock = (String, UInt, Double) -> Void


                    
                    
                    GLMapListUpdateBlock

GLMapListUpdateBlock is used to notify about map list updates. The map list is stored on the server and sometimes it takes some time to fetch the latest map list. It is downloaded only if updated. If no changes occurred, the block is called almost immediately.

Declaration

Objective-C

typedef void (^GLMapListUpdateBlock)(NSArray<GLMapInfo *> *_Nullable, BOOL,
                                     NSError *_Nullable)

Swift

typealias GLMapListUpdateBlock = ([GLMapInfo]?, Bool, (any Error)?) -> Void


                    
                    
                    GLMapTileDownloadProgressBlock

GLMapTileDownloadProgressBlock is called when a tile is downloaded.

Declaration

Objective-C

typedef BOOL (^GLMapTileDownloadProgressBlock)(uint64_t, NSError *_Nullable)

Swift

typealias GLMapTileDownloadProgressBlock = (UInt64, (any Error)?) -> Bool

Return Value

If NO is returned, the downloading will be canceled.


                    
                    
                    GLMapFloatBlock

GLMapFloatBlock is called when an asynchronous request for slope or elevation is finished.

Declaration

Objective-C

typedef void (^GLMapFloatBlock)(float)

Swift

typealias GLMapFloatBlock = (Float) -> Void


                    
                    
                    GLMapDownloadProgress

GLMapDownloadProgress is periodically called to report the progress of the download.

Declaration

Objective-C

typedef void (^GLMapDownloadProgress)(NSUInteger, NSUInteger, double)

Swift

typealias GLMapDownloadProgress = (UInt, UInt, Double) -> Void


                    
                    
                    GLMapDownloadCompletion

GLMapDownloadCompletion is called when the download is finished.

Declaration

Objective-C

typedef void (^GLMapDownloadCompletion)(NSError *_Nullable)

Swift

typealias GLMapDownloadCompletion = ((any Error)?) -> Void


                    
                    
                    GLMapMarkerData

GLMapMarkerData is type used to reference an internal object.

Declaration

Objective-C

typedef void *GLMapMarkerData

Swift

typealias GLMapMarkerData = UnsafeMutableRawPointer


                    
                    
                    GLMapPoint

GLMapPoint always uses internal map coordinates. From 0 to GLMapPointMax for X and Y axis. Origin is at the top left corner.

Declaration

Objective-C

typedef struct GLMapPoint GLMapPoint


                    
                    
                    GetPointBlock

Generator block. Returns points for index. Used in generating constructor -initWithCount:callback:.

Declaration

Objective-C

typedef GLMapPoint (^GetPointBlock)(NSUInteger)

Swift

typealias GetPointBlock = (UInt) -> GLMapPoint

Parameters


                                index

Index of the point.

Return Value

Point to add to the array.


                    
                    
                    EnumeratePointBlock

Enumerator block. Called for all points subsequently.

Declaration

Objective-C

typedef void (^EnumeratePointBlock)(NSUInteger, GLMapPoint)

Swift

typealias EnumeratePointBlock = (UInt, GLMapPoint) -> Void

Parameters

`index`	Point index.
`point`	Point.


                    
                    
                    GLMapTrackPointsCallback

Block is called to get point of track at given index

Declaration

Objective-C

typedef BOOL (^GLMapTrackPointsCallback)(NSUInteger, GLTrackPoint *_Nonnull)

Swift

typealias GLMapTrackPointsCallback = (UInt, UnsafeMutablePointer<GLTrackPoint>) -> Bool

Return Value

YES if there is point at index index, and NO if there is no points.


                    
                    
                    TintFunctionBlock

TintFunctionBlock is used to customize tint function. E.g. It’s possible to add custom mapping for specific colors.

Declaration

Objective-C

typedef GLMapColor (^TintFunctionBlock)(GLMapColor, GLMapColor)

Swift

typealias TintFunctionBlock = (GLMapColor, GLMapColor) -> GLMapColor


                    
                    
                    GLMapVectorObjectBlock

Called when next object is ready while enumerating

Declaration

Objective-C

typedef BOOL (^GLMapVectorObjectBlock)(GLMapVectorObject *_Nonnull)

Swift

typealias GLMapVectorObjectBlock = (GLMapVectorObject) -> Bool

Return Value

NO to break enumaration


                    
                    
                    GLMapFunction

User function that could be declared in code and called from MapCSS

Declaration

Objective-C

typedef GLMapValue *_Nullable (^GLMapFunction)(
    void *_Nullable, const GLMapValue *const _Nullable *_Nullable, int)

Swift

typealias GLMapFunction = (UnsafeMutableRawPointer?, UnsafePointer<GLMapValue?>?, Int32) -> GLMapValue?


                    
                    
                    GLMapTrackDataColorBlock

Block that will be called to make gradients for track

Declaration

Objective-C

typedef GLMapColor (^GLMapTrackDataColorBlock)(uint32_t)

Swift

typealias GLMapTrackDataColorBlock = (UInt32) -> GLMapColor

Parameters


                                index

Index of point

Return Value

Color of the point


                    
                    
                    GLRouteEnumPointsBlock

Enumerator block. Called subsequently for all maneuver points

Declaration

Objective-C

typedef void (^GLRouteEnumPointsBlock)(GLMapPoint, float)

Swift

typealias GLRouteEnumPointsBlock = (GLMapPoint, Float) -> Void

Parameters

`point`	Point inside maneuver
`height`	Height in that point if available, NAN otherwise.


                    
                    
                    GLMapHeightDataCompletionBlock

Block that will be called when the request is finished

Declaration

Objective-C

typedef void (^GLMapHeightDataCompletionBlock)(GLRouteElevation *_Nullable,
                                               NSError *_Nullable)

Swift

typealias GLMapHeightDataCompletionBlock = (GLRouteElevation?, (any Error)?) -> Void

Parameters

`result`	instance of GLRouteElevation with information about height
`error`	contains error if request is failed


                    
                    
                    GLRouteRequestCompletionBlock

Block that will be called when request is finished

Declaration

Objective-C

typedef void (^GLRouteRequestCompletionBlock)(GLRoute *_Nullable,
                                              NSError *_Nullable)

Swift

typealias GLRouteRequestCompletionBlock = (GLRoute?, (any Error)?) -> Void

Parameters

`result`	instance of GLRoute with information about the route
`error`	contains error if request is failed


                    
                    
                    CostingOptionsPenalties

General penalties

Declaration

Objective-C

typedef struct CostingOptionsPenalties CostingOptionsPenalties


                    
                    
                    CostingOptionsRoad

General options when driving on road

Declaration

Objective-C

typedef struct CostingOptionsRoad CostingOptionsRoad


                    
                    
                    CostingOptionsVehicle

Options for vehicle

Declaration

Objective-C

typedef struct CostingOptionsVehicle CostingOptionsVehicle


                    
                    
                    CostingOptionsAuto

Options for auto, bus, taxi mode

Declaration

Objective-C

typedef struct CostingOptionsAuto CostingOptionsAuto


                    
                    
                    CostingOptionsTruck

Options for truck mode

Declaration

Objective-C

typedef struct CostingOptionsTruck CostingOptionsTruck


                    
                    
                    CostingOptionsBicycle

Options for bicycle mode

Declaration

Objective-C

typedef struct CostingOptionsBicycle CostingOptionsBicycle


                    
                    
                    CostingOptionsMotorScooter

Options for straight mode

Declaration

Objective-C

typedef struct CostingOptionsMotorScooter CostingOptionsMotorScooter


                    
                    
                    CostingOptionsMotorcycle

Options for straight mode

Declaration

Objective-C

typedef struct CostingOptionsMotorcycle CostingOptionsMotorcycle


                    
                    
                    CostingOptionsPedestrian

Options for pedestrian mode

Declaration

Objective-C

typedef struct CostingOptionsPedestrian CostingOptionsPedestrian


                    
                    
                    CostingOptionsStraight

Options for straight mode

Declaration

Objective-C

typedef struct CostingOptionsStraight CostingOptionsStraight


                    
                    
                    GLSearchCompletionBlock

GLMapSearchCompletionBlock is called when the search task is finished. If results is nil, the task is canceled.

Warning

If custom results are also added, results will contain GLMapVectorObjects and objects of the user type.

Declaration

Objective-C

typedef void (^GLSearchCompletionBlock)(GLMapVectorObjectArray *_Nonnull)

Swift

typealias GLSearchCompletionBlock = (GLMapVectorObjectArray) -> Void


                    
                    
                    GLSearchInfoBlock

GLMapSearchInfoBlock is called to fetch information that is used to sort custom search results.

Declaration

Objective-C

typedef void (^GLSearchInfoBlock)(id _Nonnull, GLMapPoint *_Nonnull,
                                  GLSearchCategory *_Nullable *_Nonnull,
                                  int *_Nonnull)

Swift

typealias GLSearchInfoBlock = (Any, UnsafeMutablePointer<GLMapPoint>, AutoreleasingUnsafeMutablePointer<GLSearchCategory?>, UnsafeMutablePointer<Int32>) -> Void