Class AnimationOptions

Animation options configuration class

Hierarchy (View Summary)

OptionLoader<IAnimation>
- AnimationOptions
  - RangedAnimationOptions
  - ColorAnimation

Implements

IAnimation

Index

Constructors

Properties

count decay delay enable speed sync

Methods

Constructors

constructor

new AnimationOptions(): AnimationOptions
Returns AnimationOptions
Inherited from OptionLoader.constructor

Properties

count

count: RangeValue = 0

Number of animation loops (0 = infinite)

decay

decay: RangeValue = 0

Animation decay factor

delay

delay: RangeValue = 0

Delay before animation starts

enable

enable: boolean = false

Enables the animation

speed

speed: RangeValue = 1

Animation speed

sync

sync: boolean = false

Whether the animation is synchronized across particles

Methods

`Protected`doLoad

doLoad(data: RecursivePartial<IAnimation>): void
Parameters
- data: RecursivePartial<IAnimation>
Returns void
Overrides OptionLoader.doLoad
- Defined in Options/Classes/AnimationOptions.ts:24

load

load(data?: RecursivePartial<IAnimation>): void
This load method is used to load data in the classes used as generic
Parameters
- Optionaldata: RecursivePartial<IAnimation>
  the input options
Returns void
Inherited from OptionLoader.load
- Defined in Utils/OptionLoader.ts:6