Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RafProgress

Hierarchy

  • RafProgress

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RafProgress(progressRafLoop: Function): RafProgress

Properties

currentProgress

currentProgress: number

Methods

dampTo

  • dampTo(targetProgress: number, easeAmount: number, damp: number, noClamp?: boolean): void

  • Parameters

    • targetProgress: number
    • easeAmount: number
    • damp: number
    • Default value noClamp: boolean = false

    Returns void

dispose

  • dispose(): void

easeTo

  • easeTo(targetProgress: number, easeAmount: number, easingFunction?: Function, noClamp?: boolean): void

  • Parameters

    • targetProgress: number
    • easeAmount: number
    • Default value easingFunction: Function = EASE.linear
    • Default value noClamp: boolean = false

    Returns void

getLerpDelta

  • getLerpDelta(): number

getScrollDirection

  • getScrollDirection(): number

run

  • run(): void

setCurrentProgress

  • setCurrentProgress(progress: number, noClamp?: boolean): void

  • Parameters

    • progress: number
    • Default value noClamp: boolean = true

    Returns void

setFps

  • setFps(fps: number): void

setPrecision

  • setPrecision(value: number): void

stop

  • stop(): void

unwatch

  • unwatch(callbackToRemove: Function): void

unwatchFor

  • unwatchFor(callback: Function): void

watch

  • watch(callback: Function): void

watchFor

  • watchFor(range: number | Array<number>, callback: Function): void