Class: ConnectCirclesVectorBuilder
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/ConnectCirclesVectorBuilder.ts:15
Builds vectors representing paths that connect two geo circles.
Constructors
Constructor
new ConnectCirclesVectorBuilder():
ConnectCirclesVectorBuilder
Returns
ConnectCirclesVectorBuilder
Methods
build()
build(
vectors,index,fromCircle,toCircle,radius?,from?,to?,fromCircleVectorFlags?,toCircleVectorFlags?,connectVectorFlags?,heading?,isHeadingTrue?):number
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/ConnectCirclesVectorBuilder.ts:46
Builds a sequence of vectors representing a path which consists of a single geo circle which connects two other circles and optionally paths to link the connecting circle with a start point on the from circle and an end point on the to circle.
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
vectors | FlightPathVector[] | undefined | The flight path vector array to which to add the vectors. |
index | number | undefined | The index in the array at which to add the vectors. |
fromCircle | ReadonlyGeoCircle | undefined | The circle from which to add the connecting circle. |
toCircle | ReadonlyGeoCircle | undefined | The circle to which to add the connecting circle. |
radius? | number | undefined | The radius, in meters, of the circle to join the two circles. If not defined, defaults to pi / 2 times the radius of the Earth (and therefore the connecting circle will be a great circle). |
from? | Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface | undefined | The starting point along fromCircle. If not defined, this will be assumed to be equal to the point where the connecting circle meets fromCircle. |
to? | Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface | undefined | The ending point along toCircle. If not defined, this will be assumed to be equal to the point where the connecting circle meets toCircle. |
fromCircleVectorFlags? | number | 0 | The flags to set on the vector along fromCircle. Defaults to none (0). |
toCircleVectorFlags? | number | 0 | The flags to set on the vector along the toCircle. Defaults to none (0). |
connectVectorFlags? | number | 0 | The flags to set on the vector connecting fromCircle to toCircle. Defaults to none (0). |
heading? | null | number | null | The heading-to-fly to assign to all built vectors, in degrees, or null if no heading is to be assigned. Defaults to null. |
isHeadingTrue? | boolean | false | Whether the heading-to-fly assigned to built vectors is relative to true north instead of magnetic north. Defaults to false. |
Returns
number
The number of vectors that were built and added to the array.