Class: PlanFormatController
A controller that handles map range settings.
Hierarchy
MapSystemController<PlanFormatControllerModules,any,any,PlanFormatControllerContext>↳
PlanFormatController
Constructors
constructor
• new PlanFormatController(context, pfdOrMfd, displayIndex, flightPlanner): PlanFormatController
Creates an instance of the PlanFormatController.
Parameters
| Name | 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 | 2 | 1 | The index of the display, 1 or 2. |
flightPlanner | FlightPlanner<any> | The flight planner to use with this controller. |
Returns
Overrides
MapSystemController\<PlanFormatControllerModules, any, any, PlanFormatControllerContext\>.constructor
Defined in
workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:83
Properties
context
• Protected Readonly context: MapSystemContext<PlanFormatControllerModules, any, any, PlanFormatControllerContext>
Inherited from
MapSystemController.context
Defined in
sdk/components/mapsystem/MapSystemController.ts:24
Accessors
isAlive
• get isAlive(): boolean
Whether this controller is alive.
Returns
boolean
Inherited from
MapSystemController.isAlive
Defined in
sdk/components/mapsystem/MapSystemController.ts:20
Methods
destroy
▸ destroy(): void
Destroys this controller.
Returns
void
Inherited from
MapSystemController.destroy
Defined in
sdk/components/mapsystem/MapSystemController.ts:106
findFocusableLeg
▸ findFocusableLeg(plan, maxIndex, direction): LegDefinition
Tries to find a valid leg to focus based on the given search direction and proposed focus index.
Parameters
| Name | 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.
Defined in
workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:256
onAfterMapRender
▸ onAfterMapRender(): void
Returns
void
Inherit Doc
Overrides
MapSystemController.onAfterMapRender
Defined in
workingtitle-instruments-wt21/shared/Map/PlanFormatController.ts:96
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
Inherited from
MapSystemController.onAfterUpdated
Defined in
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
| 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
Inherited from
MapSystemController.onBeforeUpdated
Defined in
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
| Name | Type | Description |
|---|---|---|
deadZone | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The map's new dead zone. |
Returns
void
Inherited from
MapSystemController.onDeadZoneChanged
Defined in
sdk/components/mapsystem/MapSystemController.ts:48
onMapDestroyed
▸ onMapDestroyed(): void
This method is called when this controller's map is destroyed.
Returns
void
Inherited from
MapSystemController.onMapDestroyed
Defined in
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
| Name | Type | Description |
|---|---|---|
mapProjection | MapProjection | The map projection. |
changeFlags | number | Bit flags describing the type of change. |
Returns
void
Inherited from
MapSystemController.onMapProjectionChanged
Defined in
sdk/components/mapsystem/MapSystemController.ts:58
onSleep
▸ onSleep(): void
This method is called when this controller's map is put to sleep.
Returns
void
Inherited from
MapSystemController.onSleep
Defined in
sdk/components/mapsystem/MapSystemController.ts:92
onWake
▸ onWake(): void
This method is called when this controller's map is awakened.
Returns
void
Inherited from
MapSystemController.onWake
Defined in
sdk/components/mapsystem/MapSystemController.ts:85