Documentation

Class: LayeredAnimation

LayeredAnimation

LayeredAnimation is a Component that combines a set of AnimationLayer objects into a single manageable animation. The layer animations can act on any object, joint pose or morph pose in the hierarchy of the Entity to which the Component was assigned. When added to the Scene's root node, it can be seen as a global keyframe animation system for the given scene.

new LayeredAnimation()

Properties:
Name Type Description
name

The name of the animation.
playbackRate

A value to control the playback speed.
time

The current time in milliseconds of the play head.
looping

Determines whether the animation should loop or not. By default, it uses the value determined by the AnimationClip, but can be overridden.
Author:
  • derschmale <http://www.derschmale.com>

Extends

Members

acceptVisitor

If provided, this method will be called by the scene partition traverser, allowing collection by the renderer.

Inherited From:

bounds

If a Component has a scene presence, it can have bounds

Inherited From:

enabled

Defines whether or not this component should be enabled.

Inherited From:

onUpdate

If provided, this method will be called every frame, allowing updating the entity.

Inherited From:
Overrides:

Methods

addLayer(layer)

Adds a layer to the animation

Parameters:
Name Type Description
layer

bindListener()

Listens to the entity's messenger for a given message type.

Inherited From:

broadcast()

Broadcasts a message dispatched by the owning Entity's onMessage Signal.

Inherited From:

clone()

Creates a duplicate of this Component.

Inherited From:
Overrides:

hasListeners()

Tests whether the given signal is being listened to.

Inherited From:

invalidateBounds()

Marks the bounds as invalid, causing them to be recalculated when next queried.

Inherited From:

onAdded()

Called when this component is added to an Entity.

Inherited From:
Overrides:

onRemoved()

Called when this component is removed from an Entity.

Inherited From:
Overrides:

removeLayer(layer)

Removes a layer from the animation

Parameters:
Name Type Description
layer

unbindListener()

Listens to the entity's messenger for a given message type.

Inherited From: