spatial-monorepo / core/src / NavigationProgress
Interface: NavigationProgress
Defined in: packages/core/src/wayfinding/Navigation.ts:218
Properties
currentInstructionIndex
currentInstructionIndex:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:240
Index into route.instructions (the flattened turn-by-turn list — see NavigationRoute.instructions) of the instruction currently active, or -1 when the active route carries no instructions.
distanceCoveredM
distanceCoveredM:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:230
Cumulative walking distance (metres) covered along the path to reach snappedPosition.
distanceRemainingM
distanceRemainingM:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:232
Remaining walking distance (metres) to the route's end.
lateralDistanceM
lateralDistanceM:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:242
Perpendicular (lateral) distance in metres from position to snappedPosition.
onRoute
onRoute:
boolean
Defined in: packages/core/src/wayfinding/Navigation.ts:244
true when lateralDistanceM <= 5 (the off-route threshold).
pathBearingDeg
pathBearingDeg:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:228
True-north bearing (degrees, 0–360) of the path segment at snappedPosition — intended to feed a position-and-path-direction blue-dot follow mode (issue #476).
position
position:
Position2D
Defined in: packages/core/src/wayfinding/Navigation.ts:220
Raw fed position, [lng, lat].
progressPercent
progressPercent:
number
Defined in: packages/core/src/wayfinding/Navigation.ts:234
0–100, clamped to the path's actual length.
snappedPosition
snappedPosition:
Position2D
Defined in: packages/core/src/wayfinding/Navigation.ts:222
position projected onto the nearest point of the active path's geometry.