com.tomtom.sdk.maps:map-display/com.tomtom.sdk.map.display.map/MapController

MapController

Controls general map properties. It also provides two helper methods that can convert between a Point on the screen and its GeoPoint counterpart.

Inheritors

TomTomMap

Functions

coordinateForPoint

abstract fun coordinateForPoint(point: Point): Result<GeoPoint, PointConversionFailure>

Converts a Point on the MapView to a position on the map. Returns a Result with a GeoPoint or PointConversionFailure when it cannot obtain a coordinate from the given point. This Result can occur when the point is not on the map.

getVisibleRegion

abstract fun getVisibleRegion(): Result<VisibleRegion, RegionCalculationFailure>

Provides the currently visible region as VisibleRegion.

pointForCoordinate

abstract fun pointForCoordinate(coordinate: GeoPoint): Point

Converts a position on the map into the MapView point.

setFrameRate

abstract fun setFrameRate(@IntRange(from = 1) frameRate: Int)

Applies a frame rate cap on the map renderer. It is useful for scenarios where the map is not fully visible to the user, and there is no need to render it with its full performance.

setLanguage

abstract fun setLanguage(language: Locale)

Sets map language. If the requested locale is unsupported, the map falls back to the NGT (Neutral Ground Truth); this means official languages for all regions in local scripts (if available).

setPadding

abstract fun setPadding(padding: Padding)

Sets padding on the map. For the map, the padding means a safe area of the MapView that does not receive any input from the user. The safe area is useful for some sections of the user interface to display UI components, i.e., buttons, sliders, etc.