Class Dynamic

Represents a variable that can dynamically change with time (using requestAnimationFrame)

Index

Constructors

Accessors

Methods

goto roll setSpeed setValue step stop

Constructors

constructor

new Dynamic(
fn: (val: number) => void,
config: { defaultValue: number; max: number; min: number; wrap: boolean },
): Dynamic
Parameters
- fn: (val: number) => void
- config: { defaultValue: number; max: number; min: number; wrap: boolean }
Returns Dynamic
- Defined in packages/core/src/utils/Dynamic.ts:34

Accessors

current

get current(): number
Returns number
- Defined in packages/core/src/utils/Dynamic.ts:26
set current(current: number): void
Parameters
- current: number
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:30

Methods

goto

goto(position: number, speedMult?: number): void
Defines the target position
Parameters
- position: number
- speedMult: number = 1
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:67

roll

roll(invert?: boolean, speedMult?: number): void
Starts infinite movement
Parameters
- invert: boolean = false
- speedMult: number = 1
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:90

setSpeed

setSpeed(speed: number): void
Changes base speed
Parameters
- speed: number
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:60

setValue

setValue(value: number): boolean
Defines the current position and immediately stops movement
Parameters
- value: number
Returns boolean
- Defined in packages/core/src/utils/Dynamic.ts:107

step

step(step: number, speedMult?: number): void
Increases/decreases the target position
Parameters
- step: number
- speedMult: number = 1
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:76

stop

stop(): void
Stops movement

Returns void
- Defined in packages/core/src/utils/Dynamic.ts:99