Class AnimationGLTF

constructor

• new AnimationGLTF(_name?, _animStructure?, _fps?): AnimationGLTF

• Parameters

  • _name: string = Animation.name
  • _animStructure: AnimationStructure = {}
  • _fps: number = 60

  Returns AnimationGLTF

animationStructure

events

idResource

labels

name

status

totalTime

Readonly type

url

Static Readonly iSubclass

Static Readonly subclasses

fps

• get fps(): number

• Returns number

• set fps(_fps): void

• Parameters

  • _fps: number

  Returns void

getLabels

• get getLabels(): Enumerator<any>

• Returns Enumerator<any>

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

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

calculateTotalTime

• calculateTotalTime(): void

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

  Returns void

clearCache

• clearCache(): void

• Clear this animations cache.

  Returns void

deserialize

• deserialize(_serialization): Promise<Serializable>

• Recreates this instance of Serializable with the information from the given Serialization.

  Parameters

  • _serialization: Serialization

  Returns Promise<Serializable>

dispatchEvent

• dispatchEvent(_event): boolean

• See EventTarget.dispatchEvent for reference. Works with with EventUnified

  Parameters

  • _event: EventUnified

  Returns boolean

getEventsToFire

• getEventsToFire(_min, _max, _quantization, _direction): string[]

• Returns a list of the names of the events the ComponentAnimation 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.

getMetaAttributeTypes

• getMetaAttributeTypes(): MetaAttributeTypes

• Retrieves the specified attribute types from the metadata of this instance's class.

  Returns MetaAttributeTypes

getMetadata

• getMetadata(): Metadata

• Retrieves the metadata of this instance's class.

  Returns Metadata

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

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

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

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

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

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

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>

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

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

serialize

• serialize(): Serialization

• Returns a Serialization of this object.

  Returns Serialization

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

updateMutator

• updateMutator(_mutator): void

• Updates the values of the given mutator according to the current state of the instance

  Parameters

  • _mutator: Mutator

  Returns void

Static blendAdditive

• blendAdditive(_base, _add, _weight): Mutator

• Add the given additive mutator to the given base mutator. The values of the additive mutator will be multiplied by the given weight.

  Parameters

  • _base: Mutator
  • _add: Mutator
  • _weight: number

  Returns Mutator

Static blendOverride

• blendOverride(_base, _override, _weight, _intersect?): Mutator

• Override the given base mutator with the given override mutator using linear interpolation between the values with the given weight. Set the intersect flag to only include properties in the result that exist in both of the given mutators.

  Parameters

  • _base: Mutator
  • _override: Mutator
  • _weight: number
  • _intersect: boolean = false

  Returns Mutator

Static blendRecursive

• blendRecursive(_base, _blend, _weightBase, _weightBlend, _intersect?): Mutator

• Blend the two given mutators together, using the given weights to determine the influence of each. The resulting mutator will contain all properties of the base mutator, with the properties of the blend mutator blended in. Blend mutator properties that don't exist in the base mutator will be added to the result mutator. Set the intersect flag to only include properties in the result that exist in both of the given mutators.

  Parameters

  • _base: Mutator
  • _blend: Mutator
  • _weightBase: number
  • _weightBlend: number
  • _intersect: boolean = false

  Returns Mutator

Static getMutatorFromPath

• getMutatorFromPath(_mutator, _path): Mutator

• Decorator allows to attach Mutable functionality to existing classes.

  Parameters

  • _mutator: Mutator
  • _path: string[]

  Returns Mutator