Class: DirectToPointVectorBuilder

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/DirectToPointVectorBuilder.ts:15

Builds vectors representing paths directly connecting a defined initial point and course and a defined end point.

Constructors

Constructor

new DirectToPointVectorBuilder(): DirectToPointVectorBuilder

Returns

DirectToPointVectorBuilder

Methods

build()

Call Signature

build(vectors, index, start, startCourse, end, desiredTurnRadius, desiredTurnDirection?, flags?, includeTurnToCourseFlag?, includeDirectFlag?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/DirectToPointVectorBuilder.ts:43

Builds a sequence of vectors representing a path that consists of an optional turn from a start point and initial course toward an end point followed by an optional great-circle path terminating at the end point.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vectors.
index	number	The index in the array at which to add the vectors.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The start point.
startCourse	number	The initial true course at the start point, in degrees.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
desiredTurnRadius	number	The desired turn radius, in meters.
desiredTurnDirection?	VectorTurnDirection	The desired turn direction. If not defined, then a turn direction will be chosen such that the initial turn is always toward the end point.
flags?	number	The flags to set on all built vectors. Defaults to none (0).
includeTurnToCourseFlag?	boolean	Whether to include the TurnToCourse flag on the vectors that comprise the initial turn. Defaults to true.
includeDirectFlag?	boolean	Whether to include the Direct flag on all built vectors. Defaults to true.
heading?	null | number	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	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.

Call Signature

build(vectors, index, start, startPath, end, desiredTurnRadius, desiredTurnDirection?, flags?, includeTurnToCourseFlag?, includeDirectFlag?, heading?, isHeadingTrue?): number

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/DirectToPointVectorBuilder.ts:78

Builds a sequence of vectors representing a path that consists of an optional turn from a start point and initial course toward an end point followed by an optional great-circle path terminating at the end point.

Parameters

Parameter	Type	Description
vectors	FlightPathVector[]	The flight path vector array to which to add the vectors.
index	number	The index in the array at which to add the vectors.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The start point.
startPath	ReadonlyGeoCircle	The great-circle path defining the initial course.
end	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
desiredTurnRadius	number	The desired turn radius, in meters.
desiredTurnDirection?	VectorTurnDirection	The desired turn direction. If not defined, then a turn direction will be chosen such that the initial turn is always toward the end point.
flags?	number	The flags to set on all built vectors. Defaults to none (0).
includeTurnToCourseFlag?	boolean	Whether to include the TurnToCourse flag on the vectors that comprise the initial turn. Defaults to true.
includeDirectFlag?	boolean	Whether to include the Direct flag on all built vectors. Defaults to true.
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 added to the array.