Class AnimationGLTF

An Animation loaded from a glTF-File.

Authors

Jonas Plotzky

Hierarchy

SerializableResourceExternal<typeof Animation, this> & Animation<this>
- AnimationGLTF

Constructors

constructor

new AnimationGLTF(_name?, _animStructure?, _fps?): AnimationGLTF
Parameters
- _name: string = Animation.name
- _animStructure: AnimationStructure = {}
- _fps: number = 60
Returns AnimationGLTF
Inherited from mixinSerializableResourceExternal(Animation).constructor
- Defined in Source/Core/Animation/Animation.ts:114

Properties

animationStructure

animationStructure: AnimationStructure

events

events: AnimationEventTrigger = {}

idResource

idResource: string

labels

labels: AnimationLabel = {}

name

name: string

status

status: RESOURCE_STATUS = RESOURCE_STATUS.PENDING

totalTime

totalTime: number = 0

`Readonly` type

type: string

url

url: RequestInfo

`Static` `Readonly` iSubclass

iSubclass: number = ...

`Static` `Readonly` subclasses

subclasses: typeof Animation[] = []

Accessors

fps

get fps(): number
Returns number
Inherited from mixinSerializableResourceExternal(Animation).fps
- Defined in Source/Core/Animation/Animation.ts:132
set fps(_fps): void
Parameters
- _fps: number
Returns void
Inherited from mixinSerializableResourceExternal(Animation).fps
- Defined in Source/Core/Animation/Animation.ts:136

getLabels

get getLabels(): Enumerator<any>
Returns Enumerator<any>
Inherited from mixinSerializableResourceExternal(Animation).getLabels
- Defined in Source/Core/Animation/Animation.ts:126

Methods

addEventListener

addEventListener(_type, _handler, _options?): void
See EventTarget.addEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from mixinSerializableResourceExternal(Animation).addEventListener
- Defined in Source/Core/Event/Event.ts:91

calculateDirection

calculateDirection(_time, _playmode): number
Calculates and returns the direction the animation should currently be playing in.
Parameters
- _time: number
  the time at which to calculate the direction
- _playmode: ANIMATION_PLAYMODE
Returns number
1 if forward, 0 if stop, -1 if backwards
Inherited from mixinSerializableResourceExternal(Animation).calculateDirection
- Defined in Source/Core/Animation/Animation.ts:246

calculateTotalTime

calculateTotalTime(): void
(Re-)Calculate the total time of the Animation. Calculation-heavy, use only if actually needed.

Returns void
Inherited from mixinSerializableResourceExternal(Animation).calculateTotalTime
- Defined in Source/Core/Animation/Animation.ts:215

clearCache

clearCache(): void
Clear this animations cache.

Returns void
Inherited from mixinSerializableResourceExternal(Animation).clearCache
- Defined in Source/Core/Animation/Animation.ts:145

deserialize

deserialize(_serialization): Promise<Serializable>
Parameters
- _serialization: Serialization
Returns Promise<Serializable>
Inherited from mixinSerializableResourceExternal(Animation).deserialize
- Defined in Source/Core/Serialization/Serializer.ts:280

dispatchEvent

dispatchEvent(_event): boolean
See EventTarget.dispatchEvent for reference. Works with with EventUnified
Parameters
- _event: EventUnified
Returns boolean
Inherited from mixinSerializableResourceExternal(Animation).dispatchEvent
- Defined in Source/Core/Event/Event.ts:105

getEventsToFire

getEventsToFire(_min, _max, _quantization, _direction): string[]
Returns a list of the names of the events the ComponentAnimator needs to fire between _min and _max input values.
Parameters
- _min: number
- _max: number
- _quantization: ANIMATION_QUANTIZATION
- _direction: number
  The direction the animation is supposed to run in. >0 == forward, 0 == stop, <0 == backwards
Returns string[]
a list of strings with the names of the custom events to fire.
Inherited from mixinSerializableResourceExternal(Animation).getEventsToFire
- Defined in Source/Core/Animation/Animation.ts:171

getMetaAttributeTypes

getMetaAttributeTypes(): MetaAttributeTypes
Retrieves the specified attribute types from the metadata of this instance's class.

Returns MetaAttributeTypes
Inherited from mixinSerializableResourceExternal(Animation).getMetaAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:231

getMetadata

getMetadata(): Metadata
Retrieves the metadata of this instance's class.

Returns Metadata
Inherited from mixinSerializableResourceExternal(Animation).getMetadata
- Defined in Source/Core/Serialization/Mutable.ts:238

getModalTime

getModalTime(_time, _playmode, _timeStop?): number
Returns the time to use for animation sampling when applying a playmode
Parameters
- _time: number
- _playmode: ANIMATION_PLAYMODE
- _timeStop: number = _time
Returns number
Inherited from mixinSerializableResourceExternal(Animation).getModalTime
- Defined in Source/Core/Animation/Animation.ts:225

getMutator

getMutator(_extendable?): Mutator
Collect applicable attributes of the instance and copies of their values in a Mutator-object. By default, a mutator cannot be extended, since extensions are not available in the object the mutator belongs to. A mutator may be reduced by the descendants of Mutable to contain only the properties needed.
Parameters
- _extendable: boolean = false
Returns Mutator
Inherited from mixinSerializableResourceExternal(Animation).getMutator
- Defined in Source/Core/Serialization/Mutable.ts:150

getMutatorAttributeTypes

getMutatorAttributeTypes(_mutator): MutatorAttributeTypes
Returns an associative array with the same attributes as the given mutator, but with the corresponding types as string-values. Does not recurse into objects! This will return the decorated meta-type instead of the runtime-type of the object, if available.
Parameters
- _mutator: Mutator
Returns MutatorAttributeTypes
Inherited from mixinSerializableResourceExternal(Animation).getMutatorAttributeTypes
- Defined in Source/Core/Serialization/Mutable.ts:208

