Skip to main content

Class: InputAcceleration

A class to simulate knob acceleration on value inputs

Constructors​

constructor​

• new InputAcceleration(options?, initiallyPaused?): InputAcceleration

Ctor

Parameters​

NameTypeDefault valueDescription
optionsPartial<InputAccelerationSettings>{}the knob acceleration settings
initiallyPausedbooleanfalsewhether the knob acceleration is initially paused

Returns​

InputAcceleration

Defined in​

src/sdk/utils/controllers/InputAcceleration.ts:27

Properties​

options​

• Readonly options: InputAccelerationSettings

Defined in​

src/sdk/utils/controllers/InputAcceleration.ts:20

Methods​

doStep​

▸ doStep(): number

Does a step and returns the increment value.

Returns​

number

the increment value

Defined in​

src/sdk/utils/controllers/InputAcceleration.ts:53

pause​

▸ pause(): void

Pauses the update loop

Returns​

void

Defined in​

src/sdk/utils/controllers/InputAcceleration.ts:63

resume​

▸ resume(): void

Resumes the update loop

Returns​

void

Defined in​

src/sdk/utils/controllers/InputAcceleration.ts:68