Skip to main content

Class: MapBindingsController

Defined in: src/sdk/components/mapsystem/controllers/MapBindingsController.ts:55

A controller which maintains an arbitrary number of bindings.

Extends​

Constructors​

Constructor​

new MapBindingsController(context, bindings, onDestroy?): MapBindingsController

Defined in: src/sdk/components/mapsystem/controllers/MapBindingsController.ts:65

Constructor.

Parameters​

ParameterTypeDescription
contextMapSystemContext<any, any, any, any>This controller's map context.
bindingsIterable<MapBinding>This controller's bindings.
onDestroy?() => voidA function to execute when the controller is destroyed.

Returns​

MapBindingsController

Overrides​

MapSystemController.constructor

Properties​

context​

protected readonly context: MapSystemContext<any, 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/sdk/components/mapsystem/controllers/MapBindingsController.ts:108

Destroys this controller.

Returns​

void

Overrides​

MapSystemController.destroy


onAfterMapRender()​

onAfterMapRender(): void

Defined in: src/sdk/components/mapsystem/controllers/MapBindingsController.ts:74

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/sdk/components/mapsystem/controllers/MapBindingsController.ts:91

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/controllers/MapBindingsController.ts:102

This method is called when this controller's map is put to sleep.

Returns​

void

Overrides​

MapSystemController.onSleep


onWake()​

onWake(): void

Defined in: src/sdk/components/mapsystem/controllers/MapBindingsController.ts:96

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

Returns​

void

Overrides​

MapSystemController.onWake