Class: ConnectCirclesBuilder
Builds paths to connect two geo circles.
Constructors
constructor
• new ConnectCirclesBuilder(): ConnectCirclesBuilder
Returns
Methods
build
▸ build(vectors, index, fromCircle, toCircle, radius?, from?, to?, fromCircleVectorFlags?, toCircleVectorFlags?, connectVectorFlags?): number
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
| Name | Type | Default value | Description |
|---|---|---|---|
vectors | CircleVector[] | undefined | The flight path vector sequence to which to add the vectors. |
index | number | undefined | The index in the sequence at which to add the vectors. |
fromCircle | GeoCircle | undefined | The circle from which to add the connecting circle. |
toCircle | GeoCircle | 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, "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, "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). |
Returns
number
The number of vectors added to the sequence.
Defined in
src/sdk/flightplan/FlightPathVectorBuilder.ts:592