Class: APRollDirector
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:32
An autopilot roll director.
Implements
Constructors
Constructor
new APRollDirector(
apValues
,options?
):APRollDirector
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:56
Creates an instance of the LateralDirector.
Parameters
Parameter | Type | Description |
---|---|---|
apValues | APValues | The AP Values. |
options? | Readonly <APRollDirectorOptions > | Options to configure the new director. |
Returns
APRollDirector
Properties
driveBank()?
optional
driveBank: (bank
,rate?
) =>void
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:41
A function used to drive the autopilot commanded bank angle toward a desired value.
Parameters
Parameter | Type |
---|---|
bank | number |
rate? | number |
Returns
void
Implementation of
onActivate()?
optional
onActivate: () =>void
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:36
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/APRollDirector.ts:38
A callback called when a mode signals it should be armed.
Returns
void
Implementation of
state
state:
DirectorState
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:33
The current director state.
Implementation of
Methods
activate()
activate():
void
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:106
Activates this director.
Returns
void
Implementation of
arm()
arm():
void
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:132
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/APRollDirector.ts:141
Deactivates this director.
Returns
void
Implementation of
update()
update():
void
Defined in: src/sdk/autopilot/directors/APRollDirector.ts:150
Updates this director.
Returns
void