Class: APPitchDirector

An autopilot pitch director.

Implements

• PlaneDirector

Constructors

constructor

• new APPitchDirector(bus, apValues, pitchIncrement?, minPitch?, maxPitch?): APPitchDirector

Creates an instance of the LateralDirector.

Parameters

Name	Type	Description
bus	EventBus	-
apValues	APValues	-
pitchIncrement?	number	is the pitch increment, in degrees, to use when the user presses the pitch inc/dec keys (default: 0.5)
minPitch?	number	is the negative minimum pitch angle, in degrees, to clamp the pitch to. (default: -15)
maxPitch?	number	is the positive maximum pitch angle, in degrees, to clamp the pitch to. (default: 20)

Returns

APPitchDirector

Deprecated

Use APPitchDirectorOptions instead.

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:49

• new APPitchDirector(bus, apValues, options?): APPitchDirector

Creates an instance of the LateralDirector.

Parameters

Name	Type	Description
bus	EventBus	The event bus to use with this instance.
apValues	APValues	are the AP Values subjects.
options?	Partial<Readonly<APPitchDirectorOptions>>	Options to configure the new director. Option values default to the following if not defined: pitchIncrement: 0.5 minPitch: -15 maxPitch: 20 quantisePitch: false

Returns

APPitchDirector

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:66

Properties

maxPitch

• Protected Readonly maxPitch: () => number

Type declaration

▸ (): number

Returns

number

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:39

---

minPitch

• Protected Readonly minPitch: () => number

Type declaration

▸ (): number

Returns

number

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:38

---

onActivate

• Optional onActivate: () => void

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

Type declaration

▸ (): void

Returns

void

Inherit Doc

Implementation of

PlaneDirector.onActivate

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:29

---

onArm

• Optional onArm: () => void

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

Type declaration

▸ (): void

Returns

void

Inherit Doc

Implementation of

PlaneDirector.onArm

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:31

---

pitchIncrement

• Protected Readonly pitchIncrement: () => number

Type declaration

▸ (): number

Returns

number

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:37

---

quantisePitch

• Protected Readonly quantisePitch: boolean

Defined in

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

---

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

Parameters

Name	Type
pitch	number

Returns

void

Inherit Doc

Implementation of

PlaneDirector.setPitch

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:33

---

state

• state: DirectorState

The current director state.

Implementation of

PlaneDirector.state

Defined in

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

Methods

activate

▸ activate(): void

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:145

---

arm

▸ arm(): void

Arms this director. This director has no armed mode, so it activates immediately.

Returns

void

Implementation of

PlaneDirector.arm

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:159

---

deactivate

▸ deactivate(): void

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:168

---

update

▸ update(): void

Updates this director.

Returns

void

Implementation of

PlaneDirector.update

Defined in

src/sdk/autopilot/directors/APPitchDirector.ts:191