Class Animation<TgtT, PropT>

Type parameters

TgtT: Partial<AnimationTarget>
PropT: PropType

Hierarchy

Animation

Index

Constructors

constructor

Properties

Accessors

group

Methods

Constructors

constructor

new Animation<TgtT, PropT>(tgt: TgtT, duration: number, interpolator: AnimInterpolator): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:38
Type parameters
- TgtT: Partial<AnimationTarget>
- PropT: PropType
Parameters
- tgt: TgtT
- duration: number
- interpolator: AnimInterpolator
Returns Animation<TgtT, PropT>

Properties

Protected _duration

_duration: number

Protected Readonly _interpolator

_interpolator: AnimInterpolator

Protected _tgt

_tgt: TgtT

Protected Optional _tween

_tween?: Tween<PropT>

Protected Optional _updateCallback

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

Type declaration

- (tgt: TgtT, prop: PropT, elapsed: number): void
- Parameters
  - tgt: TgtT
  - prop: PropT
  - elapsed: number
  Returns void

Accessors

Protected group

get group(): undefined | Group

- Defined in src/animations/animation.ts:34
Returns undefined | Group

Methods

chain

chain<T2, P2>(next: Animation<T2, P2>): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:116
Type parameters
- T2: Partial<AnimationTarget>
- P2: PropType
Parameters
- next: Animation<T2, P2>
Returns Animation<TgtT, PropT>

Protected easeFunc

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

- Defined in src/animations/animation.ts:59
Returns (amount: number) => number
- - (amount: number): number
  - Parameters
    - amount: number
    Returns number

Protected getGroup

getGroup(t?: null | Partial<AnimationTarget>): undefined | Group

- Defined in src/animations/animation.ts:44
Parameters
- Optional t: null | Partial<AnimationTarget>
Returns undefined | Group

Protected initialize

initialize(from: PropT, to: PropT): Tween<PropT>

- Defined in src/animations/animation.ts:48
Parameters
- from: PropT
- to: PropT
Returns Tween<PropT>

onComplete

onComplete(callback: (tgt: TgtT, prop: PropT) => void): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:110
Parameters
- callback: (tgt: TgtT, prop: PropT) => void
  - - (tgt: TgtT, prop: PropT): void
    - Parameters
      - tgt: TgtT
      - prop: PropT
      Returns void
Returns Animation<TgtT, PropT>

onStart

onStart(callback: (tgt: TgtT, prop: PropT) => void): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:98
Parameters
- callback: (tgt: TgtT, prop: PropT) => void
  - - (tgt: TgtT, prop: PropT): void
    - Parameters
      - tgt: TgtT
      - prop: PropT
      Returns void
Returns Animation<TgtT, PropT>

onStop

onStop(callback: (tgt: TgtT, prop: PropT) => void): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:104
Parameters
- callback: (tgt: TgtT, prop: PropT) => void
  - - (tgt: TgtT, prop: PropT): void
    - Parameters
      - tgt: TgtT
      - prop: PropT
      Returns void
Returns Animation<TgtT, PropT>

onUpdate

onUpdate(callback: (tgt: TgtT, prop: PropT, elapsed: number) => void): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:94
Parameters
- callback: (tgt: TgtT, prop: PropT, elapsed: number) => void
  - - (tgt: TgtT, prop: PropT, elapsed: number): void
    - Parameters
      - tgt: TgtT
      - prop: PropT
      - elapsed: number
      Returns void
Returns Animation<TgtT, PropT>

repeat

repeat(times: number, reverse?: boolean): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:90
Parameters
- times: number
- reverse: boolean = true
Returns Animation<TgtT, PropT>

start

start(time?: number): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:74
Parameters
- Optional time: number
Returns Animation<TgtT, PropT>

stop

stop(): Animation<TgtT, PropT>

- Defined in src/animations/animation.ts:78
Returns Animation<TgtT, PropT>

Protected Abstract update

update(prop: PropT, elapsed: number): any

- Defined in src/animations/animation.ts:43
Parameters
- prop: PropT
- elapsed: number
Returns any

Generated using TypeDoc