Class: MapSystemGenericController<Modules, Layers, Controllers, Context>
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:42
A map controller which delegates its behavior to injected callback functions.
Extends
MapSystemController
<Modules
,Layers
,Controllers
,Context
>
Type Parameters
Type Parameter | Default type |
---|---|
Modules extends ModuleRecord | any |
Layers extends LayerRecord | any |
Controllers extends ControllerRecord | any |
Context extends ContextRecord | any |
Constructors
Constructor
new MapSystemGenericController<
Modules
,Layers
,Controllers
,Context
>(context
,callbacks
):MapSystemGenericController
<Modules
,Layers
,Controllers
,Context
>
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:54
Constructor.
Parameters
Parameter | 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
Properties
context
protected
readonly
context:MapSystemContext
<Modules
,Layers
,Controllers
,Context
>
Defined in: src/sdk/components/mapsystem/MapSystemController.ts:24
Inherited from
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
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:102
Destroys this controller.
Returns
void
Overrides
onAfterMapRender()
onAfterMapRender():
void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:62
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/MapSystemGenericController.ts:82
This method is called immediately after this controller's map updates its layers.
Parameters
Parameter | 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
onBeforeUpdated()
onBeforeUpdated(
time
,elapsed
):void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:77
This method is called immediately before this controller's map updates its layers.
Parameters
Parameter | 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
onDeadZoneChanged()
onDeadZoneChanged(
deadZone
):void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:67
This method is called when the dead zone of this controller's map changes.
Parameters
Parameter | Type | Description |
---|---|---|
deadZone | ReadonlyFloat64Array | The map's new dead zone. |
Returns
void
Overrides
MapSystemController
.onDeadZoneChanged
onMapDestroyed()
onMapDestroyed():
void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:97
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/MapSystemGenericController.ts:72
This method is called when the projection of this controller's map changes.
Parameters
Parameter | Type | Description |
---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit flags describing the type of change. |
Returns
void
Overrides
MapSystemController
.onMapProjectionChanged
onSleep()
onSleep():
void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:92
This method is called when this controller's map is put to sleep.
Returns
void
Overrides
onWake()
onWake():
void
Defined in: src/sdk/components/mapsystem/MapSystemGenericController.ts:87
This method is called when this controller's map is awakened.
Returns
void