NavigationState

class NavigationState(engine: NavigationState, metadataRepository: MetadataRepository)

Read-only Kotlin wrapper for the engine's EngineNavigationState.

Provides access to navigation state such as current position, upcoming instructions, and route distance estimates. This class is immutable from the Kotlin side — updates to navigation state should be performed in the engine.

Constructors

Link copied to clipboard
constructor(engine: NavigationState, metadataRepository: MetadataRepository)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard

Instruction after the next, if available.

Link copied to clipboard

Building ID of the current route.

Link copied to clipboard

Current instruction, if available.

Link copied to clipboard

Current route path, if available

Link copied to clipboard

The current segment, in Kotlin wrapper form

Link copied to clipboard

Path points ahead of current location in current segment.

Link copied to clipboard

Path points already visited in current segment.

Link copied to clipboard

Name of the destination waypoint, if available.

Link copied to clipboard

Distance and time to the end of the route (converted to Kotlin wrapper).

Link copied to clipboard

Distance and time to the next instruction (converted to Kotlin wrapper).

Link copied to clipboard

Distance from the user to the nearest point on the route (in meters).

Link copied to clipboard

Whether navigation is currently active.

Link copied to clipboard

Checks if the current segment is the first segment

Link copied to clipboard

Checks if the current segment is an intermediary segment (i.e., not first and not last)

Link copied to clipboard

Checks if the current segment is the last segment

Link copied to clipboard

Next instruction, if available.

Link copied to clipboard
val projectedUserPoint: Mercator?

Projected user position onto the route path (used for distance calcs).

Link copied to clipboard

Property ID of the current route.

Link copied to clipboard

Upcoming segments, in Kotlin wrapper form

Link copied to clipboard
val userPoint: Position?

User's current position (blue dot).

Link copied to clipboard

Already‐traversed segments, in Kotlin wrapper form

Functions

Link copied to clipboard
open override fun toString(): String