Skip to main content

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

A map controller.

Type parameters

NameType
Modulesextends ModuleRecord = any
Layersextends LayerRecord = any
Controllersextends ControllerRecord = any
Contextextends ContextRecord = any

Hierarchy

Constructors

constructor

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

Constructor.

Type parameters

NameType
Modulesextends ModuleRecord = any
Layersextends LayerRecord = any
Controllersextends ControllerRecord = any
Contextextends ContextRecord = any

Parameters

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

Returns

MapSystemController<Modules, Layers, Controllers, Context>

Defined in

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

Properties

context

Protected Readonly context: MapSystemContext<Modules, Layers, Controllers, Context>

Defined in

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

Accessors

isAlive

get isAlive(): boolean

Whether this controller is alive.

Returns

boolean

Defined in

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

Methods

destroy

destroy(): void

Destroys this controller.

Returns

void

Defined in

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


onAfterMapRender

onAfterMapRender(ref): void

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

Parameters

NameTypeDescription
refMapSystemComponent<MapSystemComponentProps<any>>A reference to the rendered map.

Returns

void

Defined in

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


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

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

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

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

Defined in

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


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

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

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:92


onWake

onWake(): void

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

Returns

void

Defined in

src/sdk/components/mapsystem/MapSystemController.ts:85