Skip to main content

Abstract Class: MapSystemController<Modules, Layers, Controllers, Context>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:10

A map controller.

Extended by

Type Parameters

Type ParameterDefault type
Modules extends ModuleRecordany
Layers extends LayerRecordany
Controllers extends ControllerRecordany
Context extends ContextRecordany

Constructors

Constructor

new MapSystemController<Modules, Layers, Controllers, Context>(context): MapSystemController<Modules, Layers, Controllers, Context>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:30

Constructor.

Parameters

ParameterTypeDescription
contextMapSystemContext<Modules, Layers, any, Context>This controller's map context.

Returns

MapSystemController<Modules, Layers, Controllers, Context>

Properties

context

protected readonly context: MapSystemContext<Modules, Layers, Controllers, Context>

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24

Accessors

isAlive

Get Signature

get isAlive(): boolean

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:20

Whether this controller is alive.

Returns

boolean

Methods

destroy()

destroy(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:106

Destroys this controller.

Returns

void


onAfterMapRender()

onAfterMapRender(ref): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:39

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

Parameters

ParameterTypeDescription
refMapSystemComponentA reference to the rendered map.

Returns

void


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


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


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


onMapDestroyed()

onMapDestroyed(): void

Defined in: src/sdk/components/mapsystem/MapSystemController.ts:99

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

Returns

void


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


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


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