Skip to main content

Class: MapWindVectorController

Defined in: src/garminsdk/components/map/controllers/MapWindVectorController.ts:30

Controls the display of the wind vector based on user settings.

The controller displays the wind vector if and only if user settings are set to show the vector and the map pointer is not active.

Extends​

Constructors​

Constructor​

new MapWindVectorController(context, settingManager): MapWindVectorController

Defined in: src/garminsdk/components/map/controllers/MapWindVectorController.ts:41

Creates a new instance of MapWindVectorController.

Parameters​

ParameterTypeDescription
contextMapSystemContext<MapWindVectorControllerModules, any, any, any>This controller's map context.
settingManagerUserSettingManager<Partial<MapWindVectorUserSettings>>A setting manager containing the user settings controlling the display of the wind vector.

Returns​

MapWindVectorController

Overrides​

MapSystemController.constructor

Properties​

context​

protected readonly context: MapSystemContext<MapWindVectorControllerModules, 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/MapWindVectorController.ts:71

Destroys this controller.

Returns​

void

Overrides​

MapSystemController.destroy


onAfterMapRender()​

onAfterMapRender(): void

Defined in: src/garminsdk/components/map/controllers/MapWindVectorController.ts:61

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​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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​

ParameterTypeDescription
timenumberThe current time, as a Javascript timestamp.
elapsednumberThe 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​

ParameterTypeDescription
deadZoneReadonlyFloat64ArrayThe map's new dead zone.

Returns​

void

Inherited from​

MapSystemController.onDeadZoneChanged


onMapDestroyed()​

onMapDestroyed(): void

Defined in: src/garminsdk/components/map/controllers/MapWindVectorController.ts:66

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

Returns​

void

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​

ParameterTypeDescription
mapProjectionMapProjectionThe map projection.
changeFlagsnumberBit 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