Skip to content

spatial-monorepo


spatial-monorepo / core/src / SetupBlueDotOptions

Interface: SetupBlueDotOptions

Defined in: packages/core/src/layers/RTLSLayer.ts:345

Properties

followMode?

optional followMode?: BlueDotFollowMode

Defined in: packages/core/src/layers/RTLSLayer.ts:347

Camera follow mode. Default false — no camera follow, matching pre-#476 behavior.


getPathBearingDeg?

optional getPathBearingDeg?: (position) => number | null | undefined

Defined in: packages/core/src/layers/RTLSLayer.ts:354

Required for position-and-path-direction. Called on every tick the dot is on the active floor; return the path-tangent bearing (true-north degrees) for position, or null/undefined when there is no active route to derive one from (that tick's camera bearing is left untouched).

Parameters

position

PositionUpdate

Returns

number | null | undefined


onFollowDisengaged?

optional onFollowDisengaged?: () => void

Defined in: packages/core/src/layers/RTLSLayer.ts:361

Called exactly once when a user-initiated pan/zoom/rotate/pitch gesture disengages an active follow mode (issue #476 AC4). Use it to surface a "Recenter" affordance; call the returned handle's reengage() (or setFollowMode() again) to resume following.

Returns

void

Released under commercial licensing.