Class: PlanFormatController
Defined in: workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:35
A controller that handles map range settings.
Extends
MapSystemController
<PlanFormatControllerModules
,any
,any
,PlanFormatControllerContext
>
Constructors
Constructor
new PlanFormatController(
context
,pfdOrMfd
,displayIndex
,flightPlanner
):PlanFormatController
Defined in: workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:83
Creates an instance of the PlanFormatController.
Parameters
Parameter | Type | Description |
---|---|---|
context | MapSystemContext <any , any , any , PlanFormatControllerContext > | The map system context to use with this controller. |
pfdOrMfd | PfdOrMfd | Whether or not the map is on the PFD or MFD. |
displayIndex | 1 | 2 | The index of the display, 1 or 2. |
flightPlanner | FlightPlanner | The flight planner to use with this controller. |
Returns
PlanFormatController
Overrides
MapSystemController<PlanFormatControllerModules, any, any, PlanFormatControllerContext>.constructor
Properties
context
protected
readonly
context:MapSystemContext
<PlanFormatControllerModules
,any
,any
,PlanFormatControllerContext
>
Defined in: sdk/components/mapsystem/MapSystemController.ts:24
Inherited from
MapSystemController.context
Accessors
isAlive
Get Signature
get isAlive():
boolean
Defined in: sdk/components/mapsystem/MapSystemController.ts:20
Whether this controller is alive.
Returns
boolean
Inherited from
MapSystemController.isAlive
Methods
destroy()
destroy():
void
Defined in: sdk/components/mapsystem/MapSystemController.ts:106
Destroys this controller.
Returns
void
Inherited from
MapSystemController.destroy
findFocusableLeg()
findFocusableLeg(
plan
,maxIndex
,direction
):LegDefinition
Defined in: workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:256
Tries to find a valid leg to focus based on the given search direction and proposed focus index.
Parameters
Parameter | Type | Description |
---|---|---|
plan | FlightPlan | The plan to search. |
maxIndex | number | The maximum index to search. |
direction | SearchDirectionVector | The search direction. |
Returns
LegDefinition
The leg to focus.
onAfterMapRender()
onAfterMapRender():
void
Defined in: workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:96
Returns
void
Inherit Doc
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: sdk/components/mapsystem/MapSystemController.ts:58
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
Inherited from
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
MapSystemController.onSleep
onWake()
onWake():
void
Defined in: sdk/components/mapsystem/MapSystemController.ts:85
This method is called when this controller's map is awakened.
Returns
void
Inherited from
MapSystemController.onWake