Home Explore Help
Sign In
javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git
2
0
Fork 0
Files Issues 0 Wiki
Browse Source

Merge remote-tracking branch 'sole/dev' into dev

Mr.doob 13 years ago
parent
33a4517987 210072c5d0
commit
9a15ae0a3d
4 changed files with 57 additions and 35 deletions
Split View Show Diff Stats
  1. 8 10
      docs/api/loaders/BinaryLoader.html
  2. 7 9
      docs/api/loaders/JSONLoader.html
  3. 19 12
      docs/api/loaders/Loader.html
  4. 23 4
      docs/api/loaders/SceneLoader.html

+ 8 - 10
docs/api/loaders/BinaryLoader.html
View File 

@@ -7,26 +7,24 @@
 
 		<link type="text/css" rel="stylesheet" href="../../page.css" />
 
 	</head>
 
 	<body>
 
+		[page:Loader] &rarr;
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">A loader for loading models generated by the slim OBJ converter with BINARY option <em>(converter_obj_three_slim.py -t binary)</em></div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
-
 
-
 
-		<h2>Properties</h2>
 
-
 
-		<h3>.[page:Vector3 todo]</h3>
 
-
 
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 
 
 		<h2>Methods</h2>
 
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
 
+		<h3>.load( [page:String url], [page:Function callback], [page:String texturePath], [page:String binaryPath] )</h3>
 
 		<div>
 
-		todo — todo<br />
 
+		url — required<br />
 
+		callback — required. This function will be called with the loaded model as an instance of [page:Geometry geometry] when the load is completed.<br />
 
+		texturePath — optional. If not specified, textures will be assumed to be in the same folder as the Javascript model file.<br />
 
+		binaryPath — optional. If not specified, the binary file will be assumed to be in the same folder as the Javascript model file.
 
 		</div>

+ 7 - 9
docs/api/loaders/JSONLoader.html
View File 

@@ -7,26 +7,24 @@
 
 		<link type="text/css" rel="stylesheet" href="../../page.css" />
 
 	</head>
 
 	<body>
 
+		[page:Loader] &rarr;
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">A loader for loading objects in JSON format.</div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
-
 
-
 
-		<h2>Properties</h2>
 
-
 
-		<h3>.[page:Vector3 todo]</h3>
 
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 
 
 
 		<h2>Methods</h2>
 
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
 
+		<h3>.load( [page:String url], [page:Function callback], [page:String texturePath] )</h3>
 
 		<div>
 
-		todo — todo<br />
 
+		url — required<br />
 
+		callback — required. This function will be called with the loaded model as an instance of [page:Geometry geometry] when the load is completed.<br />
 
+		texturePath — optional. If not specified, textures will be assumed to be in the same folder as the Javascript model file.
 
 		</div>

+ 19 - 12
docs/api/loaders/Loader.html
View File 

@@ -9,26 +9,33 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">Base class for implementing loaders.</div>
 
 
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
 
+		<h3>[name]( [page:Boolean showStatus] )</h3>
 
 
 
 		<h2>Properties</h2>
 
 
-		<h3>.[page:Vector3 todo]</h3>
 
-
 
-
 
-		<h2>Methods</h2>
 
-
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
 
-		<div>
 
-		todo — todo<br />
 
-		</div>
 
-
 
+		<h3>.[page:Boolean showStatus]</h3>
 
+		<div>If true, show loading status in the statusDomElement.</div>
 
+		
+		<h3>.[page:DOMElement statusDomElement]</h3>
 
+		<div>This is the recipient of status messages.</div>
 
+		
+		<h3>.[page:Function onLoadStart]</h3>
 
+		<div>Will be called when load starts.</div>
 
+		<div>The default is a function with empty body.</div>
 
+
 
+		<h3>.[page:Function onLoadProgress]</h3>
 
+		<div>Will be called while load progresses.</div>
 
+		<div>The default is a function with empty body.</div>
 
+		
+		<h3>.[page:Function onLoadComplete]</h3>
 
+		<div>Will be called when load completes.</div>
 
+		<div>The default is a function with empty body.</div>
 
 
 		<h2>Source</h2>

+ 23 - 4
docs/api/loaders/SceneLoader.html
View File 

@@ -9,7 +9,7 @@
 
 	<body>
 
 		<h1>[name]</h1>
 
 
-		<div class="desc">todo</div>
 
+		<div class="desc">A loader for loading a complete scene out of a JSON file.</div>
 
 
 
 		<h2>Constructor</h2>
 
@@ -19,14 +19,33 @@
 
 
 		<h2>Properties</h2>
 
 
-		<h3>.[page:Vector3 todo]</h3>
 
+		<h3>.[page:Function onLoadStart]</h3>
 
+		<div>Will be called when load starts.</div>
 
+		<div>The default is a function with empty body.</div>
 
+
 
+		<h3>.[page:Function onLoadProgress]</h3>
 
+		<div>Will be called while load progresses.</div>
 
+		<div>The default is a function with empty body.</div>
 
+		
+		<h3>.[page:Function onLoadComplete]</h3>
 
+		<div>Will be called when each element in the scene completes loading.</div>
 
+		<div>The default is a function with empty body.</div>
 
+		
+		<h3>.[page:Function callbackSync]</h3>
 
+		<div>Will be called when load completes.</div>
 
+		<div>The default is a function with empty body.</div>
 
+		
+		<h3>.[page:Function callbackProgress]</h3>
 
+		<div>Will be called as load progresses.</div>
 
+		<div>The default is a function with empty body.</div>
 
 
 
 		<h2>Methods</h2>
 
 
-		<h3>.todo( [page:Vector3 todo] )</h3>
 
+		<h3>.load( [page:String url], [page:Function callbackFinished] )</h3>
 
 		<div>
 
-		todo — todo<br />
 
+		url — required<br />
 
+		callbackFinished — required. This function will be called with the loaded model as an instance of [page:Scene scene] when the load is completed.
 
 		</div>