Skip to main content

Loader

AnimationLoader

Class for loading AnimationClips in JSON format. This uses the FileLoader internally for loading files.

Code Example

// instantiate a loader const loader = new THREE.AnimationLoader(); // load a
resource loader.load( // resource URL 'animations/animation.js', // onLoad
callback function ( animations ) { // animations is an array of AnimationClips
}, // onProgress callback function ( xhr ) { console.log( (xhr.loaded /
xhr.total * 100) + '% loaded' ); }, // onError callback function ( err ) {
console.log( 'An error happened' ); } );

Constructor

AnimationLoader

function AnimationLoader( manager: LoadingManager ): void;  

manager — The loadingManager for the loader to use. Default is THREE.DefaultLoadingManager.

Creates a new AnimationLoader.

Properties

See the base Loader class for common properties.

Methods

See the base Loader class for common methods.

load

function load( url: String, onLoad: Function, onProgress: Function, onError:
Function ): undefined;

url — the path or URL to the file. This can also be a Data URI.
onLoad — Will be called when load completes. The argument will be the loaded animation clips.
onProgress (optional) — Will be called while load progresses. The argument will be the ProgressEvent instance, which contains .lengthComputable, .total and .loaded. If the server does not set the Content-Length header; .total will be 0.
onError (optional) — Will be called if load errors.

Begin loading from url and pass the loaded animation to onLoad.

parse

function parse( json: JSON ): Array;  

json — required

Parse the JSON object and return an array of animation clips. Individual clips in the object will be parsed with AnimationClip.parse.

Source

src/loaders/AnimationLoader.js