core/com.getwemap.sdk.core.navigation/NavigationOptions

NavigationOptions

data class NavigationOptions(val stopWhenArrivedAtDestination: Boolean = true, val arrivedDistanceThreshold: Float = 15.0f, 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(stopWhenArrivedAtDestination: Boolean = true, arrivedDistanceThreshold: Float = 15.0f, userPositionThreshold: Float = 25.0f, @IntRange(from = 5, to = 9223372036854775807) navigationRecalculationTimeInterval: Long = 5)

Properties

arrivedDistanceThreshold

val arrivedDistanceThreshold: Float = 15.0f

The distance measured in meters, indicating when the navigation manager considers that the user has arrived at the final destination.

navigationRecalculationTimeInterval

val navigationRecalculationTimeInterval: Long = 5

The navigation recalculation time interval, measured in seconds, indicates the interval between consecutive navigation recalculations.

stopWhenArrivedAtDestination

val stopWhenArrivedAtDestination: Boolean = true

The boolean indicating whether the navigation manager should stop navigation when user has arrived close to the final destination.

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.