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, config): Dynamic
Parameters
- fn: ((val: number) => void)
  - - (val): void
    - Parameters
      val: number
      Returns void
- config: {
      defaultValue: number;
      max: number;
      min: number;
      wrap: boolean;
  }
  - 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): void
Parameters
- current: number
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:30

Methods

goto

goto(position, speedMult?): 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?, speedMult?): 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): void
Changes base speed
Parameters
- speed: number
Returns void
- Defined in packages/core/src/utils/Dynamic.ts:60

setValue

setValue(value): 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, speedMult?): 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