|
|
@@ -10,10 +10,20 @@
|
|
|
<body>
|
|
|
<h1>[name]</h1>
|
|
|
|
|
|
- <div class="desc">A loader for loading an [page:Image].</div>
|
|
|
+ <div class="desc">
|
|
|
+ A loader for loading an [page:Image].
|
|
|
+
|
|
|
+ This uses the [page:FileLoader] internally for loading files, and is used internally by the
|
|
|
+ [page:CubeTextureLoader], [page:ObjectLoader] and [page:TextureLoader].
|
|
|
+ </div>
|
|
|
|
|
|
<h2>Example</h2>
|
|
|
|
|
|
+ <div>
|
|
|
+ [example:webgl_loader_obj WebGL / loader / obj]<br />
|
|
|
+ [example:webgl_shaders_ocean WebGL / shaders / ocean]
|
|
|
+ </div>
|
|
|
+
|
|
|
<code>
|
|
|
// instantiate a loader
|
|
|
var loader = new THREE.ImageLoader();
|
|
|
@@ -42,15 +52,13 @@
|
|
|
);
|
|
|
</code>
|
|
|
|
|
|
- [example:webgl_shaders_ocean]
|
|
|
-
|
|
|
+
|
|
|
<h2>Constructor</h2>
|
|
|
|
|
|
<h3>[name]( [page:LoadingManager manager] )</h3>
|
|
|
<div>
|
|
|
- [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
|
|
|
- </div>
|
|
|
- <div>
|
|
|
+ [page:LoadingManager manager] — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].<br /><br />
|
|
|
+
|
|
|
Creates a new [name].
|
|
|
</div>
|
|
|
|
|
|
@@ -58,14 +66,30 @@
|
|
|
|
|
|
<h3>[property:String crossOrigin]</h3>
|
|
|
<div>
|
|
|
- The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
|
|
|
+ If set, assigns the [link:https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_settings_attributes crossOrigin]
|
|
|
+ attribute of the image to the value of *crossOrigin*, prior to starting the load. Default is *undefined*.
|
|
|
+ </div>
|
|
|
+
|
|
|
+ <h3>[property:LoadingManager manager]</h3>
|
|
|
+ <div>
|
|
|
+ The [page:LoadingManager loadingManager] the loader is using. Default is [page:DefaultLoadingManager].
|
|
|
+ </div>
|
|
|
+
|
|
|
+ <h3>[property:String path]</h3>
|
|
|
+ <div>The base path from which files will be loaded. See [page:.setPath]. Default is *undefined*.</div>
|
|
|
+
|
|
|
+ <h3>[property:String withCredentials]</h3>
|
|
|
+ <div>
|
|
|
+ Whether the XMLHttpRequest uses credentials - see [page:.setWithCredentials].
|
|
|
+ Default is *undefined*.
|
|
|
</div>
|
|
|
|
|
|
<h2>Methods</h2>
|
|
|
|
|
|
<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
|
|
|
<div>
|
|
|
- [page:String url] — required<br />
|
|
|
+ [page:String url] — the path or URL to the file. This can also be a
|
|
|
+ [link:https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/Data_URIs Data URI].<br />
|
|
|
[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Image image].<br />
|
|
|
[page:Function onProgress] — Will be called while load progresses. The argument will be the progress event.<br />
|
|
|
[page:Function onError] — Will be called when load errors.<br />
|
|
|
@@ -75,12 +99,20 @@
|
|
|
</div>
|
|
|
|
|
|
<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
|
|
|
+ <div>Set the [page:.crossOrigin] attribute.</div>
|
|
|
+
|
|
|
+ <h3>[method:FileLoader setPath]( [page:String path] )</h3>
|
|
|
<div>
|
|
|
- [page:String value] — The crossOrigin string.
|
|
|
+ Set the base path or URL from which to load files. This can be useful if
|
|
|
+ you are loading many models from the same directory.
|
|
|
</div>
|
|
|
+
|
|
|
+ <h3>[method:FileLoader setWithCredentials]( [page:Boolean value] )</h3>
|
|
|
+ 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.
|
|
|
<div>
|
|
|
- The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
|
|
|
- </div>
|
|
|
|
|
|
<h2>Source</h2>
|
|
|
|
looeee