Class: ProcedureTurnVectorBuilder

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/ProcedureTurnVectorBuilder.ts:16

Builds vectors representing procedure turn paths.

Constructors

Constructor

new ProcedureTurnVectorBuilder(): ProcedureTurnVectorBuilder

Returns

ProcedureTurnVectorBuilder

Methods

build()

build(vectors, index, start, startPath, end, endPath, outboundCourse, desiredTurnRadius, desiredTurnDirection?, initialCourse?, finalCourse?, flags?, includeTurnToCourseFlag?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/ProcedureTurnVectorBuilder.ts:52

Builds a sequence of vectors representing a procedure turn from a defined starting point and initial course to a defined end point and final course. A procedure turn begins with a variable-length leg from the start point along the initial course followed by an initial turn to intercept the outbound leg of the procedure turn, then a variable-length outbound leg, a 180-degree turn, a variable-length inbound leg, and finally a turn to intercept the final course at the end point. If a full set of vectors cannot be computed given the restraints imposed by the path geometry and the desired turn radius, parts of the turn beginning with the inbound leg of the procedure turn may be altered or omitted entirely.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector sequence to which to add the vectors.
index	number	undefined	The index in the sequence 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.
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.
outboundCourse	number	undefined	The true course, in degrees, of the outbound leg of the turn.
desiredTurnRadius	number	undefined	The desired turn radius, in meters.
desiredTurnDirection?	VectorTurnDirection	undefined	The desired turn direction.
initialCourse?	number	undefined	The initial course. If not defined, it will be calculated from startPath and start.
finalCourse?	number	undefined	The final course. If not defined, it will be calculated from endPath and end.
flags?	FlightPathVectorFlags	FlightPathVectorFlags.CourseReversal	The flags to set on all built vectors. Defaults to the CourseReversal flag.
includeTurnToCourseFlag?	boolean	true	Whether to include the TurnToCourse flag on the turn vectors. Defaults to true.
heading?	number | null	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.