You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
139 lines
4.5 KiB
HTML
139 lines
4.5 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8" />
|
|
<base href="../../../" />
|
|
<script src="page.js"></script>
|
|
<link type="text/css" rel="stylesheet" href="page.css" />
|
|
</head>
|
|
<body>
|
|
<h1>[name]</h1>
|
|
|
|
<p class="desc">Base class for implementing loaders.</p>
|
|
|
|
<h2>Constructor</h2>
|
|
|
|
<h3>[name]( [param:LoadingManager manager] )</h3>
|
|
<p>
|
|
[page:LoadingManager manager] — The [page:LoadingManager loadingManager]
|
|
for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
|
|
</p>
|
|
<p>Creates a new [name].</p>
|
|
|
|
<h2>Properties</h2>
|
|
|
|
<h3>[property:String crossOrigin]</h3>
|
|
<p>
|
|
The crossOrigin string to implement CORS for loading the url from a
|
|
different domain that allows CORS. Default is `anonymous`.
|
|
</p>
|
|
|
|
<h3>[property:Boolean withCredentials]</h3>
|
|
<p>
|
|
Whether the XMLHttpRequest uses credentials. See
|
|
[page:.setWithCredentials]. Default is `false`.
|
|
</p>
|
|
|
|
<h3>[property:LoadingManager manager]</h3>
|
|
<p>
|
|
The [page:LoadingManager loadingManager] the loader is using. Default is
|
|
[page:DefaultLoadingManager].
|
|
</p>
|
|
|
|
<h3>[property:String path]</h3>
|
|
<p>
|
|
The base path from which the asset will be loaded. Default is the empty
|
|
string.
|
|
</p>
|
|
|
|
<h3>[property:String resourcePath]</h3>
|
|
<p>
|
|
The base path from which additional resources like textures will be
|
|
loaded. Default is the empty string.
|
|
</p>
|
|
|
|
<h3>[property:Object requestHeader]</h3>
|
|
<p>
|
|
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.
|
|
</p>
|
|
|
|
<h2>Methods</h2>
|
|
|
|
<h3>[method:undefined load]()</h3>
|
|
<p>
|
|
This method needs to be implemented by all concrete loaders. It holds the
|
|
logic for loading the asset from the backend.
|
|
</p>
|
|
|
|
<h3>
|
|
[method:Promise loadAsync]( [param:String url], [param:Function onProgress] )
|
|
</h3>
|
|
<p>
|
|
[page:String url] — A string containing the path/URL of the file to be
|
|
loaded.<br />
|
|
[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.<br />
|
|
</p>
|
|
<p>
|
|
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].
|
|
</p>
|
|
<p>
|
|
[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].
|
|
</p>
|
|
|
|
<h3>[method:undefined parse]()</h3>
|
|
<p>
|
|
This method needs to be implemented by all concrete loaders. It holds the
|
|
logic for parsing the asset into three.js entities.
|
|
</p>
|
|
|
|
<h3>[method:this setCrossOrigin]( [param:String crossOrigin] )</h3>
|
|
<p>
|
|
[page:String crossOrigin] — The crossOrigin string to implement CORS for
|
|
loading the url from a different domain that allows CORS.
|
|
</p>
|
|
|
|
<h3>[method:this setWithCredentials]( [param:Boolean value] )</h3>
|
|
<p>
|
|
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].<br />
|
|
Note that this has no effect if you are loading files locally or from the
|
|
same domain.
|
|
</p>
|
|
|
|
<h3>[method:this setPath]( [param:String path] )</h3>
|
|
<p>[page:String path] — Set the base path for the asset.</p>
|
|
|
|
<h3>[method:this setResourcePath]( [param:String resourcePath] )</h3>
|
|
<p>
|
|
[page:String resourcePath] — Set the base path for dependent resources
|
|
like textures.
|
|
</p>
|
|
|
|
<h3>[method:this setRequestHeader]( [param:Object requestHeader] )</h3>
|
|
<p>
|
|
[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.<br /><br />
|
|
|
|
Set the
|
|
[link:https://developer.mozilla.org/en-US/docs/Glossary/Request_header request header] used in HTTP request.
|
|
</p>
|
|
|
|
<h2>Source</h2>
|
|
|
|
<p>
|
|
[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
|
|
</p>
|
|
</body>
|
|
</html>
|