Class: MapSystemFlightPlanLayer

A map system layer that draws the flight plan.

Hierarchy

• MapLayer<MapSystemFlightPlanLayerProps>

  ↳ MapSystemFlightPlanLayer

Constructors

constructor

• new MapSystemFlightPlanLayer(props): MapSystemFlightPlanLayer

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	MapSystemFlightPlanLayerProps	The propertis of the component.

Returns

MapSystemFlightPlanLayer

Inherited from

MapLayer.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

clipBounds

• Protected Readonly clipBounds: VecNSubject

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:73

---

clippedPathStream

• Protected Readonly clippedPathStream: ClippedPathStream

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:74

---

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapLayer.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

MapLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

defaultRoleId

• Protected Readonly defaultRoleId: number

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:62

---

facLoader

• Protected Readonly facLoader: FacilityLoader

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:70

---

facWaypointCache

• Protected Readonly facWaypointCache: FacilityWaypointCache

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:71

---

flightPathLayerRef

• Protected Readonly flightPathLayerRef: NodeReference<MapCachedCanvasLayer<MapCachedCanvasLayerProps<any>>>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:59

---

instanceId

• Protected Readonly instanceId: number

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:57

---

legWaypoints

• Protected Readonly legWaypoints: Map<LegDefinition, [Waypoint, number]>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:66

---

pathStreamStack

• Protected Readonly pathStreamStack: GeoProjectionPathStreamStack

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:75

---

planModule

• Protected Readonly planModule: MapFlightPlanModule

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:63

---

props

• props: MapSystemFlightPlanLayerProps & ComponentProps

The properties of the component.

Inherited from

MapLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

---

updateScheduled

• Protected updateScheduled: boolean = false

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:77

---

waypointId

• Protected waypointId: number = 0

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:68

---

waypointLayerRef

• Protected Readonly waypointLayerRef: NodeReference<MapSyncedCanvasLayer<MapCanvasLayerProps<any>>>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:60

---

waypointPrefix

• Protected Readonly waypointPrefix: string

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:65

---

waypointsUpdating

• Protected waypointsUpdating: boolean = false

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:67

Methods

buildFixWaypoint

▸ buildFixWaypoint(leg, roleId): Promise<void>

Builds a standard facility fix waypoint for flight plan waypoint display.

Parameters

Name	Type	Description
leg	LegDefinition	The leg to build the waypoint for.
roleId	number	The role ID to assign to the waypoint.

Returns

Promise<void>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:317

---

buildPlanWaypoint

▸ buildPlanWaypoint(leg, roleId): Promise<void>

Builds or refreshes a flight plan waypoint.

Parameters

Name	Type	Description
leg	LegDefinition	The leg to build the waypoint for.
roleId	number	The role ID to assign to the waypoint.

Returns

Promise<void>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:245

---

buildTerminatorWaypoint

▸ buildTerminatorWaypoint(leg, roleId): Promise<void>

Builds a flight path terminator based waypoint.

Parameters

Name	Type	Description
leg	LegDefinition	The leg to build the waypoint for.
roleId	number	The role ID to assign to the waypoint.

Returns

Promise<void>

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:276

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Inherited from

MapLayer.destroy

Defined in

src/sdk/components/FSComponent.ts:98

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

MapLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

initWaypointRenderer

▸ initWaypointRenderer(): void

Initializes the waypoint renderer for this layer.

Returns

void

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:101

---

isVisible

▸ isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

Defined in

src/sdk/components/map/MapLayer.ts:38

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onAttached

▸ onAttached(): void

This method is called when this layer is attached to its parent map component.

Returns

void

Overrides

MapLayer.onAttached

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:80

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onDetached

▸ onDetached(): void

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapLayer.onDetached

Defined in

src/sdk/components/map/MapLayer.ts:108

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

This method is called when the map projection changes.

Parameters

Name	Type	Description
mapProjection	MapProjection	this layer's map projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

Overrides

MapLayer.onMapProjectionChanged

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:155

---

onSleep

▸ onSleep(): void

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapLayer.onSleep

Defined in

src/sdk/components/map/MapLayer.ts:81

---

onUpdated

▸ onUpdated(time, elapsed): void

This method is called once every map update cycle.

Parameters

Name	Type	Description
time	number	The current time as a UNIX timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Overrides

MapLayer.onUpdated

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:122

---

onVisibilityChanged

▸ onVisibilityChanged(isVisible): void

This method is called when this layer's visibility changes.

Parameters

Name	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Inherited from

MapLayer.onVisibilityChanged

Defined in

src/sdk/components/map/MapLayer.ts:60

---

onWake

▸ onWake(): void

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapLayer.onWake

Defined in

src/sdk/components/map/MapLayer.ts:74

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:347

---

setVisible

▸ setVisible(val): void

Sets this layer's visibility.

Parameters

Name	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Overrides

MapLayer.setVisible

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:169

---

updateWaypoints

▸ updateWaypoints(): Promise<void>

Updates waypoints for the flight plan.

Returns

Promise<void>

Throws

An error if the waypoints are already updating.

Defined in

src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:179