Class AnimationStorage

Animation storage pre-generates and holds user defined animtaions globally.

Author

Matej Hakoš

Hierarchy

AnimationStorage

Index

Constructors

Properties

Accessors

Methods

addAnimation getAnimation getAnimations loadDefaultAnimations removeAnimation setAlias

Constructors

`Private` constructor

new AnimationStorage(): AnimationStorage
Private
Creates an instance of AnimationStorage.

Returns AnimationStorage
- Defined in src/initialization/stepper/AnimationStorage.ts:30

Properties

`Static` `Private` animations

animations: Animations

Static Map containing all animations.

Static

Accessors

`Static` Instance

get Instance(): typeof AnimationStorage
Returns global instance.

Static

Returns typeof AnimationStorage
- Defined in src/initialization/stepper/AnimationStorage.ts:85

Methods

`Static` addAnimation

addAnimation(name: string, animation: AnimationDef): void
Adds animation with 'name' to Map.

Static
Parameters
- name: string
- animation: AnimationDef
Returns void
- Defined in src/initialization/stepper/AnimationStorage.ts:124

`Static` getAnimation

getAnimation(name: string): undefined | AnimationDef
Returns animation based on name parameter.

Static

Returns
Parameters
- name: string
Returns undefined | AnimationDef
- Defined in src/initialization/stepper/AnimationStorage.ts:112

`Static` getAnimations

getAnimations(): Animations
Returns names of all loaded animations.

Static

Returns

Returns Animations
- Defined in src/initialization/stepper/AnimationStorage.ts:100

`Static` `Private` loadDefaultAnimations

loadDefaultAnimations(): void
Private
Pre-generates default animations.

Static

Returns void
- Defined in src/initialization/stepper/AnimationStorage.ts:40

`Static` removeAnimation

removeAnimation(name: string): void
Removes animation 'name' from Map.

Static
Parameters
- name: string
Returns void
- Defined in src/initialization/stepper/AnimationStorage.ts:135

`Static` setAlias

setAlias(animationName: string, aliasName: string): void
Set an alias to animation in AnimationStorage. I.e. two functions are functionally the same, but have 2 different names (e.g. x360deg, xscrew).

Static
Parameters
- animationName: string
- aliasName: string
Returns void
- Defined in src/initialization/stepper/AnimationStorage.ts:149

Generated using TypeDoc