Skip to main content

Type Alias: FlightPathCalculatorInitOptions

FlightPathCalculatorInitOptions = FlightPathCalculatorOptions & object

Defined in: src/sdk/flightplan/flightpath/FlightPathCalculator.ts:142

Options with which to initialize a FlightPathCalculator.

Type Declaration​

anticipatedDataCalculator?​

optional anticipatedDataCalculator: FlightPathAnticipatedDataCalculator

A calculator that provides anticipated per-flight plan leg data to be used by the flight path calculator. If not defined, then anticipated data will not be used.

calculateDiscontinuityVectors?​

optional calculateDiscontinuityVectors: boolean

Whether to calculate flight path vectors to span discontinuities in the flight path. If true, then the calculated discontinuity vectors will have the Discontinuity flag applied to them. Defaults to false.

dataProvider?​

optional dataProvider: FlightPathCalculatorDataProvider

A provider of data for the calculator. If not defined, then a default data provider will be created and used that sources data from SimVars.

id?​

optional id: string

The ID of the flight path calculator. Defaults to the empty string ('').

initSyncRole?​

optional initSyncRole: "none" | "primary" | "replica"

The calculator's initialization sync role. Upon instantiation, a primary calculator will broadcast an initialization sync event through the event bus which allows existing replica calculators with the same ID to sync their state with the primary. Upon instantiation, replica calculators will attempt to sync their state with any existing primary calculators with the same ID. A calculators with a sync role of none will neither try to broadcast its state to replica calculators nor try to sync its state with primary calculators. Defaults to none.

useGreatCirclePathForDiscontinuity?​

optional useGreatCirclePathForDiscontinuity: boolean

Whether to calculate strictly great-circle paths to span discontinuities in the flight path. If true, then any discontinuity-spanning path will always be the shortest great-circle path between the two ends of the discontinuity. If false, then the discontinuity-spanning path will be calculated in a manner that smoothly joins the two ends the discontinuity, if possible. Ignored if calculateDiscontinuityVectors is false. Defaults to false.