Class: TurnToJoinGreatCircleBuilder
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:449
Builds constant-radius turns to join great-circle paths.
Constructors
Constructor
new TurnToJoinGreatCircleBuilder():
TurnToJoinGreatCircleBuilder
Returns
TurnToJoinGreatCircleBuilder
Methods
build()
Call Signature
build(
vectors
,index
,start
,startCourse
,endPath
,radius
,flags?
):1
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:468
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
Parameter | Type | Description |
---|---|---|
vectors | CircleVector [] | The flight path vector sequence to which to add the vectors. |
index | number | The index in the sequence at which to add the vectors. |
start | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | LatLonInterface | The start point. |
startCourse | number | The initial true course bearing. |
endPath | GeoCircle | The great-circle path defining the target course. |
radius | number | The radius of the turn, in meters. |
flags? | number | The 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.
Call Signature
build(
vectors
,index
,start
,startPath
,endPath
,radius
,flags?
):1
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:490
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
Parameter | Type | Description |
---|---|---|
vectors | CircleVector [] | The flight path vector sequence to which to add the vectors. |
index | number | The index in the sequence at which to add the vectors. |
start | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | LatLonInterface | The start point. |
startPath | GeoCircle | The great-circle path defining the initial course. |
endPath | GeoCircle | The great-circle path defining the target course. |
radius | number | The radius of the turn, in meters. |
flags? | number | The 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
.