Class: AbstractFlightPathPlanRenderer<Args>
Renders flight plan paths one leg at a time in either forward or reverse order. Optionally forces the rendering of the active flight plan leg to be last.
Type parameters
Name | Type |
---|---|
Args | extends any [] = [] |
Hierarchy
AbstractFlightPathPlanRenderer
Constructors
constructor
• new AbstractFlightPathPlanRenderer<Args
>(renderOrder?
, renderActiveLegLast?
): AbstractFlightPathPlanRenderer
<Args
>
Constructor.
Type parameters
Name | Type |
---|---|
Args | extends any [] = [] |
Parameters
Name | Type | Default value | Description |
---|---|---|---|
renderOrder | FlightPathPlanRenderOrder | 'forward' | The order which this renderer renders the flight plan legs. Forward order renders the legs in a first-to-last fashion. Reverse order renders the legs in a last-to-first fashion. Defaults to forward. |
renderActiveLegLast | boolean | true | Whether to render the active leg last. Defaults to true. |
Returns
AbstractFlightPathPlanRenderer
<Args
>
Defined in
src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:20
Properties
renderActiveLegLast
• Protected
Readonly
renderActiveLegLast: boolean
= true
Whether to render the active leg last. Defaults to true.
Defined in
src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:20
renderOrder
• Protected
Readonly
renderOrder: FlightPathPlanRenderOrder
= 'forward'
The order which this renderer renders the flight plan legs. Forward order renders the legs in a first-to-last fashion. Reverse order renders the legs in a last-to-first fashion. Defaults to forward.
Defined in
src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:20
Methods
render
▸ render(plan
, startIndex
, endIndex
, context
, streamStack
, ...args
): void
Renders a flight plan path to a canvas.
Parameters
Name | Type | Description |
---|---|---|
plan | FlightPlan | The flight plan to render. |
startIndex | undefined | number | The global index of the first flight plan leg to render, inclusive. Defaults to 0 . |
endIndex | undefined | number | The global index of the last flight plan leg to render, inclusive. Defaults to plan.length - 1 . |
context | CanvasRenderingContext2D | The canvas 2D rendering context to which to render. |
streamStack | GeoProjectionPathStreamStack | The path stream stack to which to render. |
...args | Args | Additional arguments. |
Returns
void
Defined in
src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:32
renderLeg
▸ renderLeg(leg
, plan
, activeLeg
, legIndex
, activeLegIndex
, context
, streamStack
, ...args
): void
Renders a flight plan leg.
Parameters
Name | Type | Description |
---|---|---|
leg | LegDefinition | The flight plan leg to render. |
plan | FlightPlan | The flight plan containing the leg to render. |
activeLeg | undefined | LegDefinition | The active leg in the flight plan. |
legIndex | number | The global index of the leg in its flight plan. |
activeLegIndex | number | The global index of the active flight plan leg. |
context | CanvasRenderingContext2D | The canvas 2D rendering context to which to render. |
streamStack | GeoProjectionPathStreamStack | The path stream stack to which to render. |
...args | Args | - |
Returns
void
Defined in
src/sdk/components/map/AbstractFlightPathPlanRenderer.ts:87