Class: MapPointerRTRController

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:34

Controls the target, orientation, and range of a map while the map pointer is active.

Extends

• MapSystemController<MapPointerRTRControllerModules>

Constructors

Constructor

new MapPointerRTRController(context, pointerBoundsOffset): MapPointerRTRController

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:63

Creates a new instance of MapPointerRTRController.

Parameters

Parameter	Type	Description
context	MapSystemContext<MapPointerRTRControllerModules>	This controller's map context.
pointerBoundsOffset	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>	The offset of the boundary surrounding the area in which the pointer can freely move, from the edge of the projected map, excluding the dead zone. Expressed as [left, top, right, bottom], relative to the width and height, as appropriate, of the projected map. A positive offset is directed toward the center of the map.

Returns

MapPointerRTRController

Overrides

MapSystemController<MapPointerRTRControllerModules>.constructor

Properties

context

protected readonly context: MapSystemContext<MapPointerRTRControllerModules, any, any, any>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Inherited from

MapSystemController.context

---

pointerBoundsOffset

protected readonly pointerBoundsOffset: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:39

Accessors

isAlive

Get Signature

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns

boolean

Inherited from

MapSystemController.isAlive

Methods

destroy()

destroy(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:238

Returns

void

Inherit Doc

Overrides

MapSystemController.destroy

---

onAfterMapRender()

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:73

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

---

onAfterUpdated()

onAfterUpdated(time, elapsed): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:78

This method is called immediately after this controller's map updates its layers.

Parameters

Parameter	Type	Description
time	number	The current time, as a Javascript timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Inherited from

MapSystemController.onAfterUpdated

---

onBeforeUpdated()

onBeforeUpdated(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:228

Returns

void

Inherit Doc

Overrides

MapSystemController.onBeforeUpdated

---

onDeadZoneChanged()

onDeadZoneChanged(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:216

Returns

void

Inherit Doc

Overrides

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:233

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapDestroyed

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:221

Parameters

Parameter	Type
mapProjection	MapProjection
changeFlags	number

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapProjectionChanged

---

onPointerActivated()

protected onPointerActivated(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:125

Responds to map pointer activation.

Returns

void

---

onPointerActiveChanged()

protected onPointerActiveChanged(isActive): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:114

Responds to map pointer activation changes.

Parameters

Parameter	Type	Description
isActive	boolean	Whether the map pointer is active.

Returns

void

---

onPointerDeactivated()

protected onPointerDeactivated(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:139

Responds to map pointer deactivation.

Returns

void

---

onSleep()

onSleep(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:92

This method is called when this controller's map is put to sleep.

Returns

void

Inherited from

MapSystemController.onSleep

---

onWake()

onWake(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:85

This method is called when this controller's map is awakened.

Returns

void

Inherited from

MapSystemController.onWake

---

schedulePointerScrollUpdate()

protected schedulePointerScrollUpdate(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:173

Schedules an update to scrolling due to the pointer.

Returns

void

---

updatePointerScroll()

protected updatePointerScroll(): void

Defined in: src/garminsdk/components/map/controllers/MapPointerRTRController.ts:183

Updates scrolling due to the pointer.

Returns

void