Class: APPitchDirector
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:23
An autopilot pitch director.
Implements
Constructors
Constructor
new APPitchDirector(
bus
,apValues
,pitchIncrement?
,minPitch?
,maxPitch?
):APPitchDirector
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:49
Creates an instance of the LateralDirector.
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:66
Creates an instance of the LateralDirector.
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:39
Returns
number
minPitch()
protected
readonly
minPitch: () =>number
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:38
Returns
number
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:29
A callback called when a mode signals it should be activated.
Returns
void
Implementation of
onArm()?
optional
onArm: () =>void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:31
A callback called when a mode signals it should be armed.
Returns
void
Implementation of
pitchIncrement()
protected
readonly
pitchIncrement: () =>number
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:37
Returns
number
quantisePitch
protected
readonly
quantisePitch:boolean
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:40
setPitch()?
optional
setPitch: (pitch
) =>void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:33
A callback called to set an exact AP pitch target.
Parameters
Parameter | Type |
---|---|
pitch | number |
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:25
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:145
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:159
Arms this director. This director has no armed mode, so it activates immediately.
Returns
void
Implementation of
deactivate()
deactivate():
void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:168
Deactivates this director.
Returns
void
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APPitchDirector.ts:191
Updates this director.
Returns
void