Abstract Class: MapFormatController<L>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:64
A map system controller that controls the display settings of the various format and terrain/wxr combinations.
Extends
Extended by
Type Parameters
Type Parameter | Default type |
---|---|
L extends MapFormatControllerLayers | MapFormatControllerLayers |
Constructors
Constructor
new MapFormatController<
L
>(context
,currentMapFormatConfig
,terrWxState
,tfcEnabled
):MapFormatController
<L
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:117
Creates an instance of the MapFormatController.
Parameters
Parameter | Type | Description |
---|---|---|
context | MapSystemContext <MapFormatControllerModules > | The map system context to use with this controller. |
currentMapFormatConfig | Subscribable <MapFormatConfig > | A subscribable for the current map format config. |
terrWxState | Subscribable <TerrWxState > | A subscribable for the current terr wx state. |
tfcEnabled | Subscribable <boolean > | A subscribable for whether tfc is enabled. |
Returns
MapFormatController
<L
>
Overrides
MapSystemController
.constructor
Properties
bingLayer?
protected
readonly
optional
bingLayer:L
["bing"
]
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:77
context
protected
readonly
context:MapSystemContext
<MapFormatControllerModules
,L
,any
,any
>
Defined in: sdk/components/mapsystem/MapSystemController.ts:24
Inherited from
currentMapFormatConfig
protected
readonly
currentMapFormatConfig:Subscribable
<MapFormatConfig
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:119
A subscribable for the current map format config.
isOnGround
protected
readonly
isOnGround:ConsumerSubject
<boolean
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:86
sub
protected
readonly
sub:EventSubscriber
<AirGroundDataProviderEvents
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:85
terrainWeatherStateModule
protected
readonly
terrainWeatherStateModule:MapTerrainWeatherStateModule
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:68
terrWxState
protected
readonly
terrWxState:Subscribable
<TerrWxState
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:120
A subscribable for the current terr wx state.
tfcEnabled
protected
readonly
tfcEnabled:Subscribable
<boolean
>
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:121
A subscribable for whether tfc is enabled.
weatherModule
protected
readonly
weatherModule:MapWxrModule
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:69
WX_NEXRAD_COLORS
readonly
static
WX_NEXRAD_COLORS: readonly readonly [number
,number
][]
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:99
WX_RADAR_COLORS
readonly
static
WX_RADAR_COLORS: readonly readonly [number
,number
][]
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:91
Accessors
isAlive
Get Signature
get isAlive():
boolean
Defined in: sdk/components/mapsystem/MapSystemController.ts:20
Whether this controller is alive.
Returns
boolean
Inherited from
Methods
destroy()
destroy():
void
Defined in: sdk/components/mapsystem/MapSystemController.ts:106
Destroys this controller.
Returns
void
Inherited from
getOffset()
protected
getOffset(formatConfig
):Float64Array
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:274
Sets the map target offset for the specified format.
Parameters
Parameter | Type | Description |
---|---|---|
formatConfig | MapFormatConfig | The format config to use. |
Returns
Float64Array
The target projected offset.
getRangeEndpoints()
protected
getRangeEndpoints(formatConfig
):Float64Array
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:283
Calculates the range endpoints for a given format config.
Parameters
Parameter | Type | Description |
---|---|---|
formatConfig | MapFormatConfig | The format config to use. |
Returns
Float64Array
The calculated range endpoints.
onAfterMapRender()
onAfterMapRender():
void
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:144
This method is called after this controller' map is rendered.
Returns
void
Overrides
MapSystemController
.onAfterMapRender
onAfterUpdated()
onAfterUpdated(
time
,elapsed
):void
Defined in: sdk/components/mapsystem/MapSystemController.ts:78
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
Inherited from
MapSystemController
.onAfterUpdated
onBeforeUpdated()
onBeforeUpdated(
time
,elapsed
):void
Defined in: sdk/components/mapsystem/MapSystemController.ts:68
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
Inherited from
MapSystemController
.onBeforeUpdated
onDeadZoneChanged()
onDeadZoneChanged(
deadZone
):void
Defined in: sdk/components/mapsystem/MapSystemController.ts:48
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
Inherited from
MapSystemController
.onDeadZoneChanged
onMapDestroyed()
onMapDestroyed():
void
Defined in: sdk/components/mapsystem/MapSystemController.ts:99
This method is called when this controller's map is destroyed.
Returns
void
Inherited from
MapSystemController
.onMapDestroyed
onMapProjectionChanged()
onMapProjectionChanged(
_mapProjection
,changeFlags
):void
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:136
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: sdk/components/mapsystem/MapSystemController.ts:92
This method is called when this controller's map is put to sleep.
Returns
void
Inherited from
onWake()
onWake():
void
Defined in: workingtitle-instruments-epic2/shared/Map/Controllers/MapFormatController.ts:130
This method is called when this controller's map is awakened.
Returns
void