Strona główna Odkrywaj Pomoc
Zaloguj się
javascript
/
three.js
kopia lustrzana https://github.com/tazdij/three.js.git
2
0
Forkuj 0
Pliki Problemy 0 Wiki
Przeglądaj źródła

loaders documentation: xhrloader, objloader, mtlloader

Vincent Lark 10 lat temu
rodzic
832377e3ec
commit
18c6f4f9ab
4 zmienionych plików z 175 dodań i 31 usunięć
Zunifikowany widok Pokaż statystyki zmian
  1. 56 0
      docs/api/loaders/MTLLoader.html
  2. 60 0
      docs/api/loaders/OBJLoader.html
  3. 56 30
      docs/api/loaders/XHRLoader.html
  4. 3 1
      docs/list.js

+ 56 - 0
docs/api/loaders/MTLLoader.html
Wyświetl plik 

@@ -0,0 +1,56 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+    <head>
 
+        <meta charset="utf-8" />
 
+        <script src="../../list.js"></script>
 
+        <script src="../../page.js"></script>
 
+        <link type="text/css" rel="stylesheet" href="../../page.css" />
 
+    </head>
 
+    <body>
 
+
 
+        <h1>[name]</h1>
 
+
 
+        <div class="desc">A loader for loading an <em>.obj</em> resource.</div>
 
+
 
+
 
+        <h2>Constructor</h2>
 
+
 
+        <h3>[name]([page:String baseUrl], [page:Object options], [page:String crossOrigin])</h3>
 
+        <div>
 
+        baseUrl — The base url from which to find subsequent resources.<br />
 
+        options — Options passed to the created material (side, wrap, normalizeRGB, ignoreZeroRGBs, invertTransparency).<br />
 
+        crossOrigin — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.<br />
 
+        </div>
 
+        <div>
 
+        Creates a new [name].
 
+        </div>
 
+
 
+        <h2>Properties</h2>
 
+
 
+
 
+        <h2>Methods</h2>
 
+
 
+        <h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 
+        <div>
 
+        url — required<br />
 
+        onLoad — Will be called when load completes. The argument will be the loaded [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator] instance.<br />
 
+        onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
 
+        onError — Will be called when load errors.<br />
 
+        </div>
 
+        <div>
 
+        Begin loading from url and return the loaded material.
 
+        </div>
 
+
 
+        <h3>.parse([page:String text])</h3>
 
+        <div>
 
+        text — The textual <em>obj</em> structure to parse.
 
+        </div>
 
+        <div>
 
+        Parse a <em>mtl</em> text structure and returns a [page:MTLLoaderMaterialCreator MTLLoader.MaterialCreator] instance.<br />
 
+        </div>
 
+
 
+        <h2>Source</h2>
 
+
 
+        [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/[name].js examples/js/loaders/[name].js]
 
+    </body>
 
+</html>

+ 60 - 0
docs/api/loaders/OBJLoader.html
Wyświetl plik 

@@ -0,0 +1,60 @@
 
+<!DOCTYPE html>
 
+<html lang="en">
 
+    <head>
 
+        <meta charset="utf-8" />
 
+        <script src="../../list.js"></script>
 
+        <script src="../../page.js"></script>
 
+        <link type="text/css" rel="stylesheet" href="../../page.css" />
 
+    </head>
 
+    <body>
 
+
 
+        <h1>[name]</h1>
 
+
 
+        <div class="desc">A loader for loading an <em>.obj</em> resource.</div>
 
+
 
+
 
+        <h2>Constructor</h2>
 
+
 
+        <h3>[name]([page:LoadingManager manager])</h3>
 
+        <div>
 
+        manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 
+        </div>
 
+        <div>
 
+        Creates a new [name].
 
+        </div>
 
+
 
+        <h2>Properties</h2>
 
+
 
+
 
+        <h2>Methods</h2>
 
+
 
+        <h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 
+        <div>
 
+        url — required<br />
 
+        onLoad — Will be called when load completes. The argument will be the loaded [page:Object3D object].<br />
 
+        onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
 
+        onError — Will be called when load errors.<br />
 
+        </div>
 
+        <div>
 
+        Begin loading from url and return the [page:String text] response that will contain the data.
 
+        </div>
 
+
 
+        <h3>.parse([page:String text])</h3>
 
+        <div>
 
+        text — The textual <em>obj</em> structure to parse.
 
+        </div>
 
+        <div>
 
+        Parse an <em>obj</em> text structure and returns an [page:Object3D object].<br />
 
+        Found objects are converted to [page:Mesh meshs] with a [page:BufferGeometry BufferGeometry] and a default [page:MeshLambertMaterial MeshLambertMaterial].
 
+        </div>
 
+
 
+        <h2>Example</h2>
 
+
 
