Class: CircleVectorBuilder

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:14

Builds flight path vectors from simple GeoCircle paths.

Constructors

Constructor

new CircleVectorBuilder(): CircleVectorBuilder

Returns

CircleVectorBuilder

Methods

build()

build(vectors, index, circle, start, end, flags, heading, isHeadingTrue): 1

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:33

Builds a flight path vector from a GeoCircle.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector array to which to add the vector.
index	number	undefined	The index in the array at which to add the vector.
circle	ReadonlyGeoCircle	undefined	The circle which defines the vector path.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The start point.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The end point.
flags	number	0	The flags to set on the vector. Defaults to none (0).
heading	null | number	null	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	false	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.

---

buildGreatCircle()

Call Signature

buildGreatCircle(vectors, index, start, end, defaultCourse?, flags?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:64

Builds a flight path vector from a great-circle path between two points.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vector.
index	number	The index in the array at which to add the vector.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The start point.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
defaultCourse?	number	A default course to use to define a path when the start and end points are coincident or antipodal. If the default course is positive, then it will define the path's initial bearing at the start point. If the default course is negative, then its negative will define the path's final bearing at the end point. If not defined, then no vector will be built for coincident or antipodal start and end points.
flags?	number	The flags to set on the vector. Defaults to none (0).
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

number

The number of vectors that were built and added to the array.

Call Signature

buildGreatCircle(vectors, index, start, initialCourse, distance, flags?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:89

Builds a flight path vector from a great-circle path originating at a point and initial course and ending after a given distance.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vector.
index	number	The index in the array at which to add the vector.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The start point.
initialCourse	number	The initial true course (bearing) of the path as measured at the start point, in degrees.
distance	number	The distance of the path, in great-arc radians.
flags?	number	The flags to set on the vector. Defaults to none (0).
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

number

The number of vectors that were built and added to the array.

Call Signature

buildGreatCircle(vectors, index, start, initialCourse, end, flags?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:114

Builds a flight path vector from a great-circle path originating at a point and initial course and ending at another point.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vector.
index	number	The index in the array at which to add the vector.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The start point.
initialCourse	number	The initial true course (bearing) of the path as measured at the start point, in degrees.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
flags?	number	The flags to set on the vector. Defaults to none (0).
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

number

The number of vectors that were built and added to the array.

---

buildTurn()

buildTurn(vectors, index, turnRadius, turnDirection, center, start, end, flags, heading, isHeadingTrue): 1

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:236

Builds a flight path vector from a path representing a constant-radius turn.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector array to which to add the vector.
index	number	undefined	The index in the array at which to add the vector.
turnRadius	number	undefined	The radius of the turn, in meters.
turnDirection	VectorTurnDirection	undefined	The direction of the turn.
center	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The center of the turn.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The start point.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The end point.
flags	number	0	The flags to set on the vector. Defaults to none (0).
heading	null | number	null	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	false	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.

---

buildTurnToCourse()

buildTurnToCourse(vectors, index, start, turnRadius, turnDirection, fromCourse, toCourse, flags, heading, isHeadingTrue): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleVectorBuilder.ts:274

Builds a flight path vector representing a constant-radius turn from a defined start point and initial course toward a defined final course.

Parameters

Parameter	Type	Default value	Description
vectors	FlightPathVector[]	undefined	The flight path vector array to which to add the vector.
index	number	undefined	The index in the array at which to add the vector.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The start point.
turnRadius	number	undefined	The radius of the turn, in meters.
turnDirection	VectorTurnDirection	undefined	The direction of the turn.
fromCourse	number	undefined	The initial true course at the start of the turn, in degrees.
toCourse	number	undefined	The final true course at the end of the turn, in degrees.
flags	number	0	The flags to set on the vector. Defaults to none (0).
heading	null | number	null	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	false	Whether the heading-to-fly assigned to the vector 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.