Class: GreatCircleBuilder
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:150
Builds great-circle paths between defined start and end points.
Constructors
Constructor
new GreatCircleBuilder():
GreatCircleBuilder
Returns
GreatCircleBuilder
Methods
build()
Call Signature
build(
vectors
,index
,start
,end
,initialCourse?
,flags?
):number
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:169
Builds a sequence of vectors representing a great-circle path between two points. The great circle path chosen is the shortest great-circle path between the two points.
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. |
end | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | LatLonInterface | The end point. |
initialCourse? | number | The initial true course bearing. Used to define a unique great-circle path when start and end are antipodal. |
flags? | number | The flags to set on the vector. Defaults to none (0). |
Returns
number
Throws
Error if start
and end
are antipodal and initialCourse
is undefined.
Call Signature
build(
vectors
,index
,start
,path
,end
,flags?
):number
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:186
Builds a sequence of vectors representing a great-circle path between two points.
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. |
path | GeoCircle | The great-circle path. |
end | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | LatLonInterface | The end point. |
flags? | number | The flags to set on the vector. Defaults to none (0). |
Returns
number
Call Signature
build(
vectors
,index
,start
,path
,distance
,flags?
):number
Defined in: src/sdk/flightplan/FlightPathVectorBuilder.ts:204
Builds a sequence of vectors representing a great-circle path between two points. The end point is chosen such that it is offset from the start point by a specified distance.
Parameters
Parameter | Type | Description |
---|---|---|
vectors | CircleVector [] | |
index | number | The index in the sequence at which to add the vectors. |
start | Readonly <Omit <Float64Array , "set" | "sort" | "copyWithin" >> | LatLonInterface | The start point. |
path | GeoCircle | The great-circle path. |
distance | number | The distance along the path between the start and end points, in meters. |
flags? | number | The flags to set on the vector. Defaults to none (0). |
Returns
number