Class: APPitchDirector

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:24

An autopilot director that generates flight director pitch commands to hold a pitch attitude.

The director requires valid pitch data to arm or activate.

Implements

• PlaneDirector

Constructors

Constructor

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

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:59

Creates a new instance of APPitchDirector.

Parameters

Parameter	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.

Constructor

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

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:76

Creates a new instance of APPitchDirector.

Parameters

Parameter	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

Properties

maxPitch()

protected readonly maxPitch: () => number

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:47

Returns

number

---

minPitch()

protected readonly minPitch: () => number

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:46

Returns

number

---

onActivate()?

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:30

A callback called when this director is activated.

Returns

void

Implementation of

PlaneDirector.onActivate

---

onArm()?

optional onArm: () => void

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

A callback called when this director is armed.

Returns

void

Implementation of

PlaneDirector.onArm

---

onDeactivate()?

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:36

A callback that is called when this director is deactivated.

Returns

void

Implementation of

PlaneDirector.onDeactivate

---

pitchIncrement()

protected readonly pitchIncrement: () => number

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:45

Returns

number

---

quantisePitch

protected readonly quantisePitch: boolean

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:48

---

setPitch()?

optional setPitch: (pitch) => void

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

A callback called to set an exact AP pitch target.

Parameters

Parameter	Type
pitch	number

Returns

void

Implementation of

PlaneDirector.setPitch

---

state

state: DirectorState

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:27

The current director state.

Implementation of

PlaneDirector.state

Methods

activate()

activate(): void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:149

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

---

arm()

arm(): void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:166

Arms this director.

Returns

void

Implementation of

PlaneDirector.arm

---

deactivate()

deactivate(): void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:173

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

---

update()

update(): void

Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:188

Updates this director.

Returns

void

Implementation of

PlaneDirector.update