Class: CircleInterceptVectorBuilder
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleInterceptVectorBuilder.ts:11
Builds vectors representing great-circle paths that intercept other geo circles.
Constructors
Constructor
new CircleInterceptVectorBuilder():
CircleInterceptVectorBuilder
Returns
CircleInterceptVectorBuilder
Methods
build()
Call Signature
build(
vectors,index,start,course,circleToIntercept,flags?,heading?,isHeadingTrue?):number
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleInterceptVectorBuilder.ts:28
Builds a flight path vector along a path from a defined start point to the closest intersection point with a GeoCircle. If the vector path does not intersect the circle to intercept, then no vectors will be built.
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. |
course | number | The initial true course, in degrees, of the path of the built vector. |
circleToIntercept | ReadonlyGeoCircle | The circle to intercept. |
flags? | number | The flags to set on the built vector. Defaults to none (0). |
heading? | null | number | - |
isHeadingTrue? | boolean | - |
Returns
number
The number of vectors that were built and added to the array.
Call Signature
build(
vectors,index,start,path,circleToIntercept,flags?,heading?,isHeadingTrue?):number
Defined in: src/sdk/flightplan/flightpath/vectorbuilders/CircleInterceptVectorBuilder.ts:50
Builds a flight path vector along a path from a defined start point to the closest intersection point with a GeoCircle. If the vector path does not intersect the circle to intercept, then no vectors will be built.
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. |
path | ReadonlyGeoCircle | A GeoCircle that defines the path of the built vector. |
circleToIntercept | ReadonlyGeoCircle | The circle to intercept. |
flags? | number | The flags to set on the built vector. Defaults to none (0). |
heading? | null | number | - |
isHeadingTrue? | boolean | - |
Returns
number
The number of vectors that were built and added to the array.
Throws
Error if start does not lie on path.