Class: MapDataIntegrityRTRController
Defined in: src/garminsdk/components/map/controllers/MapDataIntegrityRTRController.ts:38
Controls the map's projected target, orientation mode, and player airplane icon based on heading and GPS signal validity.
Extends
MapSystemController<MapDataIntegrityRTRControllerModules,any,any,MapDataIntegrityRTRControllerContext>
Constructors
Constructor
new MapDataIntegrityRTRController(
context,airplaneIconSrc?,airplaneIconAnchor?,normalIconSrc?,normalIconAnchor?,noHeadingIconSrc?,noHeadingIconAnchor?):MapDataIntegrityRTRController
Defined in: src/garminsdk/components/map/controllers/MapDataIntegrityRTRController.ts:106
Constructor.
Parameters
| Parameter | Type | Description |
|---|---|---|
context | MapSystemContext<MapDataIntegrityRTRControllerModules, any, any, MapDataIntegrityRTRControllerContext> | This controller's map context. |
airplaneIconSrc? | MutableSubscribable<string, string> | A mutable subscribable which controls the player airplane icon's image source URI. Required for this controller to change the player airplane icon. |
airplaneIconAnchor? | MutableSubscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>, Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>> | A mutable subscribable which controls the anchor point of the player airplane icon. Required for this controller to change the player airplane icon. |
normalIconSrc? | Subscribable<string> | A subscribable which provides the URI of the normal player airplane icon's image source. Required for this controller to change the player airplane icon. |
normalIconAnchor? | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>> | A subscribable which provides the anchor point of the normal player airplane icon, as [x, y], where each component is relative to the width or height of the icon. Required for this controller to change the player airplane icon. |
noHeadingIconSrc? | Subscribable<string> | A subscribable which provides the URI of the no-heading player airplane icon's image source. Required for this controller to change the player airplane icon. |
noHeadingIconAnchor? | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>> | A subscribable which provides the anchor point of the no-heading player airplane icon, as [x, y], where each component is relative to the width or height of the icon. Required for this controller to change the player airplane icon. |
Returns
MapDataIntegrityRTRController
Overrides
MapSystemController<MapDataIntegrityRTRControllerModules, any, any, MapDataIntegrityRTRControllerContext>.constructor
Properties
context
protectedreadonlycontext:MapSystemContext<MapDataIntegrityRTRControllerModules,any,any,MapDataIntegrityRTRControllerContext>
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/MapDataIntegrityRTRController.ts:223
Returns
void
Inherit Doc
Overrides
MapSystemController.destroy
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/garminsdk/components/map/controllers/MapDataIntegrityRTRController.ts:119
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(
time,elapsed):void
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:68
This method is called immediately before 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.onBeforeUpdated
onDeadZoneChanged()
onDeadZoneChanged(
deadZone):void
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:48
This method is called when the dead zone of this controller's map changes.
Parameters
| Parameter | Type | Description |
|---|---|---|
deadZone | ReadonlyFloat64Array | The map's new dead zone. |
Returns
void
Inherited from
MapSystemController.onDeadZoneChanged
onMapDestroyed()
onMapDestroyed():
void
Defined in: src/garminsdk/components/map/controllers/MapDataIntegrityRTRController.ts:218
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapDestroyed
onMapProjectionChanged()
onMapProjectionChanged(
mapProjection,changeFlags):void
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:58
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
Inherited from
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