Class: DirectToPointBuilder

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

Constructors

constructor

• new DirectToPointBuilder(): DirectToPointBuilder

Returns

DirectToPointBuilder

Methods

build

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

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

Parameters

Name	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.
startCourse	number	The initial course.
end	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
desiredTurnRadius	number	The desired turn radius, in meters.
desiredTurnDirection?	VectorTurnDirection	The desired turn direction. If undefined, a turn direction will be chosen such that the initial turn is always toward the end point.
flags?	number	The flags to set on the vectors. Defaults to none (0).
includeTurnToCourseFlag?	boolean	Whether to include the TurnToCourse flag on the turn vectors. Defaults to true.
includeDirectFlag?	boolean	Whether to include the Direct flag on the vectors. Defaults to true.

Returns

number

The number of vectors added to the sequence.

Defined in

src/sdk/flightplan/FlightPathVectorBuilder.ts:1781

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

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

Parameters

Name	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.
startPath	GeoCircle	The great-circle path defining the initial course.
end	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | LatLonInterface	The end point.
desiredTurnRadius	number	The desired turn radius, in meters.
desiredTurnDirection?	VectorTurnDirection	The desired turn direction. If undefined, a turn direction will be chosen such that the initial turn is always toward the end point.
flags?	number	The flags to set on the vectors. Defaults to none (0).
includeTurnToCourseFlag?	boolean	Whether to include the TurnToCourse flag on the turn vectors. Defaults to true.
includeDirectFlag?	boolean	Whether to include the Direct flag on the vectors. Defaults to true.

Returns

number

The number of vectors added to the sequence.

Defined in

src/sdk/flightplan/FlightPathVectorBuilder.ts:1809