Class: InterceptCircleToPointVectorBuilder

Defined in: src/sdk/flightplan/flightpath/vectorbuilders/InterceptCircleToPointVectorBuilder.ts:56

Builds vectors representing paths connecting initial great-circle paths to final paths via a turn starting at the start point followed by a path that intercepts the final path at a certain angle.

Constructors

Constructor

new InterceptCircleToPointVectorBuilder(): InterceptCircleToPointVectorBuilder

Returns

InterceptCircleToPointVectorBuilder

Methods

build()

build(vectors, index, start, startPath, startTurnRadius, startTurnDirection, interceptAngle, endPath, end?, maxInterceptDistanceFromEnd?, endTurnRadius?, startTurnVectorFlags?, interceptVectorFlags?, endTurnVectorFlags?, heading?, isHeadingTrue?): number

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

Builds a sequence of flight path vectors representing a path from a defined start point and initial course which turns and intercepts a final path at a specified angle using a great-circle path. Optionally includes a final turn from the intercept path to the final path and/or restricts the intercept path to intercept the final path within a certain distance before an end point.

If a path cannot be found that intercepts the final path while meeting the specified requirements, then no vectors will be built.

If the initial and final paths are parallel at the start point, then no vectors will be built.

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.
start	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The start point.
startPath	ReadonlyGeoCircle	undefined	A GeoCircle that defines the initial course. Must be a great circle.
startTurnRadius	number	undefined	The radius of the initial turn, in meters.
startTurnDirection	undefined | VectorTurnDirection	undefined	The direction of the initial turn. If not defined, then a direction will be automatically chosen based on the geometry of the path to build.
interceptAngle	number	undefined	The angle at which to intercept the final path, in degrees. Will be clamped to the range [0, 90].
endPath	ReadonlyGeoCircle	undefined	A GeoCircle that defines the final path.
end?	Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">> | LatLonInterface	undefined	The end point. If both this and maxInterceptDistanceFromEnd are defined, then the path to build is restricted to intercepting the final path within maxInterceptDistanceFromEnd of the end point. Otherwise, any intercept point on the final path will be considered valid.
maxInterceptDistanceFromEnd?	number	undefined	The maximum distance before the end point, in meters as measured along the final path, that the path to build is allowed to intercept the final path. Ignored if end is not defined. If not defined, then any intercept point on the final path will be considered valid.
endTurnRadius?	number	undefined	The radius of the final turn, in meters. If not defined, then vectors will not be built for the final turn.
startTurnVectorFlags?	number	0	The flags to set on the initial turn vector. Defaults to none (0).
interceptVectorFlags?	number	0	The flags to set on the intercept path vector. Defaults to none (0).
endTurnVectorFlags?	number	0	The flags to set on the final turn vector. Defaults to none (0). Ignored if a turn to join the final path is not calculated.
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.

Throws

Error if startPath is not a great circle.