Class: TurnToJoinGreatCircleVectorBuilder
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/TurnToJoinGreatCircleVectorBuilder.ts:13
Builds vectors representing constant-radius turns to join great-circle paths.
Constructors
Constructor
new TurnToJoinGreatCircleVectorBuilder():
TurnToJoinGreatCircleVectorBuilder
Returns
TurnToJoinGreatCircleVectorBuilder
Methods
build()
Call Signature
build(
vectors,index,start,startCourse,endPath,radius,flags?,heading?,isHeadingTrue?):1
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/TurnToJoinGreatCircleVectorBuilder.ts:36
Builds a flight path vector representing a constant-radius turn starting from a defined start point and initial course and ending at the point in the turn circle closest to a target great-circle path.
Parameters
| Parameter | Type | Description |
|---|---|---|
vectors | FlightPathVector[] | The flight path vector array to which to add the vectors. |
index | number | The index in the array at which to add the vectors. |
start | Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface | The start point. |
startCourse | number | The initial true course, in degrees. |
endPath | ReadonlyGeoCircle | A GeoCircle that defines the target path. Must be a great circle. |
radius | number | The radius of the turn, in meters. |
flags? | number | The flags to set on the built vector. Defaults to the TurnToCourse flag. |
heading? | null | number | The heading-to-fly to assign to the vector, in degrees, or null if no heading is to be assigned. Defaults to null. |
isHeadingTrue? | boolean | Whether the heading-to-fly assigned to the vector is relative to true north instead of magnetic north. Defaults to false. |
Returns
1
The number of vectors that were built and added to the array, which is always equal to 1.
Throws
Error if endPath is not a great circle.
Call Signature
build(
vectors,index,start,startPath,endPath,radius,flags?,heading?,isHeadingTrue?):1
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/TurnToJoinGreatCircleVectorBuilder.ts:64
Builds a flight path vector representing a constant-radius turn starting from a defined start point and initial course and ending at the point in the turn circle closest to a target great-circle path.
Parameters
| Parameter | Type | Description |
|---|---|---|
vectors | FlightPathVector[] | The flight path vector array to which to add the vectors. |
index | number | The index in the array at which to add the vectors. |
start | Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface | The start point. |
startPath | ReadonlyGeoCircle | A GeoCircle that defines the initial course. Must be a great circle. |
endPath | ReadonlyGeoCircle | A GeoCircle that defines the target path. Must be a great circle. |
radius | number | The radius of the turn, in meters. |
flags? | number | The flags to set on the built vector. Defaults to the TurnToCourse flag. |
heading? | null | number | The heading-to-fly to assign to the vector, in degrees, or null if no heading is to be assigned. Defaults to null. |
isHeadingTrue? | boolean | Whether the heading-to-fly assigned to the vector is relative to true north instead of magnetic north. Defaults to false. |
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.