Class: MapTerrainController
Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:54
Controls the display of terrain based on user settings.
Extends
MapSystemController<MapTerrainControllerModules>
Constructors
Constructor
new MapTerrainController(
context,settingManager?,allowRelative?):MapTerrainController
Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:79
Creates a new instance of MapTerrainController.
Parameters
| Parameter | 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
MapTerrainController
Overrides
MapSystemController<MapTerrainControllerModules>.constructor
Constructor
new MapTerrainController(
context,settingManager?,options?):MapTerrainController
Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:91
Creates a new instance of MapTerrainController.
Parameters
| Parameter | 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
MapTerrainController
Overrides
MapSystemController<MapTerrainControllerModules>.constructor
Properties
context
protectedreadonlycontext:MapSystemContext<MapTerrainControllerModules,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/MapTerrainController.ts:162
Returns
void
Inherit Doc
Overrides
MapSystemController.destroy
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/garminsdk/components/map/controllers/MapTerrainController.ts:115
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/MapTerrainController.ts:157
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