+        [link:http://threejs.org/examples/#webgl_loader_obj]
 
+
 
+
 
+        <h2>Source</h2>
 
+
 
+        [link:https://github.com/mrdoob/three.js/blob/master/examples/js/loaders/OBJLoader.js examples/js/loaders/OBJLoader.js]
 
+    </body>
 
+</html>

+ 56 - 30
docs/api/loaders/XHRLoader.html
Wyświetl plik 

@@ -1,46 +1,72 @@
 
 <!DOCTYPE html>
 
 <!DOCTYPE html>
 
 <html lang="en">
 
 <html lang="en">
 
-	<head>
 
-		<meta charset="utf-8" />
 
-		<script src="../../list.js"></script>
 
-		<script src="../../page.js"></script>
 
-		<link type="text/css" rel="stylesheet" href="../../page.css" />
 
-	</head>
 
-	<body>
 
-		<h1>[name]</h1>
 
+    <head>
 
+        <meta charset="utf-8" />
 
+        <script src="../../list.js"></script>
 
+        <script src="../../page.js"></script>
 
+        <link type="text/css" rel="stylesheet" href="../../page.css" />
 
+    </head>
 
+    <body>
 
 
 
-		<div class="desc">todo</div>
 
+        <h1>[name]</h1>
 
 
 
-		<h2>Example</h2>
 
+        <div class="desc">A low level class for loading resources with XmlHttpRequest.</div>
 
 
 
-		<code>todo</code>
 
 
 
-		<h2>Constructor</h2>
 
+        <h2>Constructor</h2>
 
 
 
+        <h3>[name]([page:LoadingManager manager])</h3>
 
+        <div>
 
+        manager — The [page:LoadingManager loadingManager] for the loader to use. Default is [page:LoadingManager THREE.DefaultLoadingManager].
 
+        </div>
 
+        <div>
 
+        Creates a new [name].
 
+        </div>
 
 
 
-		<h3>todo</h3>
 
-		<div></div>
 
 
 
+        <h2>Properties</h2>
 
 
 
-		<h2>Properties</h2>
 
+        <h3>.[page:Cache cache]</h3>
 
+        <div>
 
+        A [page:Cache cache] instance that hold the response from each request made through this loader, so each file is requested once.
 
+        </div>
 
 
 
-		<h3>todo</h3>
 
-		<div>
 
-		todo
 
-		</div> 
+        <h3>.[page:string crossOrigin]</h3>
 
+        <div>
 
+        The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 
+        </div>
 
 
 
+        <h3>.[page:string responseType]</h3>
 
+        <div>
 
+        Can be set to change the response type.
 
+        </div>
 
 
 
-		<h2>Methods</h2>
 
-		
 
 
-		<h3>todo</h3>
 
-		<div>todo</div>
 
-		<div>
 
-		todo
 
-		</div>
 
-		
-		<h2>Source</h2>
 
+        <h2>Methods</h2>
 
 
 
-		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
-	</body>
 
+        <h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 
+        <div>
 
+        url — required<br />
 
+        onLoad — Will be called when load completes. The argument will be the loaded text response.<br />
 
+        onProgress — Will be called while load progresses. The argument will be the XmlHttpRequest instance, that contain .[page:Integer total] and .[page:Integer loaded] bytes.<br />
 
+        onError — Will be called when load errors.<br />
 
+        </div>
 
+        <div>
 
+        Begin loading from url and return the [page:String text] response that will contain the data.
 
+        </div>
 
+
 
+        <h3>.setCrossOrigin([page:String value]</h3>
 
+        <div>
 
+        value — The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 
+        </div>
 
+
 
+        <h3>.setResponseType([page:String value]</h3>
 
+        <div>
 
+        value — the empty string (default), "arraybuffer", "blob", "document", "json", or "text".
 
+        </div>
 
+
 
+        <h2>Source</h2>
 
+
 
+        [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+    </body>
 
 </html>
 
 </html>

+ 3 - 1
docs/list.js
Wyświetl plik 

@@ -53,6 +53,8 @@ var list = {
 
 			[ "Loader", "api/loaders/Loader" ],
 
 			[ "Loader", "api/loaders/Loader" ],
 
 			[ "LoadingManager", "api/loaders/LoadingManager" ],
 
 			[ "LoadingManager", "api/loaders/LoadingManager" ],
 
 			[ "MaterialLoader", "api/loaders/MaterialLoader" ],
 
 			[ "MaterialLoader", "api/loaders/MaterialLoader" ],
 
+			[ "OBJLoader", "api/loaders/OBJLoader" ],
 
+			[ "MTLLoader", "api/loaders/MTLLoader" ],
 
 			[ "ObjectLoader", "api/loaders/ObjectLoader" ],
 
 			[ "ObjectLoader", "api/loaders/ObjectLoader" ],
 
 			[ "TextureLoader", "api/loaders/TextureLoader" ],
 
 			[ "TextureLoader", "api/loaders/TextureLoader" ],
 
 			[ "XHRLoader", "api/loaders/XHRLoader" ]
 
 			[ "XHRLoader", "api/loaders/XHRLoader" ]
 
@@ -157,7 +159,7 @@ var list = {
 
 			[ "CubeCamera", "api/extras/cameras/CubeCamera" ]
 
 			[ "CubeCamera", "api/extras/cameras/CubeCamera" ]
 
 		],
 
 		],
 
 
 
-		
+
 
 		"Extras / Core": [
 
 		"Extras / Core": [
 
 			[ "Curve", "api/extras/core/Curve" ],
 
 			[ "Curve", "api/extras/core/Curve" ],
 
 			[ "CurvePath", "api/extras/core/CurvePath" ],
 
 			[ "CurvePath", "api/extras/core/CurvePath" ],