Skip to main content

Class: MapBindingsController

A controller which maintains an arbitrary number of bindings.

Hierarchy

Constructors

constructor

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

Constructor.

Parameters

NameTypeDescription
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

Defined in

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

Properties

context

Protected Readonly context: MapSystemContext<any, 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

Destroys this controller.

Returns

void

Overrides

MapSystemController.destroy

Defined in

src/sdk/components/mapsystem/controllers/MapBindingsController.ts:108


onAfterMapRender

onAfterMapRender(): void

This method is called after this controller' map is rendered.

Returns

void

Overrides

MapSystemController.onAfterMapRender

Defined in

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


onAfterUpdated

onAfterUpdated(time, elapsed): void

This method is called immediately after this controller's map updates its layers.

Parameters

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

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

NameTypeDescription
deadZoneReadonly<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

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

Returns

void

Overrides

MapSystemController.onMapDestroyed

Defined in

src/sdk/components/mapsystem/controllers/MapBindingsController.ts:91


onMapProjectionChanged

onMapProjectionChanged(mapProjection, changeFlags): void

This method is called when the projection of this controller's map changes.

Parameters

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

Overrides

MapSystemController.onSleep

Defined in

src/sdk/components/mapsystem/controllers/MapBindingsController.ts:102


onWake

onWake(): void

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

Returns

void

Overrides

MapSystemController.onWake

Defined in

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