maplibre-navigation-core/org.maplibre.navigation.core.navigation/MapLibreNavigationOptions

MapLibreNavigationOptions

data class MapLibreNavigationOptions(val maxTurnCompletionOffset: Double = Defaults.MAX_TURN_COMPLETION_OFFSET, val maneuverZoneRadius: Double = Defaults.MANEUVER_ZONE_RADIUS, val deadReckoningTimeInterval: Double = Defaults.DEAD_RECKONING_TIME_INTERVAL, val maxManipulatedCourseAngle: Double = Defaults.MAX_MANIPULATED_COURSE_ANGLE, val userLocationSnapDistance: Double = Defaults.USER_LOCATION_SNAPPING_DISTANCE, val secondsBeforeReroute: Int = Defaults.SECONDS_BEFORE_REROUTE, val defaultMilestonesEnabled: Boolean = Defaults.DEFAULT_MILESTONES_ENABLED, val snapToRoute: Boolean = Defaults.SNAP_TO_ROUTE, val enableOffRouteDetection: Boolean = Defaults.ENABLE_OFF_ROUTE_DETECTION, val enableFasterRouteDetection: Boolean = Defaults.ENABLE_FASTER_ROUTE_DETECTION, val manuallyEndNavigationUponCompletion: Boolean = Defaults.MANUALLY_END_NAVIGATION_UPON_COMPLETION, val metersRemainingTillArrival: Double = Defaults.METERS_REMAINING_TILL_ARRIVAL, val offRouteMinimumDistanceMetersAfterReroute: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_AFTER_REROUTE, val offRouteThresholdRadiusMeters: Double = Defaults.OFF_ROUTE_THRESHOLD_RADIUS_METERS, val offRouteMinimumDistanceMetersBeforeWrongDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_WRONG_DIRECTION, val offRouteMinimumDistanceMetersBeforeRightDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_RIGHT_DIRECTION, val isDebugLoggingEnabled: Boolean = Defaults.IS_DEBUG_LOGGING_ENABLED, val roundingIncrement: MapLibreNavigationOptions.RoundingIncrement = Defaults.roundingIncrement, val timeFormatType: MapLibreNavigationOptions.TimeFormat = TimeFormat.NONE_SPECIFIED, val locationAcceptableAccuracyInMetersThreshold: Int = Defaults.LOCATION_ACCEPTABLE_ACCURACY_IN_METERS_THRESHOLD, val fasterRouteCheckIntervalSeconds: Int = Defaults.FASTER_ROUTE_CHECK_INTERVAL_SECONDS)

Immutable and can't be changed after passing into MapLibreNavigation.

Constructors

constructor(maxTurnCompletionOffset: Double = Defaults.MAX_TURN_COMPLETION_OFFSET, maneuverZoneRadius: Double = Defaults.MANEUVER_ZONE_RADIUS, deadReckoningTimeInterval: Double = Defaults.DEAD_RECKONING_TIME_INTERVAL, maxManipulatedCourseAngle: Double = Defaults.MAX_MANIPULATED_COURSE_ANGLE, userLocationSnapDistance: Double = Defaults.USER_LOCATION_SNAPPING_DISTANCE, secondsBeforeReroute: Int = Defaults.SECONDS_BEFORE_REROUTE, defaultMilestonesEnabled: Boolean = Defaults.DEFAULT_MILESTONES_ENABLED, snapToRoute: Boolean = Defaults.SNAP_TO_ROUTE, enableOffRouteDetection: Boolean = Defaults.ENABLE_OFF_ROUTE_DETECTION, enableFasterRouteDetection: Boolean = Defaults.ENABLE_FASTER_ROUTE_DETECTION, manuallyEndNavigationUponCompletion: Boolean = Defaults.MANUALLY_END_NAVIGATION_UPON_COMPLETION, metersRemainingTillArrival: Double = Defaults.METERS_REMAINING_TILL_ARRIVAL, offRouteMinimumDistanceMetersAfterReroute: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_AFTER_REROUTE, offRouteThresholdRadiusMeters: Double = Defaults.OFF_ROUTE_THRESHOLD_RADIUS_METERS, offRouteMinimumDistanceMetersBeforeWrongDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_WRONG_DIRECTION, offRouteMinimumDistanceMetersBeforeRightDirection: Double = Defaults.OFF_ROUTE_MINIMUM_DISTANCE_METERS_BEFORE_RIGHT_DIRECTION, isDebugLoggingEnabled: Boolean = Defaults.IS_DEBUG_LOGGING_ENABLED, roundingIncrement: MapLibreNavigationOptions.RoundingIncrement = Defaults.roundingIncrement, timeFormatType: MapLibreNavigationOptions.TimeFormat = TimeFormat.NONE_SPECIFIED, locationAcceptableAccuracyInMetersThreshold: Int = Defaults.LOCATION_ACCEPTABLE_ACCURACY_IN_METERS_THRESHOLD, fasterRouteCheckIntervalSeconds: Int = Defaults.FASTER_ROUTE_CHECK_INTERVAL_SECONDS)

