Class: InputAcceleration
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:16
A class to simulate knob acceleration on value inputs
Constructors
Constructor
new InputAcceleration(
options,initiallyPaused):InputAcceleration
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:27
Ctor
Parameters
| Parameter | Type | Default value | Description |
|---|---|---|---|
options | Partial<InputAccelerationSettings> | {} | the knob acceleration settings |
initiallyPaused | boolean | false | whether the knob acceleration is initially paused |
Returns
InputAcceleration
Properties
options
readonlyoptions:InputAccelerationSettings
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:20
Methods
doStep()
doStep():
number
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:54
Does a step and returns the increment value.
Returns
number
the increment value
pause()
pause():
void
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:64
Pauses the update loop
Returns
void
resume()
resume():
void
Defined in: src/sdk/utils/controllers/InputAcceleration.ts:69
Resumes the update loop
Returns
void