Skip to main content

Class: TurnToJoinGreatCircleBuilder

Builds constant-radius turns to join great-circle paths.

Constructors

constructor

new TurnToJoinGreatCircleBuilder(): TurnToJoinGreatCircleBuilder

Returns

TurnToJoinGreatCircleBuilder

Methods

build

build(vectors, index, start, startCourse, endPath, radius, flags?): 1

Builds an arc representing a turn from a defined start point and initial course toward a defined target great- circle path, ending at the point in the turn circle which is closest to the target path.

Parameters

NameTypeDescription
vectorsCircleVector[]The flight path vector sequence to which to add the vectors.
indexnumberThe index in the sequence at which to add the vectors.
startReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterfaceThe start point.
startCoursenumberThe initial true course bearing.
endPathGeoCircleThe great-circle path defining the target course.
radiusnumberThe radius of the turn, in meters.
flags?numberThe flags to set on the turn vector. Defaults to the TurnToCourse flag.

Returns

1

The number of vectors added to the sequence, which is always equal to 1.

Throws

Error if endPath is not a great circle.

Defined in

src/sdk/flightplan/FlightPathVectorBuilder.ts:468

build(vectors, index, start, startPath, endPath, radius, flags?): 1

Builds an arc representing a turn from a defined start point and initial course toward a defined target great- circle path, ending at the point in the turn circle which is closest to the target path.

Parameters

NameTypeDescription
vectorsCircleVector[]The flight path vector sequence to which to add the vectors.
indexnumberThe index in the sequence at which to add the vectors.
startReadonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterfaceThe start point.
startPathGeoCircleThe great-circle path defining the initial course.
endPathGeoCircleThe great-circle path defining the target course.
radiusnumberThe radius of the turn, in meters.
flags?numberThe flags to set on the turn vector. Defaults to the TurnToCourse flag.

Returns

1

The number of vectors added to the sequence, which is always equal to 1.

Throws

Error if startPath or endPath is not a great circle, or if start does not lie on startPath.

Defined in

src/sdk/flightplan/FlightPathVectorBuilder.ts:490