Skip to main content

Interface: PlaneDirector

An autopilot plane director guidance mode.

Hierarchy​

Implemented by​

Properties​

driveBank​

• Optional driveBank: (bank: number, rate?: number) => void

A function used to drive the autopilot commanded bank angle toward a desired value.

Param

The desired bank angle, in degrees. Positive values indicate left bank.

Param

The rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.

Type declaration​

▸ (bank, rate?): void

A function used to drive the autopilot commanded bank angle toward a desired value.

Parameters​
NameTypeDescription
banknumberThe desired bank angle, in degrees. Positive values indicate left bank.
rate?numberThe rate at which to drive the commanded bank angle, in degrees per second. If not defined, a default rate will be used.
Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:72

drivePitch​

• Optional drivePitch: (pitch: number, adjustForAoa?: boolean, adjustForVerticalWind?: boolean, rate?: number) => void

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Param

The desired pitch angle, in degrees. Positive values indicate downward pitch.

Param

Whether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the vertical wind correction. Defaults to false.

Param

Whether to adjust the commanded pitch angle for vertical wind velocity. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the current vertical wind component. This correction can be used in conjunction with the angle of attack correction. Defaults to false.

Param

The rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.

Type declaration​

▸ (pitch, adjustForAoa?, adjustForVerticalWind?, rate?): void

A function used to drive the autopilot commanded pitch angle toward a desired value while optionally correcting for angle of attack and vertical wind.

Parameters​
NameTypeDescription
pitchnumberThe desired pitch angle, in degrees. Positive values indicate downward pitch.
adjustForAoa?booleanWhether to adjust the commanded pitch angle for angle of attack. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the airplane's current angle of attack. This correction can be used in conjunction with the vertical wind correction. Defaults to false.
adjustForVerticalWind?booleanWhether to adjust the commanded pitch angle for vertical wind velocity. If true, the provided pitch angle is treated as a desired flight path angle and a new commanded pitch angle will be calculated to produce the desired FPA given the current vertical wind component. This correction can be used in conjunction with the angle of attack correction. Defaults to false.
rate?numberThe rate at which to drive the commanded pitch angle, in degrees per second. If not defined, a default rate will be used.
Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:95

onActivate​

• Optional onActivate: () => void

A callback called when a mode signals it should be activated.

Type declaration​

▸ (): void

A callback called when a mode signals it should be activated.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:46

onArm​

• Optional onArm: () => void

A callback called when a mode signals it should be armed.

Type declaration​

▸ (): void

A callback called when a mode signals it should be armed.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:52

onDeactivate​

• Optional onDeactivate: () => void

A callback called when a mode signals it should be deactivated.

Type declaration​

▸ (): void

A callback called when a mode signals it should be deactivated.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:58

setBank​

• Optional setBank: (bank: number) => void

A callback called to set an exact AP bank target.

Param

The bank in degrees (positive = right, negative = left).

Type declaration​

▸ (bank): void

A callback called to set an exact AP bank target.

Parameters​
NameTypeDescription
banknumberThe bank in degrees (positive = right, negative = left).
Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:64

setPitch​

• Optional setPitch: (pitch: number) => void

A callback called to set an exact AP pitch target.

Param

The pitch in degrees (positive = down, negative = up).

Type declaration​

▸ (pitch): void

A callback called to set an exact AP pitch target.

Parameters​
NameTypeDescription
pitchnumberThe pitch in degrees (positive = down, negative = up).
Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:78

state​

• state: DirectorState

The current director state.

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:98

Methods​

activate​

▸ activate(): void

Activates the guidance mode.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:25

arm​

▸ arm(): void

Arms the guidance mode.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:30

deactivate​

▸ deactivate(): void

Deactivates the guidance mode.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:35

update​

▸ update(): void

Updates the guidance mode control loops.

Returns​

void

Defined in​

src/sdk/autopilot/directors/PlaneDirector.ts:40