Skip to main content

Type Alias: HorizonProjectionParameters

HorizonProjectionParameters = object

Defined in: src/sdk/components/horizon/HorizonProjection.ts:14

A parameter object for HorizonProjection.

Properties​

altitude?​

readonly optional altitude: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:19

The altitude of the airplane, in meters above mean sea level.

fov?​

readonly optional fov: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:41

The field of view, in degrees.

fovEndpoints?​

readonly optional fovEndpoints: ReadonlyFloat64Array

Defined in: src/sdk/components/horizon/HorizonProjection.ts:47

The projected endpoints at which to measure the field of view, as [x1, y1, x2, y2], with each component expressed relative to the width or height of the projected window.

heading?​

readonly optional heading: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:22

The true heading of the airplane, in degrees.

headingScaleFactor?​

readonly optional headingScaleFactor: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:64

The factor by which to scale relative heading angles when projecting points. The relative heading angle of a point is the difference between the bearing of the point from the airplane and the airplane's heading. A scaling factor of 1 leaves points unchanged. Factors less than 1 cause points to be projected closer to the lubber line. Factors greater than 1 cause points to be projected farther from the lubber line.

offset?​

readonly optional offset: ReadonlyFloat64Array

Defined in: src/sdk/components/horizon/HorizonProjection.ts:35

The offset of the projection camera relative to the airplane, as [x, y, z] in meters using the airplane's coordinate system. The positive z axis points in the forward direction of the airplane, the positive x axis points in the upward direction, and the positive y axis points to the right.

pitch?​

readonly optional pitch: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:25

The pitch of the airplane, in degrees. Positive values indicate upward pitch.

pitchScaleFactor?​

readonly optional pitchScaleFactor: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:56

The factor by which to scale relative zero-roll pitch angles when projecting points. The relative zero-roll pitch angle of a point is the pitch angle of the point relative to the camera if the airplane had zero degrees of roll. A scaling factor of 1 leaves points unchanged. Factors less than 1 cause points to be projected closer to the pitch line corresponding to the airplane's pitch. Factors greater than 1 cause points to be projected farther from the pitch line corresponding to the airplane's pitch.

position?​

readonly optional position: Readonly<LatLonInterface>

Defined in: src/sdk/components/horizon/HorizonProjection.ts:16

The position of the airplane.

projectedOffset?​

readonly optional projectedOffset: ReadonlyFloat64Array

Defined in: src/sdk/components/horizon/HorizonProjection.ts:67

The offset of the center of the projection, as [x, y] in pixels.

projectedSize?​

readonly optional projectedSize: ReadonlyFloat64Array

Defined in: src/sdk/components/horizon/HorizonProjection.ts:38

The size of the projected window, as [x, y] in pixels.

roll?​

readonly optional roll: number

Defined in: src/sdk/components/horizon/HorizonProjection.ts:28

The roll of the airplane, in degrees. Positive values indicate rightward roll.