Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PathAnim<TgtT>

Type parameters

Hierarchy

  • Animation<TgtT, { distance: number }>
    • PathAnim

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Protected _duration

_duration: number

Protected Readonly _interpolator

_interpolator: AnimInterpolator

Protected _tgt

_tgt: TgtT

Protected Optional _tween

_tween?: Tween<{ distance: number }>

Protected Optional _updateCallback

_updateCallback?: (tgt: TgtT, prop: { distance: number }, elapsed: number) => void

Type declaration

    • (tgt: TgtT, prop: { distance: number }, elapsed: number): void

    • Parameters

      • tgt: TgtT
      • prop: { distance: number }
        • distance: number
      • 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: { distance: number }, to: { distance: number }): Tween<{ distance: number }>

  • Parameters

    • from: { distance: number }
      • distance: number
    • to: { distance: number }
      • distance: number

    Returns Tween<{ distance: number }>

onComplete

  • onComplete(callback: (tgt: TgtT, prop: { distance: number }) => void): PathAnim<TgtT>

  • Parameters

    • callback: (tgt: TgtT, prop: { distance: number }) => void
        • (tgt: TgtT, prop: { distance: number }): void

        • Parameters

          • tgt: TgtT
          • prop: { distance: number }
            • distance: number

          Returns void

    Returns PathAnim<TgtT>

onStart

  • onStart(callback: (tgt: TgtT, prop: { distance: number }) => void): PathAnim<TgtT>

  • Parameters

    • callback: (tgt: TgtT, prop: { distance: number }) => void
        • (tgt: TgtT, prop: { distance: number }): void

        • Parameters

          • tgt: TgtT
          • prop: { distance: number }
            • distance: number

          Returns void

    Returns PathAnim<TgtT>

onStop

  • onStop(callback: (tgt: TgtT, prop: { distance: number }) => void): PathAnim<TgtT>

  • Parameters

    • callback: (tgt: TgtT, prop: { distance: number }) => void
        • (tgt: TgtT, prop: { distance: number }): void

        • Parameters

          • tgt: TgtT
          • prop: { distance: number }
            • distance: number

          Returns void

    Returns PathAnim<TgtT>

onUpdate

  • onUpdate(callback: (tgt: TgtT, prop: { distance: number }, elapsed: number) => void): PathAnim<TgtT>

  • Parameters

    • callback: (tgt: TgtT, prop: { distance: number }, elapsed: number) => void
        • (tgt: TgtT, prop: { distance: number }, elapsed: number): void

        • Parameters

          • tgt: TgtT
          • prop: { distance: number }
            • distance: number
          • elapsed: number

          Returns void

    Returns PathAnim<TgtT>

repeat

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

  • Parameters

    • times: number
    • reverse: boolean = true

    Returns PathAnim<TgtT>

start

  • Parameters

    • Optional time: number

    Returns PathAnim<TgtT>

stop

Protected update

  • update(prop: { distance: number }, elapsed: number): void

  • Parameters

    • prop: { distance: number }
      • distance: number
    • elapsed: number

    Returns void

Generated using TypeDoc