spatial-monorepo

---

spatial-monorepo / core/src / BlueDotHandle

Interface: BlueDotHandle()

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

Handle returned by setupBlueDot. Callable directly as the teardown function — the same () => void contract setupBlueDot has always returned — plus methods to control camera follow mode at runtime without tearing down/recreating the underlying sources/layers (issue #476 AC3).

BlueDotHandle(): void

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

Handle returned by setupBlueDot. Callable directly as the teardown function — the same () => void contract setupBlueDot has always returned — plus methods to control camera follow mode at runtime without tearing down/recreating the underlying sources/layers (issue #476 AC3).

Returns

void

Methods

getFollowMode()

getFollowMode(): BlueDotFollowMode

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

The currently configured follow mode.

Returns

BlueDotFollowMode

---

isDisengaged()

isDisengaged(): boolean

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

true once a user-initiated pan/zoom/rotate/pitch gesture has disengaged camera follow (AC4). Stays true until reengage() (or setFollowMode()) is called — follow never fights a manual pan/zoom by re-centering out from under the user's gesture.

Returns

boolean

---

reengage()

reengage(): void

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

Re-arm camera follow after a user-gesture disengage — the "Recenter" button convention (AC4). Idempotent.

Returns

void

---

setFollowMode()

setFollowMode(mode): void

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

Switch follow mode at runtime. Takes effect on the very next position tick — no map remount required. Calling this also re-arms follow if a user gesture had previously disengaged it (AC3/AC4).

Parameters

mode

BlueDotFollowMode

Returns

void

---

setGetPathBearingDeg()

setGetPathBearingDeg(fn): void

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

Replace the getPathBearingDeg callback at runtime (e.g. once a Navigation instance/active route becomes available after this handle was created) — takes effect on the next tick, no re-setup required.

Parameters

fn

((position) => number | null | undefined) | undefined

Returns

void

---

setOnFollowDisengaged()

setOnFollowDisengaged(fn): void

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

Replace the onFollowDisengaged callback at runtime — takes effect immediately, no re-setup required.

Parameters

fn

(() => void) | undefined

Returns

void