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
b973152c38 37bccc2d35
commit
f4385e2387
5 changed files with 209 additions and 0 deletions
Split View Show Diff Stats
  1. 47 0
      docs/api/loaders/GeometryLoader.html
  2. 50 0
      docs/api/loaders/ImageLoader.html
  3. 48 0
      docs/api/loaders/LoadingMonitor.html
  4. 60 0
      docs/api/loaders/TextureLoader.html
  5. 4 0
      docs/list.js

+ 47 - 0
docs/api/loaders/GeometryLoader.html
View File 

@@ -0,0 +1,47 @@
 
+<!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 a geometry out of a JSON file.</div>
 
+		<div class="desc">Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when <em>things</em> happen, you need to add listeners to the object.</div>
 
+		<div class="desc">Possible events:<br />
 
+			<ul>
 
+				<li>type: error, message: error message</li>
 
+				<li>type: load, content: loaded geometry</li>
 
+			</ul>
 
+		</div>
 
+
 
+		<h2>Constructor</h2>
 
+
 
+		<h3>[name]()</h3>
 
+
 
+		<h2>Methods</h2>
 
+
 
+		<h3>.load( [page:String url] )</h3>
 
+		<div>
 
+		url — required
 
+		</div>
 
+		
+		<div class="desc">Begin loading from <em>url</em></div>
 
+
 
+
 
+		<h3>.parse( [page:Object data], [page:LoadingMonitor monitor] )</h3>
 
+		<div>
 
+		data — required<br />
 
+		monitor — optional
 
+		</div>
 
+		
+		<div class="desc">Parses the geometry in the <em>data</em> object, optionally monitoring its progress via the <em>monitor</em> object, if provided.</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 50 - 0
docs/api/loaders/ImageLoader.html
View File 

@@ -0,0 +1,50 @@
 
+<!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 [page:Image image].</div>
 
+		<div class="desc">Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when <em>things</em> happen, you need to add listeners to the object.</div>
 
+		
+		<h2>Constructor</h2>
 
+
 
+		<h3>[name]()</h3>
 
+
 
+		<h2>Methods</h2>
 
+
 
+		<h3>.load( [page:String url] )</h3>
 
+		<div>
 
+		url — required
 
+		</div>
 
+		
+		<div class="desc">Begin loading from <em>url</em></div>
 
+
 
+		<h2>Events</h2>
 
+		
+		<h3>load</h3>
 
+		<div class="desc">
 
+		Dispatched when the image has completed loading
 
+		</div>
 
+		<div>
 
+		content — loaded image
 
+		</div>
 
+		
+		<h3>error</h3>
 
+		<div class="desc">
 
+		Dispatched when the image can't be loaded
 
+		</div>
 
+		<div>
 
+		message — error message
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 48 - 0
docs/api/loaders/LoadingMonitor.html
View File 

@@ -0,0 +1,48 @@
 
+<!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 LoadingMonitor keeps track of loaded and pending data.</div>
 
+		<div class="desc">To keep track of a loader, just add it to the monitor:</div>
 
+<code>monitor.add( imageLoader );
 
+</code>
 
+
 
+		<h2>Constructor</h2>
 
+
 
+		<h3>[name]()</h3>
 
+
 
+		<h2>Events</h2>
 
+		
+		<h3>progress</h3>
 
+		<div class="desc">
 
+		Dispatched each time a monitored loader completes loading
 
+		</div>
 
+		<div>
 
+		loaded — number of completed loaders<br />
 
+		total — total number of loaders monitored by this monitor
 
+		</div>
 
+		
+		<h3>load</h3>
 
+		<div id="desc">
 
+		Dispatched when all loaders have completed loading
 
+		</div>
 
+
 
+		<h2>Methods</h2>
 
+
 
+		<h3>.add( [page:Loader loader] )</h3>
 
+		<div>
 
+		loader — required. Loader to be monitored.
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 60 - 0
docs/api/loaders/TextureLoader.html
View File 

@@ -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">Class for loading a [page:Texture texture].</div>
 
+		<div class="desc">Unlike other loaders, this one emits events instead of using predefined callbacks. So if you're interested in getting notified when <em>things</em> happen, you need to add listeners to the object.</div>
 
+
 
+		<h2>Constructor</h2>
 
+
 
+		<h3>[name]()</h3>
 
+		
+		
+		<h2>Methods</h2>
 
+
 
+		<h3>.load( [page:String url] )</h3>
 
+		<div>
 
+		url — required
 
+		</div>
 
+		
+		<div class="desc">Begin loading from <em>url</em></div>
 
+
 
+
 
+		<h2>Properties</h2>
 
+
 
+		<h3>.crossOrigin</h3>
 
+		<div>
 
+		default — *null*.<br />
 
+		If set, assigns the *crossOrigin* attribute of the image to the value of *crossOrigin*, prior to starting the load.
 
+		</div>
 
+
 
+		<h2>Events</h2>
 
+		
+		<h3>load</h3>
 
+		<div class="desc">
 
+		Dispatched when the texture has completed loading
 
+		</div>
 
+		<div>
 
+		content — loaded texture object
 
+		</div>
 
+		
+		<h3>error</h3>
 
+		<div class="desc">
 
+		Dispatched when the texture can't be loaded
 
+		</div>
 
+		<div>
 
+		message — error message
 
+		</div>
 
+
 
+		<h2>Source</h2>
 
+
 
+		[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
 
+	</body>
 
+</html>

+ 4 - 0
docs/list.js
View File 

@@ -40,8 +40,12 @@ var list = {
 
 	"Loaders": [
 
 		[ "Loader", "loaders/Loader" ],
 
 		[ "BinaryLoader", "loaders/BinaryLoader" ],
 
+		[ "GeometryLoader", "loaders/GeometryLoader" ],
 
+		[ "ImageLoader", "loaders/ImageLoader" ],
 
 		[ "JSONLoader", "loaders/JSONLoader" ],
 
+		[ "LoadingMonitor", "loaders/LoadingMonitor" ],
 
 		[ "SceneLoader", "loaders/SceneLoader" ],
 
+		[ "TextureLoader", "loaders/TextureLoader" ],
 
 	],
 
 
 	"Materials": [