Skip to main content

Class: APRollDirector

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

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

The director requires valid bank data to arm or activate.

Implements​

Constructors​

Constructor​

new APRollDirector(apValues, options?): APRollDirector

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:63

Creates a new instance of APRollDirector.

Parameters​

ParameterTypeDescription
apValuesAPValuesThe 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:47

A function used to drive the autopilot commanded bank angle toward a desired value.

Parameters​

ParameterType
banknumber
rate?number

Returns​

void

Implementation of​

PlaneDirector.driveBank


onActivate()?​

optional onActivate: () => void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:38

A callback called when this director is activated.

Returns​

void

Implementation of​

PlaneDirector.onActivate


onArm()?​

optional onArm: () => void

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

A callback called when this director is armed.

Returns​

void

Implementation of​

PlaneDirector.onArm


onDeactivate()?​

optional onDeactivate: () => void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:44

A callback that is called when this director is deactivated.

Returns​

void

Implementation of​

PlaneDirector.onDeactivate


state​

state: DirectorState

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:35

The current director state.

Implementation of​

PlaneDirector.state

Methods​

activate()​

activate(): void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:119

Activates this director.

Returns​

void

Implementation of​

PlaneDirector.activate


arm()​

arm(): void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:145

Arms this director.

Returns​

void

Implementation of​

PlaneDirector.arm


deactivate()​

deactivate(): void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:152

Deactivates this director.

Returns​

void

Implementation of​

PlaneDirector.deactivate


update()​

update(): void

Defined in: src/sdk/autopilot/directors/APRollDirector.ts:169

Updates this director.

Returns​

void

Implementation of​

PlaneDirector.update