getMutatorForAnimation

getMutatorForAnimation(_extendable?): MutatorForAnimation
Collect the attributes of the instance and their values applicable for animation. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForAnimation
Inherited from mixinSerializableResourceExternal(Animation).getMutatorForAnimation
- Defined in Source/Core/Serialization/Mutable.ts:185

getMutatorForUserInterface

getMutatorForUserInterface(_extendable?): MutatorForUserInterface
Collect the attributes of the instance and their values applicable for the user interface. Basic functionality is identical to getMutator, returned mutator should then be reduced by the subclassed instance
Parameters
- _extendable: boolean = false
Returns MutatorForUserInterface
Inherited from mixinSerializableResourceExternal(Animation).getMutatorForUserInterface
- Defined in Source/Core/Serialization/Mutable.ts:193

getState

getState(_time, _direction, _quantization): Mutator
Generates and returns a Mutator with the information to apply to the Node to animate in the state the animation is in at the given time, direction and quantization
Parameters
- _time: number
- _direction: number
- _quantization: ANIMATION_QUANTIZATION
Returns Mutator
Inherited from mixinSerializableResourceExternal(Animation).getState
- Defined in Source/Core/Animation/Animation.ts:153

load

load(_url?, _name?): Promise<AnimationGLTF>
Parameters
- _url: RequestInfo = ...
- _name: string = ...
Returns Promise<AnimationGLTF>
Overrides mixinSerializableResourceExternal(Animation).load
- Defined in Source/Core/Animation/AnimationGLTF.ts:7

mutate

mutate(_mutator, _selection?, _dispatchMutate?): Promise<void>
Updates the attribute values of the instance according to the state of the mutator. The mutation may be restricted to a subset of the mutator and the event dispatching suppressed. Uses mutateBase, but can be overwritten in subclasses
Parameters
- _mutator: Mutator
- _selection: string[] = null
- _dispatchMutate: boolean = true
Returns Promise<void>
Inherited from mixinSerializableResourceExternal(Animation).mutate
- Defined in Source/Core/Serialization/Mutable.ts:260

removeEvent

removeEvent(_name): void
Removes the event with the given name from the list of events.
Parameters
- _name: string
  name of the event to remove.
Returns void
Inherited from mixinSerializableResourceExternal(Animation).removeEvent
- Defined in Source/Core/Animation/Animation.ts:206

removeEventListener

removeEventListener(_type, _handler, _options?): void
See EventTarget.removeEventListener for reference. Works with EventListenerUnified and EventUnified
Parameters
- _type: string
- _handler: EventListenerUnified
- Optional _options: boolean | AddEventListenerOptions
Returns void
Inherited from mixinSerializableResourceExternal(Animation).removeEventListener
- Defined in Source/Core/Event/Event.ts:98

serialize

serialize(): Serialization
Returns a Serialization of this resource. Only the data needed to load it from the external source is serialized ("url", "name", "idResource").

Returns Serialization
Inherited from mixinSerializableResourceExternal(Animation).serialize
- Defined in Source/Core/Serialization/Serializer.ts:270

setEvent

setEvent(_name, _time): void
Adds an Event to the List of events.
Parameters
- _name: string
  The name of the event (needs to be unique per Animation).
- _time: number
  The timestamp of the event (in milliseconds).
Returns void
Inherited from mixinSerializableResourceExternal(Animation).setEvent
- Defined in Source/Core/Animation/Animation.ts:197

updateMutator

updateMutator(_mutator): void
Updates the values of the given mutator according to the current state of the instance
Parameters
- _mutator: Mutator
Returns void
Inherited from mixinSerializableResourceExternal(Animation).updateMutator
- Defined in Source/Core/Serialization/Mutable.ts:246

`Static` getMutatorFromPath

getMutatorFromPath(_mutator, _path): Mutator
Decorator allows to attach Mutable functionality to existing classes.
Parameters
- _mutator: Mutator
- _path: string[]
Returns Mutator
Inherited from mixinSerializableResourceExternal(Animation).getMutatorFromPath
- Defined in Source/Core/Serialization/Mutable.ts:127

Class AnimationGLTF

Authors

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns AnimationGLTF

Properties

animationStructure

events

idResource

labels

name

status

totalTime

Readonly type

url

Static Readonly iSubclass

Static Readonly subclasses

Accessors

fps

Returns number

Parameters

Returns void

getLabels

Returns Enumerator<any>

Methods

addEventListener

Parameters

Returns void

calculateDirection

Parameters

Returns number

calculateTotalTime

Returns void

clearCache

Returns void

deserialize

Parameters

Returns Promise<Serializable>

dispatchEvent

Parameters

Returns boolean

getEventsToFire

Parameters

Returns string[]

getMetaAttributeTypes

Returns MetaAttributeTypes

getMetadata

Returns Metadata

getModalTime

Parameters

Returns number

getMutator

Parameters

Returns Mutator

getMutatorAttributeTypes

Parameters

Returns MutatorAttributeTypes

getMutatorForAnimation

Parameters

Returns MutatorForAnimation

getMutatorForUserInterface

Parameters

Returns MutatorForUserInterface

getState

Parameters

Returns Mutator

load

Parameters

Returns Promise<AnimationGLTF>

mutate

Parameters

Returns Promise<void>

removeEvent

`Readonly` type

`Static` `Readonly` iSubclass

`Static` `Readonly` subclasses

`Static` getMutatorFromPath