Class: MapSystemGenericController<Modules, Layers, Controllers, Context>
A map controller which delegates its behavior to injected callback functions.
Type parameters
Name | Type |
---|---|
Modules | extends ModuleRecord = any |
Layers | extends LayerRecord = any |
Controllers | extends ControllerRecord = any |
Context | extends ContextRecord = any |
Hierarchy
MapSystemController
<Modules
,Layers
,Controllers
,Context
>↳
MapSystemGenericController
Constructors
constructor
• new MapSystemGenericController<Modules
, Layers
, Controllers
, Context
>(context
, callbacks
): MapSystemGenericController
<Modules
, Layers
, Controllers
, Context
>
Constructor.
Type parameters
Name | Type |
---|---|
Modules | extends ModuleRecord = any |
Layers | extends LayerRecord = any |
Controllers | extends ControllerRecord = any |
Context | extends ContextRecord = any |
Parameters
Name | Type | Description |
---|---|---|
context | MapSystemContext <Modules , Layers , any , Context > | This controller's map context. |
callbacks | MapSystemGenericControllerCallbacks <MapSystemContext <Modules , Layers , Controllers , Context >> | The callback functions to which this controller delegates its behavior. |
Returns
MapSystemGenericController
<Modules
, Layers
, Controllers
, Context
>
Overrides
MapSystemController.constructor
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:54
Properties
context
• Protected
Readonly
context: MapSystemContext
<Modules
, Layers
, Controllers
, Context
>
Inherited from
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
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:102
onAfterMapRender
▸ onAfterMapRender(): void
This method is called after this controller' map is rendered.
Returns
void
Overrides
MapSystemController.onAfterMapRender
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:62
onAfterUpdated
▸ onAfterUpdated(time
, elapsed
): void
This method is called immediately after this controller's map updates its layers.
Parameters
Name | Type | Description |
---|---|---|
time | number | The current time, as a Javascript timestamp. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
Overrides
MapSystemController.onAfterUpdated
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:82
onBeforeUpdated
▸ onBeforeUpdated(time
, elapsed
): void
This method is called immediately before this controller's map updates its layers.
Parameters
Name | Type | Description |
---|---|---|
time | number | The current time, as a Javascript timestamp. |
elapsed | number | The elapsed time, in milliseconds, since the last update. |
Returns
void
Overrides
MapSystemController.onBeforeUpdated
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:77
onDeadZoneChanged
▸ onDeadZoneChanged(deadZone
): void
This method is called when the dead zone of this controller's map changes.
Parameters
Name | Type | Description |
---|---|---|
deadZone | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | The map's new dead zone. |
Returns
void
Overrides
MapSystemController.onDeadZoneChanged
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:67
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/MapSystemGenericController.ts:97
onMapProjectionChanged
▸ onMapProjectionChanged(mapProjection
, changeFlags
): void
This method is called when the projection of this controller's map changes.
Parameters
Name | Type | Description |
---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit flags describing the type of change. |
Returns
void
Overrides
MapSystemController.onMapProjectionChanged
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:72
onSleep
▸ onSleep(): void
This method is called when this controller's map is put to sleep.
Returns
void
Overrides
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:92
onWake
▸ onWake(): void
This method is called when this controller's map is awakened.
Returns
void
Overrides
Defined in
src/sdk/components/mapsystem/MapSystemGenericController.ts:87