Class: MapTerrainController
Controls the display of terrain based on user settings.
Hierarchy
MapSystemController<MapTerrainControllerModules>↳
MapTerrainController
Constructors
constructor
• new MapTerrainController(context, settingManager?, allowRelative?): MapTerrainController
Creates a new instance of MapTerrainController.
Parameters
| Name | Type | Description |
|---|---|---|
context | MapSystemContext<MapTerrainControllerModules, any, any, any> | This controller's map context. |
settingManager? | UserSettingManager<Partial<MapTerrainUserSettings>> | A setting manager containing the user settings controlling the display of terrain. If not defined, the display of terrain will not be bound to user settings. |
allowRelative? | boolean | Whether to allow relative terrain mode. Defaults to true. Ignored if settingManager is not defined. |
Returns
Overrides
MapSystemController\<MapTerrainControllerModules\>.constructor
Defined in
src/garminsdk/components/map/controllers/MapTerrainController.ts:79
• new MapTerrainController(context, settingManager?, options?): MapTerrainController
Creates a new instance of MapTerrainController.
Parameters
| Name | Type | Description |
|---|---|---|
context | MapSystemContext<MapTerrainControllerModules, any, any, any> | This controller's map context. |
settingManager? | UserSettingManager<Partial<MapTerrainUserSettings>> | A setting manager containing the user settings controlling the display of terrain. If not defined, the display of terrain will not be bound to user settings. |
options? | Readonly<MapTerrainControllerOptions> | Options with which to configure the controller. |
Returns
Overrides
MapSystemController\<MapTerrainControllerModules\>.constructor
Defined in
src/garminsdk/components/map/controllers/MapTerrainController.ts:91
Properties
context
• Protected Readonly context: MapSystemContext<MapTerrainControllerModules, any, any, any>
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/MapTerrainController.ts:162
onAfterMapRender
▸ onAfterMapRender(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onAfterMapRender
Defined in
src/garminsdk/components/map/controllers/MapTerrainController.ts:115
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(time, elapsed): void
This method is called immediately before 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.onBeforeUpdated
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:68
onDeadZoneChanged
▸ onDeadZoneChanged(deadZone): void
This method is called when the dead zone of this controller's map changes.
Parameters
| Name | Type | Description |
|---|---|---|
deadZone | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The map's new dead zone. |
Returns
void
Inherited from
MapSystemController.onDeadZoneChanged
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:48
onMapDestroyed
▸ onMapDestroyed(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onMapDestroyed
Defined in
src/garminsdk/components/map/controllers/MapTerrainController.ts:157
onMapProjectionChanged
▸ onMapProjectionChanged(mapProjection, changeFlags): void
This method is called when the projection of this controller's map changes.
Parameters
| Name | Type | Description |
|---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit flags describing the type of change. |
Returns
void
Inherited from
MapSystemController.onMapProjectionChanged
Defined in
src/sdk/components/mapsystem/MapSystemController.ts:58
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