[name]

Base class for implementing loaders.

Constructor

[name]( [param:LoadingManager manager] )

[page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].

Creates a new [name].

Properties

[property:String crossOrigin]

The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS. Default is `anonymous`.

[property:Boolean withCredentials]

Whether the XMLHttpRequest uses credentials. See [page:.setWithCredentials]. Default is `false`.

[property:LoadingManager manager]

The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].

[property:String path]

The base path from which the asset will be loaded. Default is the empty string.

[property:String resourcePath]

The base path from which additional resources like textures will be loaded. Default is the empty string.

[property:Object requestHeader]

The [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request. See [page:.setRequestHeader]. Default is empty object.

Methods

[method:undefined load]()

This method needs to be implement by all concrete loaders. It holds the logic for loading the asset from the backend.

[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )

[page:String url] — A string containing the path/URL of the file to be loaded.
[page:Function onProgress] (optional) — A function to be called while the loading is in progress. The argument will be the ProgressEvent instance, which contains .[page:Boolean lengthComputable], .[page:Integer total] and .[page:Integer loaded]. If the server does not set the Content-Length header; .[page:Integer total] will be 0.

This method is equivalent to [page:.load], but returns a [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise Promise].

[page:Function onLoad] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/resolve Promise.resolve] and [page:Function onError] is handled by [link:https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/reject Promise.reject].

[method:undefined parse]()

This method needs to be implement by all concrete loaders. It holds the logic for parsing the asset into three.js entities.

[method:this setCrossOrigin]( [param:String crossOrigin] )

[page:String crossOrigin] — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.

[method:this setWithCredentials]( [param:Boolean value] )

Whether the XMLHttpRequest uses credentials such as cookies, authorization headers or TLS client certificates. See [link:https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials XMLHttpRequest.withCredentials].
Note that this has no effect if you are loading files locally or from the same domain.

[method:this setPath]( [param:String path] )

[page:String path] — Set the base path for the asset.

[method:this setResourcePath]( [param:String resourcePath] )

[page:String resourcePath] — Set the base path for dependent resources like textures.

[method:this setRequestHeader]( [param:Object requestHeader] )

[page:Object requestHeader] - key: The name of the header whose value is to be set. value: The value to set as the body of the header.

Set the [link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request.

Source

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]