Class: MapOrientationRTRController

Controls the rotation, range, and projected target offset of a map based on the orientation module's orientation value.

Hierarchy

• MapSystemController<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>

  ↳ MapOrientationRTRController

Constructors

constructor

• new MapOrientationRTRController(context, nominalTargetOffsets?, nominalRangeEndpoints?): MapOrientationRTRController

Constructor.

Parameters

Name	Type	Description
context	MapSystemContext<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>	This controller's map context.
nominalTargetOffsets?	Partial<Record<MapOrientation, Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>>>	The nominal projected target offsets this controller applies for each orientation, as [x, y] relative to the width and height of the map's projected window excluding the dead zone. If an orientation does not have a defined offset, it will default to [0, 0].
nominalRangeEndpoints?	Partial<Record<MapOrientation, Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>>>	The nominal range endpoints this controller applies for each orientation, as [x1, y1, x2, y2] relative to the width and height of the map's projected window excluding the dead zone. If an orientation does not have defined range endpoints, it will default to [0.5, 0.5, 0.5, 0].

Returns

MapOrientationRTRController

Overrides

MapSystemController\<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext\>.constructor

Defined in

src/garminsdk/components/map/controllers/MapOrientationRTRController.ts:85

Properties

context

• Protected Readonly context: MapSystemContext<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>

Inherited from

MapSystemController.context

Defined in

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

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/MapOrientationRTRController.ts:220

---

onAfterMapRender

▸ onAfterMapRender(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

Defined in

src/garminsdk/components/map/controllers/MapOrientationRTRController.ts:94

---

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/MapOrientationRTRController.ts:142

---

onDeadZoneChanged

▸ onDeadZoneChanged(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onDeadZoneChanged

Defined in

src/garminsdk/components/map/controllers/MapOrientationRTRController.ts:129

---

onMapDestroyed

▸ onMapDestroyed(): void

Returns

void

Inherit Doc

Overrides

MapSystemController.onMapDestroyed

Defined in

src/garminsdk/components/map/controllers/MapOrientationRTRController.ts:215

---

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/MapOrientationRTRController.ts:135

---

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