Class: MapTerrainColorsController

Defined in: src/garminsdk/components/map/controllers/MapTerrainColorsController.ts:35

Controls the display of terrain colors based on the terrain mode value in MapTerrainModule.

Extends

• MapSystemController<MapTerrainColorsControllerModules>

Constructors

Constructor

new MapTerrainColorsController(context, colors, groundRelativeBlendDuration): MapTerrainColorsController

Defined in: src/garminsdk/components/map/controllers/MapTerrainColorsController.ts:74

Constructor.

Parameters

Parameter	Type	Default value	Description
context	MapSystemContext<MapTerrainColorsControllerModules>	undefined	This controller's map context.
colors	Partial<Record<MapTerrainMode, Readonly<MapTerrainColorsDefinition>>>	undefined	The terrain colors to use for each terrain mode. Default colors will be used for any mode which does not have a colors definition.
groundRelativeBlendDuration	number	0	The amount of time, in milliseconds, over which to blend the on-ground and relative terrain mode colors when transitioning between the two. Defaults to 0 milliseconds. A blend transition is only possible if colors are defined for both the on-ground and relative terrain modes, and the colors for both modes have the same number of steps and are applied over the same elevation range.

Returns

MapTerrainColorsController

Overrides

MapSystemController<MapTerrainColorsControllerModules>.constructor

Properties

context

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

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/MapTerrainColorsController.ts:172

Returns

void

Inherit Doc

Overrides

MapSystemController.destroy

---

onAfterMapRender()

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapTerrainColorsController.ts:105

Returns

void

Inherit Doc

Overrides

MapSystemController.onAfterMapRender

---

onAfterUpdated()

onAfterUpdated(): void

Defined in: src/garminsdk/components/map/controllers/MapTerrainColorsController.ts:140

Returns

void

Inherit Doc

Overrides

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/MapTerrainColorsController.ts:167

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