Types

Builder

class Builder

Defaults

object Defaults

RoundingIncrement

enum RoundingIncrement : Enum<MapLibreNavigationOptions.RoundingIncrement>

TimeFormat

enum TimeFormat : Enum<MapLibreNavigationOptions.TimeFormat>

Properties

deadReckoningTimeInterval

val deadReckoningTimeInterval: Double

When calculating whether or not the user is on the route, we look where the user will be given their speed and this variable.

defaultMilestonesEnabled

val defaultMilestonesEnabled: Boolean

If enabled, the default milestones VoiceInstructionMilestone and BannerInstructionMilestone are added and used by default.

enableFasterRouteDetection

val enableFasterRouteDetection: Boolean

enableOffRouteDetection

val enableOffRouteDetection: Boolean

fasterRouteCheckIntervalSeconds

val fasterRouteCheckIntervalSeconds: Int

In seconds, how quickly FasterRouteDetector will tell RouteProcessorBackgroundThread to check for a faster org.maplibre.navigation.core.models.DirectionsRoute.

isDebugLoggingEnabled

val isDebugLoggingEnabled: Boolean

If true, the SDK will print debug logs.

locationAcceptableAccuracyInMetersThreshold

val locationAcceptableAccuracyInMetersThreshold: Int

Default location acceptable accuracy threshold used in {@link LocationValidator}.

maneuverZoneRadius

val maneuverZoneRadius: Double

Radius in meters the user must enter to count as completing a step. One of two heuristics used to know when a user completes a step, see .maxTurnCompletionOffset.

manuallyEndNavigationUponCompletion

val manuallyEndNavigationUponCompletion: Boolean

maxManipulatedCourseAngle

val maxManipulatedCourseAngle: Double

Maximum angle the user puck will be rotated when snapping the user's course to the route line.

maxTurnCompletionOffset

val maxTurnCompletionOffset: Double

Threshold user must be within to count as completing a step. One of two heuristics used to know when a user completes a step, see .maneuverZoneRadius. The users heading and the finalHeading are compared. If this number is within this defined value, the user has completed the step.

metersRemainingTillArrival

val metersRemainingTillArrival: Double

Meter radius which the user must be inside for an arrival milestone to be triggered and navigation to end.

offRouteMinimumDistanceMetersAfterReroute

val offRouteMinimumDistanceMetersAfterReroute: Double

Minimum distance in meters that the user must travel after a re-routing was done.

offRouteMinimumDistanceMetersBeforeRightDirection

val offRouteMinimumDistanceMetersBeforeRightDirection: Double

Minimum distance in meters that the user must travel in the correct direction before the off-route logic recognizes the user is back on the right direction

offRouteMinimumDistanceMetersBeforeWrongDirection

val offRouteMinimumDistanceMetersBeforeWrongDirection: Double

Minimum distance in meters that the user must travel in the wrong direction before the off-route logic recognizes the user is moving away from upcoming maneuver

offRouteThresholdRadiusMeters

val offRouteThresholdRadiusMeters: Double

Threshold for off-route detection. If the user is outside of this defined radius, the user always is off route. Radius defined in meters.

roundingIncrement

val roundingIncrement: MapLibreNavigationOptions.RoundingIncrement

The increment used for rounding the user's speed and the remaining duration of the route.

secondsBeforeReroute

val secondsBeforeReroute: Int

Seconds used before a reroute occurs.

snapToRoute

val snapToRoute: Boolean

timeFormatType