Skip to main content

Class: APRollDirector

An autopilot roll director.

Implements

Constructors

constructor

new APRollDirector(apValues, options?): APRollDirector

Creates an instance of the LateralDirector.

Parameters

NameTypeDescription
apValuesAPValuesThe AP Values.
options?Readonly<APRollDirectorOptions>Options to configure the new director.

Returns

APRollDirector

Defined in

src/sdk/autopilot/directors/APRollDirector.ts:56

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

Parameters
NameType
banknumber
rate?number
Returns

void

Inherit Doc

Implementation of

PlaneDirector.driveBank

Defined in

src/sdk/autopilot/directors/APRollDirector.ts:41


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/APRollDirector.ts:36


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/APRollDirector.ts:38


state

state: DirectorState

The current director state.

Implementation of

PlaneDirector.state

Defined in

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

Methods

activate

activate(): void

Activates this director.

Returns

void

Implementation of

PlaneDirector.activate

Defined in

src/sdk/autopilot/directors/APRollDirector.ts:106


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/APRollDirector.ts:132


deactivate

deactivate(): void

Deactivates this director.

Returns

void

Implementation of

PlaneDirector.deactivate

Defined in

src/sdk/autopilot/directors/APRollDirector.ts:141


update

update(): void

Updates this director.

Returns

void

Implementation of

PlaneDirector.update

Defined in

src/sdk/autopilot/directors/APRollDirector.ts:150