Class: ArcToFixLegCalculator
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:557
Calculates flight path vectors for arc to fix legs.
Extends
Constructors
Constructor
new ArcToFixLegCalculator(
facilityCache
):ArcToFixLegCalculator
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:460
Constructor.
Parameters
Parameter | Type | Description |
---|---|---|
facilityCache | Map <string , Facility > | This calculator's cache of facilities. |
Returns
ArcToFixLegCalculator
Inherited from
TurnToFixLegCalculator
.constructor
Properties
circleVectorBuilder
protected
readonly
circleVectorBuilder:CircleVectorBuilder
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:454
Inherited from
TurnToFixLegCalculator
.circleVectorBuilder
facilityCache
protected
readonly
facilityCache:Map
<string
,Facility
>
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:43
This calculator's cache of facilities.
Inherited from
TurnToFixLegCalculator
.facilityCache
geoCircleCache
protected
readonly
geoCircleCache:GeoCircle
[]
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:452
Inherited from
TurnToFixLegCalculator
.geoCircleCache
geoPointCache
protected
readonly
geoPointCache:GeoPoint
[]
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:451
Inherited from
TurnToFixLegCalculator
.geoPointCache
skipWhenActive
protected
readonly
skipWhenActive:boolean
=false
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:43
Whether this calculator will skip calculations for active legs when the leg has already been calculated. False by default.
Inherited from
TurnToFixLegCalculator
.skipWhenActive
vec3Cache
protected
readonly
vec3Cache:Float64Array
[]
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:450
Inherited from
TurnToFixLegCalculator
.vec3Cache
Methods
calculate()
calculate(
legs
,calculateIndex
,activeLegIndex
,state
,resolveIngressToEgress
):LegCalculations
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:109
Calculates flight path vectors for a flight plan leg and adds the calculations to the leg.
Parameters
Parameter | Type | Default value | Description |
---|---|---|---|
legs | LegDefinition [] | undefined | A sequence of flight plan legs. |
calculateIndex | number | undefined | The index of the leg to calculate. |
activeLegIndex | number | undefined | The index of the active leg. |
state | FlightPathState | undefined | The current flight path state. |
resolveIngressToEgress | boolean | true | - |
Returns
The flight plan leg calculations.
Inherited from
TurnToFixLegCalculator
.calculate
calculateMagVar()
protected
calculateMagVar(legs
,calculateIndex
):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:465
Calculates the magnetic variation for a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
legs | LegDefinition [] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
Returns
void
The number of vectors added to the sequence.
Inherited from
TurnToFixLegCalculator
.calculateMagVar
calculateVectors()
protected
calculateVectors(legs
,calculateIndex
,activeLegIndex
,state
):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:477
Calculates flight path vectors for a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
legs | LegDefinition [] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
activeLegIndex | number | The index of the active leg. |
state | FlightPathState | The current flight path state. |
Returns
void
The number of vectors added to the sequence.
Inherited from
TurnToFixLegCalculator
.calculateVectors
getLegMagVar()
protected
getLegMagVar(leg
,point
):number
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:81
Gets the magnetic variation, in degrees, to use when calculating a flight plan leg's course. If the leg defines an origin or fix VOR facility, then the magnetic variation defined at the VOR is used. Otherwise the computed magnetic variation for the specified point is used.
Parameters
Parameter | Type | Description |
---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
point | LatLonInterface | The location from which to get magnetic variation, if an origin VOR is not found. |
Returns
number
The magnetic variation, in degrees, to use when calculating the specified flight plan leg's course.
Inherited from
TurnToFixLegCalculator
.getLegMagVar
getLegTrueCourse()
protected
getLegTrueCourse(leg
,point
):number
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:100
Gets the true course, in degrees, for a flight plan leg. If the leg defines an origin or fix VOR facility, then the magnetic variation defined at the VOR is used to adjust magnetic course. Otherwise the computed magnetic variation for the specified point is used.
Parameters
Parameter | Type | Description |
---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
point | LatLonInterface | The location from which to get magnetic variation, if an origin VOR is not found. |
Returns
number
The true course, in degrees, for the flight plan leg.
Inherited from
TurnToFixLegCalculator
.getLegTrueCourse
getPositionFromIcao()
protected
getPositionFromIcao(icao
,out
):undefined
|GeoPoint
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:52
Gets a geographical position from an ICAO string.
Parameters
Parameter | Type | Description |
---|---|---|
icao | string | An ICAO string. |
out | GeoPoint | A GeoPoint object to which to write the result. |
Returns
undefined
| GeoPoint
The geographical position corresponding to the ICAO string, or undefined if one could not be obtained.
Inherited from
TurnToFixLegCalculator
.getPositionFromIcao
getTerminatorPosition()
protected
getTerminatorPosition(leg
,icao
,out
):undefined
|GeoPoint
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:64
Gets the geographic position for a flight plan leg terminator.
Parameters
Parameter | Type | Description |
---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
icao | string | The ICAO string of the leg's terminator fix. |
out | GeoPoint | A GeoPoint object to which to write the result. |
Returns
undefined
| GeoPoint
The position of the leg terminator, or undefined if it could not be determined.
Inherited from
TurnToFixLegCalculator
.getTerminatorPosition
getTurnCenter()
protected
getTurnCenter(leg
):undefined
|LatLonInterface
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:559
Gets the center of the turn defined by a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
Returns
undefined
| LatLonInterface
The center of the turn defined by the flight plan leg, or undefined if it could not be determined.
Overrides
TurnToFixLegCalculator
.getTurnCenter
getTurnRadius()
protected
getTurnRadius(leg
,center
):undefined
|number
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:565
Gets the radius of the turn defined by a flight plan leg.
Parameters
Parameter | Type | Description |
---|---|---|
leg | FlightPlanLeg | A flight plan leg. |
center | LatLonInterface | The center of the turn. |
Returns
undefined
| number
The radius of the turn defined by the flight plan leg, or undefined if it could not be determined.
Overrides
TurnToFixLegCalculator
.getTurnRadius
resolveIngressToEgress()
protected
resolveIngressToEgress(legCalc
):void
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:207
Calculates the ingress to egress vectors for a flight plan leg and adds them to a leg calculation.
Parameters
Parameter | Type | Description |
---|---|---|
legCalc | LegCalculations | The calculations for a flight plan leg. |
Returns
void
Inherited from
TurnToFixLegCalculator
.resolveIngressToEgress
shouldSkipWhenActive()
protected
shouldSkipWhenActive(legs
,calculateIndex
,activeLegIndex
,state
):boolean
Defined in: src/sdk/flightplan/FlightPathLegCalculator.ts:178
Checks whether vector calculations should be skipped when the leg to calculate is the active leg.
Parameters
Parameter | Type | Description |
---|---|---|
legs | LegDefinition [] | A sequence of flight plan legs. |
calculateIndex | number | The index of the leg to calculate. |
activeLegIndex | number | The index of the active leg. |
state | FlightPathState | The current flight path state. |
Returns
boolean
Whether to skip vector calculations.