Class: MapPointerRTRController
Controls the target, orientation, and range of a map while the map pointer is active.
Hierarchy
MapSystemController<MapPointerRTRControllerModules>↳
MapPointerRTRController
Constructors
constructor
• new MapPointerRTRController(context, pointerBoundsOffset): MapPointerRTRController
Creates a new instance of MapPointerRTRController.
Parameters
| Name | 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
Overrides
MapSystemController\<MapPointerRTRControllerModules\>.constructor
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:63
Properties
context
• Protected Readonly context: MapSystemContext<MapPointerRTRControllerModules, any, any, any>
Inherited from
MapSystemController.context
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:24
pointerBoundsOffset
• Protected Readonly pointerBoundsOffset: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:39
Accessors
isAlive
• get isAlive(): boolean
Whether this controller is alive.
Returns
boolean
Inherited from
MapSystemController.isAlive
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:20
Methods
destroy
▸ destroy(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.destroy
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:238
onAfterMapRender
▸ onAfterMapRender(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onAfterMapRender
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:73
onAfterUpdated
▸ onAfterUpdated(time, elapsed): void
This method is called immediately after this controller's map updates its layers.
Parameters
| Name | 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
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:78
onBeforeUpdated
▸ onBeforeUpdated(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onBeforeUpdated
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:228
onDeadZoneChanged
▸ onDeadZoneChanged(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onDeadZoneChanged
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:216
onMapDestroyed
▸ onMapDestroyed(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapDestroyed
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:233
onMapProjectionChanged
▸ onMapProjectionChanged(mapProjection, changeFlags): void
Parameters
| Name | Type |
|---|---|
mapProjection | MapProjection |
changeFlags | number |
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapProjectionChanged
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:221
onPointerActivated
▸ onPointerActivated(): void
Responds to map pointer activation.
Returns
void
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:125
onPointerActiveChanged
▸ onPointerActiveChanged(isActive): void
Responds to map pointer activation changes.
Parameters
| Name | Type | Description |
|---|---|---|
isActive | boolean | Whether the map pointer is active. |
Returns
void
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:114
onPointerDeactivated
▸ onPointerDeactivated(): void
Responds to map pointer deactivation.
Returns
void
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:139
onSleep
▸ onSleep(): void
This method is called when this controller's map is put to sleep.
Returns
void
Inherited from
MapSystemController.onSleep
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:92
onWake
▸ onWake(): void
This method is called when this controller's map is awakened.
Returns
void
Inherited from
MapSystemController.onWake
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:85
schedulePointerScrollUpdate
▸ schedulePointerScrollUpdate(): void
Schedules an update to scrolling due to the pointer.
Returns
void
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:173
updatePointerScroll
▸ updatePointerScroll(): void
Updates scrolling due to the pointer.
Returns
void
Defined in
src/garminsdk/components/map/controllers/MapPointerRTRController.ts:183