Class: MapOrientationRTRController

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

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

Extends

• MapSystemController<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>

Constructors

Constructor

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

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

Constructor.

Parameters

Parameter	Type	Description
context	MapSystemContext<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>	This controller's map context.
nominalTargetOffsets?	Partial<Record<MapOrientation, Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "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<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "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.constructor

Properties

context

protected readonly context: MapSystemContext<MapOrientationRTRControllerModules, any, any, MapOrientationRTRControllerContext>

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

Inherited from

MapSystemController.context

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

Destroys this controller.

Returns

void

Overrides

MapSystemController.destroy

---

onAfterMapRender()

onAfterMapRender(): void

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

This method is called after this controller' map is rendered.

Returns

void

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

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

Returns

void

Overrides

MapSystemController.onBeforeUpdated

---

onDeadZoneChanged()

onDeadZoneChanged(): void

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

This method is called when the dead zone of this controller's map changes.

Returns

void

Overrides

MapSystemController.onDeadZoneChanged

---

onMapDestroyed()

onMapDestroyed(): void

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

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

Returns

void

Overrides

MapSystemController.onMapDestroyed

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

Defined in: src/garminsdk/components/map/controllers/MapOrientationRTRController.ts:135

This method is called when the projection of this controller's map changes.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection.
changeFlags	number	Bit flags describing the type of change.

Returns

void

Overrides

MapSystemController.onMapProjectionChanged

---

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