Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PropAnim<TgtT, TProp>

Type parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new PropAnim<TgtT, TProp>(option: { duraiton: number; from: TProp; interpolator?: AnimInterpolator; tgt: TgtT; to: TProp }): PropAnim<TgtT, TProp>

  • Type parameters

    Parameters

    • option: { duraiton: number; from: TProp; interpolator?: AnimInterpolator; tgt: TgtT; to: TProp }
      • duraiton: number
      • from: TProp
      • Optional interpolator?: AnimInterpolator
      • tgt: TgtT
      • to: TProp

    Returns PropAnim<TgtT, TProp>

Properties

Protected _duration

_duration: number

Protected Readonly _interpolator

_interpolator: AnimInterpolator

Protected _tgt

_tgt: TgtT

Protected Optional _tween

_tween?: Tween<TProp>

Protected Optional _updateCallback

_updateCallback?: (tgt: TgtT, prop: TProp, elapsed: number) => void

Type declaration

    • (tgt: TgtT, prop: TProp, elapsed: number): void

    • Parameters

      • tgt: TgtT
      • prop: TProp
      • elapsed: number

      Returns void

Accessors

Protected group

  • get group(): undefined | Group

  • Returns undefined | Group

Methods

chain

Protected easeFunc

  • easeFunc(): (amount: number) => number

  • Returns (amount: number) => number

      • (amount: number): number

      • Parameters

        • amount: number

        Returns number

Protected getGroup

Protected initialize

  • initialize(from: TProp, to: TProp): Tween<TProp>

  • Parameters

    • from: TProp
    • to: TProp

    Returns Tween<TProp>

onComplete

  • onComplete(callback: (tgt: TgtT, prop: TProp) => void): PropAnim<TgtT, TProp>

  • Parameters

    • callback: (tgt: TgtT, prop: TProp) => void
        • (tgt: TgtT, prop: TProp): void

        • Parameters

          • tgt: TgtT
          • prop: TProp

          Returns void

    Returns PropAnim<TgtT, TProp>

onStart

  • onStart(callback: (tgt: TgtT, prop: TProp) => void): PropAnim<TgtT, TProp>

  • Parameters

    • callback: (tgt: TgtT, prop: TProp) => void
        • (tgt: TgtT, prop: TProp): void

        • Parameters

          • tgt: TgtT
          • prop: TProp

          Returns void

    Returns PropAnim<TgtT, TProp>

onStop

  • onStop(callback: (tgt: TgtT, prop: TProp) => void): PropAnim<TgtT, TProp>

  • Parameters

    • callback: (tgt: TgtT, prop: TProp) => void
        • (tgt: TgtT, prop: TProp): void

        • Parameters

          • tgt: TgtT
          • prop: TProp

          Returns void

    Returns PropAnim<TgtT, TProp>

onUpdate

  • onUpdate(callback: (tgt: TgtT, prop: TProp, elapsed: number) => void): PropAnim<TgtT, TProp>

  • Parameters

    • callback: (tgt: TgtT, prop: TProp, elapsed: number) => void
        • (tgt: TgtT, prop: TProp, elapsed: number): void

        • Parameters

          • tgt: TgtT
          • prop: TProp
          • elapsed: number

          Returns void

    Returns PropAnim<TgtT, TProp>

repeat

  • repeat(times: number, reverse?: boolean): PropAnim<TgtT, TProp>

  • Parameters

    • times: number
    • reverse: boolean = true

    Returns PropAnim<TgtT, TProp>

start

  • start(time?: number): PropAnim<TgtT, TProp>

  • Parameters

    • Optional time: number

    Returns PropAnim<TgtT, TProp>

stop

Protected update

  • update(prop: Record<keyof TgtT, any>, elapsed: number): void

  • Parameters

    • prop: Record<keyof TgtT, any>
    • elapsed: number

    Returns void

Generated using TypeDoc