LocationController

Controls location-specific features and properties of the map related to the location provided by the LocationProvider abstraction.

Inheritors

Properties

Link copied to clipboard

Describes the latest available (last known) GeoLocation of the device. The value may be null when the LocationProvider has never updated the current location. For example, it may be be caused by invalid GPS Fix being deliver to the device.

Link copied to clipboard

Flag determining whether the current location marker is located within the visible area of the screen.

Link copied to clipboard

Determines if the location is accurate enough for the user to rely on. The default is for locations with an accuracy of more then 50 meters to be treated as unreliable.

Functions

Link copied to clipboard

Registers LocationMarkerClickListener that will be notified about the click (aka tap) gesture recognized on the location marker. Both, the clicked position on the screen and the underlying location on the map, become parameters of the LocationMarkerClickListener.onLocationMarkerClick callback.

Link copied to clipboard
abstract fun disableLocationMarker()

Disables the location marker so it becomes inactive and invisible.

Link copied to clipboard

Enables the location marker based on the supplied LocationMarkerOptions, replacing any existing location marker already visible. The location marker visualizes the users location on the map and can be of three types: CHEVRON: A vehicle position indicator primarily for use in turn-by-turn guidance. POINTER: A user location pointer, primarily for use in browsing or pedestrian modes. CUSTOM: A customizable model supplied by the developer.

Link copied to clipboard

Gets the currently set LocationProvider or returns null if none is set.

Link copied to clipboard
abstract fun setLocationProvider(engine: LocationProvider?)

Sets new LocationProvider. Location marker position is then set based on updates that are received from that engine.