Class: MapSystemFlightPlanLayer

Defined in: src/sdk/components/mapsystem/layers/MapSystemFlightPlanLayer.tsx:50

A map system layer that draws the flight plan.

Extends

• MapLayer<MapSystemFlightPlanLayerProps>

Constructors

Constructor

new MapSystemFlightPlanLayer(props): MapSystemFlightPlanLayer

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	MapSystemFlightPlanLayerProps	The propertis of the component.

Returns

MapSystemFlightPlanLayer

Inherited from

MapLayer.constructor

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

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

MapLayer.context

---

contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

MapLayer.contextType

---

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

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

MapLayer.props

---

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()

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

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

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

Parameters

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

Returns

Promise<void>

---

buildPlanWaypoint()

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

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

Builds or refreshes a flight plan waypoint.

Parameters

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

Returns

Promise<void>

---

buildTerminatorWaypoint()

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

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

Builds a flight path terminator based waypoint.

Parameters

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

Returns

Promise<void>

---

destroy()

destroy(): void

Defined in: src/sdk/components/FSComponent.ts:98

Destroys this component.

Returns

void

Inherited from

MapLayer.destroy

---

getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

initWaypointRenderer()

protected initWaypointRenderer(): void

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

Initializes the waypoint renderer for this layer.

Returns

void

---

isVisible()

isVisible(): boolean

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

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

---

onAfterRender()

onAfterRender(node): void

Defined in: src/sdk/components/FSComponent.ts:87

A callback that is called after the component is rendered.

Parameters

Parameter	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

---

onAttached()

onAttached(): void

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

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

Returns

void

Overrides

MapLayer.onAttached

---

onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender

---

onDetached()

onDetached(): void

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

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

Returns

void

Inherited from

MapLayer.onDetached

---

onMapProjectionChanged()

onMapProjectionChanged(mapProjection, changeFlags): void

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

This method is called when the map projection changes.

Parameters

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

Returns

void

Overrides

MapLayer.onMapProjectionChanged

---

onSleep()

onSleep(): void

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

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

Returns

void

Inherited from

MapLayer.onSleep

---

onUpdated()

onUpdated(time, elapsed): void

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

This method is called once every map update cycle.

Parameters

Parameter	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

---

onVisibilityChanged()

onVisibilityChanged(isVisible): void

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

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

Parameters

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

Returns

void

Inherited from

MapLayer.onVisibilityChanged

---

onWake()

onWake(): void

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

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

Returns

void

Inherited from

MapLayer.onWake

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

---

setVisible()

setVisible(val): void

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

Sets this layer's visibility.

Parameters

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

Returns

void

Overrides

MapLayer.setVisible

---

updateWaypoints()

protected updateWaypoints(): Promise<void>

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

Updates waypoints for the flight plan.

Returns

Promise<void>

Throws

An error if the waypoints are already updating.