Class: TurnToJoinGreatCircleAtPointVectorBuilder

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/TurnToJoinGreatCircleAtPointVectorBuilder.ts:14

Builds vectors representing paths connecting initial great circle paths to final great circle paths via a turn starting at the start point and a turn ending at the end point, connected by a great-circle path.

Constructors

Constructor

new TurnToJoinGreatCircleAtPointVectorBuilder(): TurnToJoinGreatCircleAtPointVectorBuilder

Returns

TurnToJoinGreatCircleAtPointVectorBuilder

Methods

build()

build(vectors, index, start, startPath, startTurnRadius, startTurnDirection, end, endPath, endTurnRadius, endTurnDirection, startTurnVectorFlags, endTurnVectorFlags, connectVectorFlags, heading, isHeadingTrue): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/TurnToJoinGreatCircleAtPointVectorBuilder.ts:44

Builds a sequence of vectors representing a path from a defined start point and initial course which turns and connects with another turn via a great-circle path to terminate at a defined end point and final course.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector array to which to add the vectors.
index	number	undefined	The index in the array at which to add the vectors.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The start point.
startPath	ReadonlyGeoCircle	undefined	A GeoCircle that defines the initial course. Must be a great circle.
startTurnRadius	number	undefined	The radius of the initial turn, in meters.
startTurnDirection	VectorTurnDirection	undefined	The direction of the initial turn.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The end point.
endPath	ReadonlyGeoCircle	undefined	A GeoCircle that defines the final course. Must be a great circle.
endTurnRadius	number	undefined	The radius of the final turn, in meters.
endTurnDirection	VectorTurnDirection	undefined	The direction of the final turn.
startTurnVectorFlags	number	0	The flags to set on the initial turn vector. Defaults to none (0).
endTurnVectorFlags	number	0	The flags to set on the final turn vector. Defaults to none (0).
connectVectorFlags	number	0	The flags to set on the vector along the great-circle path connecting the turns. Defaults to none (0).
heading	null | number	null	The heading-to-fly to assign to all built vectors, in degrees, or null if no heading is to be assigned. Defaults to null.
isHeadingTrue	boolean	false	Whether the heading-to-fly assigned to built vectors is relative to true north instead of magnetic north. Defaults to false.

Returns

number

The number of vectors that were built and added to the array.

Throws

Error if either the start or end path is not a great circle.