Skip to main content

Class: ProcedureTurnBuilder

Builds procedure turns.

Constructors

constructor

new ProcedureTurnBuilder(): ProcedureTurnBuilder

Returns

ProcedureTurnBuilder

Methods

build

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

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

NameTypeDefault valueDescription
vectorsCircleVector[]undefinedThe flight path vector sequence to which to add the vectors.
indexnumberundefinedThe index in the sequence at which to add the vectors.
startReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterfaceundefinedThe start point.
startPathGeoCircleundefinedThe great-circle path defining the initial course.
endReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterfaceundefinedThe end point.
endPathGeoCircleundefinedThe great-circle path defining the final course.
outboundCoursenumberundefinedThe true course, in degrees, of the outbound leg of the turn.
desiredTurnRadiusnumberundefinedThe desired turn radius, in meters.
desiredTurnDirection?VectorTurnDirectionundefinedThe desired turn direction.
initialCourse?numberundefinedThe initial course. If not defined, it will be calculated from startPath and start.
finalCourse?numberundefinedThe final course. If not defined, it will be calculated from endPath and end.
flagsFlightPathVectorFlagsFlightPathVectorFlags.CourseReversalThe flags to set on the vectors. Defaults to the CourseReversal flag.
includeTurnToCourseFlagbooleantrueWhether to include the TurnToCourse flag on the turn vectors. True by default.

Returns

number

The number of vectors added to the sequence.

Defined in

src/sdk/flightplan/FlightPathVectorBuilder.ts:1531