sdk-maps / com.tomtom.online.sdk.map / DrivingSettings

DrivingSettings

@Beta(2020, 12) interface DrivingSettings : Persistable

Advanced settings for driving options manipulation. To obtain this interface, call TomtomMap#getDrivingSettings().

Functions

addChevron

abstract fun addChevron(builder: ChevronBuilder!): Chevron!

Add custom chevron to the map. Currently, it is possible to add only one custom chevron. Exception is thrown when the user tries to add second chevron.

centerChevronScreenPosition

abstract fun centerChevronScreenPosition(): Unit

Set chevron screen position to the center of map view.

disableMapBearingSmoothing

abstract fun disableMapBearingSmoothing(): Unit

Disable low-pass filtering with camera bearing.

enableMapBearingSmoothing

abstract fun enableMapBearingSmoothing(smoothFactor: Long): Unit

Enable low-pass filtering so that camera can follow the chevron in more smoother way.

getChevrons

abstract fun getChevrons(): MutableList<Chevron!>!

Get list of currently added chevrons.

isTracking

abstract fun isTracking(): Boolean

True when any chevron is currently tracked, false otherwise.

removeChevron

abstract fun removeChevron(chevron: Chevron!): Unit

Remove selected chevron from the map.

removeChevrons

abstract fun removeChevrons(): Unit

Remove all chevrons from the map.

setChevronScreenPosition

abstract fun setChevronScreenPosition(position: ChevronScreenPosition!): Unit

Set the chevron screen position. {@see ChevronScreenPosition} to understand how the chevron can be positioned within the boundaries of the map view.

startTracking

abstract fun startTracking(chevron: Chevron!): Unit

Start tracking the specific chevron. In the tracking mode, rotate and pan gestures are blocked. The user can change only zoom level, map camera is automatically adjusted to follow the chevron.

stopTracking

abstract fun stopTracking(): Unit

Stop tracking the chevron, all gestures are enabled again.

Inherited Functions

onViewStateRestored

abstract fun onViewStateRestored(savedState: MapState!): Unit

Called internally to restore state, e.g., when the app is resumed from the background.

onViewStateSave

abstract fun onViewStateSave(outState: MapState!): Unit

Called internally to save state, e.g., when the app is going to the background.