map/com.getwemap.sdk.map.navigation/NavigationOptions

NavigationOptions

data class NavigationOptions(val itineraryOptions: ItineraryOptions = ItineraryOptions(), val cameraMode: Int? = null, val zoomWhileTracking: Double? = null, val renderMode: Int? = null, val stopOptions: NavigationOptions.StopOptions = StopOptions(), val userPositionThreshold: Float = 25.0f, @IntRange(from = 5, to = 9223372036854775807) val navigationRecalculationTimeInterval: Long = 5)

A data class containing information about the navigation options

Constructors

NavigationOptions

constructor(itineraryOptions: ItineraryOptions = ItineraryOptions(), cameraMode: Int? = null, zoomWhileTracking: Double? = null, renderMode: Int? = null, stopOptions: NavigationOptions.StopOptions = StopOptions(), userPositionThreshold: Float = 25.0f, @IntRange(from = 5, to = 9223372036854775807) navigationRecalculationTimeInterval: Long = 5)

Types

StopOptions

data class StopOptions(val stopWhenArrivedAtDestination: Boolean = true, val stopDistanceThreshold: Float = 15.0f)

A struct containing information about the navigation stop options.

Properties

cameraMode

val cameraMode: Int? = null

The camera mode used to track the rendered location on the map. Default is null, which means that after the navigation is started, the camera mode remains unchanged

itineraryOptions

val itineraryOptions: ItineraryOptions

The data class containing information about itinerary options.

navigationRecalculationTimeInterval

val navigationRecalculationTimeInterval: Long = 5

The navigation recalculation time interval, measured in seconds, indicates the interval between consecutive navigation recalculations. An interval of less than 5 seconds is forbidden. Default is 5 seconds

renderMode

val renderMode: Int? = null

The render mode being used to show the location and/or compass updates on the map when navigation is started. Default is null, which means that after the navigation is started, the render mode remains unchanged

stopOptions

val stopOptions: NavigationOptions.StopOptions

The data class containing information about the navigation stop options.

userPositionThreshold

val userPositionThreshold: Float = 25.0f

The distance measured in meters indicates when the user's location will no longer be projected onto the itinerary and navigation will be recalculated. Default is 25 meters

zoomWhileTracking

val zoomWhileTracking: Double? = null

The zoom level applied when navigation is started. Default is null, which means that after the navigation is started, the zoom remains unchanged