AnimationComponent
Extends: Component
The Animation Component allows an Entity to playback animations on models.
Summary
Properties
activate | If true the first animation asset will begin playing when the scene is loaded. |
animations | Get or set dictionary of animations by name. |
assets | The array of animation assets. |
currentTime | Get or set the current time position (in seconds) of the animation. |
duration | Get the duration in seconds of the current animation. |
loop | If true the animation will restart from the beginning when it reaches the end. |
skeleton | Get the skeleton for the current model. |
speed | Speed multiplier for animation play back. |
Methods
getAnimation | Return an animation. |
play | Start playing an animation. |
Inherited
Properties
enabled | Enables or disables the component. |
entity | The Entity that this Component is attached to. |
system | The ComponentSystem used to create this Component. |
Methods
fire | Fire an event, all additional arguments are passed on to the event listener. |
hasEvent | Test if there are any handlers bound to an event name. |
off | Detach an event handler from an event. |
on | Attach an event handler to an event. |
once | Attach an event handler to an event. |
Details
Constructor
AnimationComponent(system, entity)
Create a new AnimationComponent instance.
Parameters
system | AnimationComponentSystem | The ComponentSystem that created this component. |
entity | Entity | The Entity that this component is attached to. |
Properties
Get the duration in seconds of the current animation. Returns 0 if no animation is playing.
Get the skeleton for the current model. If the model is loaded from glTF/glb, then the skeleton is null.
Speed multiplier for animation play back. 1 is playback at normal speed and 0 pauses the animation.
Methods
getAnimation(name)
Return an animation.
Parameters
name | string | The name of the animation asset. |
Returns
AnimationAn Animation.
play(name, [blendTime])
Start playing an animation.
Parameters
name | string | The name of the animation asset to begin playing. |
blendTime | number | The time in seconds to blend from the current animation state to the start of the animation being set. Defaults to 0. |
Inherited
Properties
Methods
fire(name, [arg1], [arg2], [arg3], [arg4], [arg5], [arg6], [arg7], [arg8])
Fire an event, all additional arguments are passed on to the event listener.
obj.fire('test', 'This is the message');
Parameters
name | string | Name of event to fire. |
arg1 | * | First argument that is passed to the event handler. |
arg2 | * | Second argument that is passed to the event handler. |
arg3 | * | Third argument that is passed to the event handler. |
arg4 | * | Fourth argument that is passed to the event handler. |
arg5 | * | Fifth argument that is passed to the event handler. |
arg6 | * | Sixth argument that is passed to the event handler. |
arg7 | * | Seventh argument that is passed to the event handler. |
arg8 | * | Eighth argument that is passed to the event handler. |
Returns
EventHandlerSelf for chaining.
hasEvent(name)
Test if there are any handlers bound to an event name.
obj.on('test', function () { }); // bind an event to 'test'
obj.hasEvent('test'); // returns true
obj.hasEvent('hello'); // returns false
Parameters
name | string | The name of the event to test. |
Returns
booleanTrue if the object has handlers bound to the specified event name.
off([name], [callback], [scope])
Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.
const handler = function () {
};
obj.on('test', handler);
obj.off(); // Removes all events
obj.off('test'); // Removes all events called 'test'
obj.off('test', handler); // Removes all handler functions, called 'test'
obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this
Parameters
name | string | Name of the event to unbind. |
callback | HandleEventCallback | Function to be unbound. |
scope | object | Scope that was used as the this when the event is fired. |
Returns
EventHandlerSelf for chaining.
on(name, callback, [scope])
Attach an event handler to an event.
obj.on('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
const evt = obj.on('test', function (a, b) {
console.log(a + b);
});
// some time later
evt.off();
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandleCan be used for removing event in the future.
once(name, callback, [scope])
Attach an event handler to an event. This handler will be removed after being fired once.
obj.once('test', function (a, b) {
console.log(a + b);
});
obj.fire('test', 1, 2); // prints 3 to the console
obj.fire('test', 1, 2); // not going to get handled
Parameters
name | string | Name of the event to bind the callback to. |
callback | HandleEventCallback | Function that is called when event is fired. Note the callback is limited to 8 arguments. |
scope | object | Object to use as 'this' when the event is fired, defaults to current this. |
Returns
EventHandle- can be used for removing event in the future.