PMMapAction

Enumeration of map actions

Entries

Link copied to clipboard

Use case: Create new map view and display it
Precondition: NONE
Postcondition: Map is displayed on given surface with given dimensions
Arguments:
surface: platform dependent surface used for map rendering
mapSurfaceConfig: surface dimensions and dpi
Return value: mapId - identifier of created mapview used to call actions on this instance of map

Link copied to clipboard

Use case: Resize existing map
Precondition: Map with given id exists
Postcondition: Map is resized acording to provided mapSurfaceConfig
Arguments:
mapId: id of map (returned by action CreateMapView) to resize
mapSurfaceConfig: surface dimensions and dpi
Return value: nothing

Link copied to clipboard

Use case: Stop displaying existing map
Precondition: Map with given id exists
Postcondition: Map stops rendering and associated resources are released
Arguments:
mapId: id of map (returned by action CreateMapView) to destroy
Return value: nothing

Link copied to clipboard

Use case: Display markers on map
Precondition: Map with given id exists
Postcondition: Map marker is displayed on given coordinates
Arguments:
mapId: id of map (returned by action CreateMapView)
PFMapDataRequestParams.markerBitmaps: bitmap objects used as map marker icons
PFMapDataRequestParams.markerDefinitions: definition of marker behaviour
Return value: nothing

Link copied to clipboard

Use case: Remove displayed markers from map
Precondition: Map with given id exists, markers with given ids exist
Postcondition: Markers are not displated on map
Arguments:
mapId: id of map (returned by action CreateMapView)
PFMapDataRequestParams.removeMarkerIds: ids of markers to remove (if empty, all markers are removed)
Return value: nothing

Link copied to clipboard

Use case: Set camera
Precondition: Map with given id exists
Postcondition: The map camera is set with provided parameters
Arguments:
mapId: id of map (returned by action CreateMapView)
PFMapCameraParams: params to set
Return value: nothing

Types

Link copied to clipboard
object Companion

Functions

Link copied to clipboard

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Link copied to clipboard

Returns an array containing the constants of this enum type, in the order they're declared.

Properties

Link copied to clipboard
val fbid: Byte
Link copied to clipboard
Link copied to clipboard