浏览代码

Merge branch 'dev' of https://github.com/gero3/three.js into dev

Mr.doob 11 年之前
父节点
当前提交
b15de8c771
共有 2 个文件被更改,包括 40 次插入104 次删除
  1. 18 58
      docs/api/loaders/ImageLoader.html
  2. 22 46
      docs/api/loaders/MaterialLoader.html

+ 18 - 58
docs/api/loaders/ImageLoader.html

@@ -10,85 +10,45 @@
 		<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>
-		<div>
-		todo
-		</div>
-
-		
-		<h2>Events</h2>
-		
-		<h3>load</h3>
-		<div class="desc">
-		Dispatched when the image has completed loading
-		</div>
+		<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>
-		content — loaded image
-		</div>
-		
-		<h3>error</h3>
-		<div class="desc">
-		Dispatched when the image can't be loaded
-		</div>
-		<div>
-		message — error message
+		Creates a new [name].
 		</div>
 		
 		<h2>Properties</h2>
 
-		<h3>.[page:object crossOrigin]</h3>
+		<h3>.[page:string crossOrigin]</h3>
 		<div>
-		todo
+		The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
 		</div> 
 
 		<h2>Methods</h2>
 
-		<h3>.load( [page:String url] )</h3>
+		<h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] ) [page:Image]</h3>
 		<div>
+        onLoad -- Will be called when load completes. The argument will be the loaded Imageloader.
+        onProgress -- Will be called while load progresses. The argument will be the progress event.
+        onError -- Will be called when load errors.
 		url — required
 		</div>
-		
-		<div class="desc">Begin loading from <em>url</em></div>
-
-		<h3>.dispatchEvent([page:todo event]) [page:todo]</h3>
-		<div>
-		event -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h3>.hasEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
-		<div>
-		type -- todo <br />
-		listener -- todo
-		</div>
 		<div>
-		todo
-		</div>
+        Begin loading from url and return the [page:Image image] object that will contain the data.
+        </div>
 
-		<h3>.removeEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
-		<div>
-		type -- todo <br />
-		listener -- todo
-		</div>
+        <h3>.setCrossOrigin([page:String value])</h3>
 		<div>
-		todo
+        value -- The crossOrigin string.
 		</div>
-
-		<h3>.addEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
 		<div>
-		type -- todo <br />
-		listener -- todo
-		</div>
-		<div>
-		todo
-		</div>
+        The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
+        </div>
 
 		<h2>Source</h2>
 

+ 22 - 46
docs/api/loaders/MaterialLoader.html

@@ -9,72 +9,48 @@
 	<body>
 		<h1>[name]</h1>
 
-		<div class="desc">todo</div>
-
+		<div class="desc">A loader for loading an [page:Material material].</div>
 
 		<h2>Constructor</h2>
 
 
-		<h3>[name]()</h3>
+		<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>
-		todo
+		Creates a new [name].
 		</div>
 
 
 		<h2>Methods</h2>
 
-
-
-		<h3>.load([page:todo url]) [page:todo]</h3>
-		<div>
-		url -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h3>.removeEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
-		<div>
-		type -- todo <br />
-		listener -- todo
-		</div>
-		<div>
-		todo
-		</div>
-
-		<h3>.parse([page:todo json]) [page:todo]</h3>
+		<h3>.load( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] ) [page:Image]</h3>
 		<div>
-		json -- todo
+        onLoad -- Will be called when load completes. The argument will be the loaded Imageloader.
+        onProgress -- Will be called while load progresses. The argument will be the progress event.
+        onError -- Will be called when load errors.
+		url — required
 		</div>
 		<div>
-		todo
-		</div>
+        Begin loading from url and return the [page:Material material] object that will contain the data.
+        </div>
 
-		<h3>.addEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
+        <h3>.setCrossOrigin([page:String value])</h3>
 		<div>
-		type -- todo <br />
-		listener -- todo
+        value -- The crossOrigin string.
 		</div>
 		<div>
-		todo
-		</div>
+        The crossOrigin string to implement CORS for loading the url from a different domain that allows CORS.
+        </div>
 
-		<h3>.dispatchEvent([page:todo event]) [page:todo]</h3>
-		<div>
-		event -- todo
+        <h3>.parse([page:Object json]) {
+        <div>
+        json -- The json object containing the parameters of the Material.
 		</div>
 		<div>
-		todo
-		</div>
-
-		<h3>.hasEventListener([page:todo type], [page:todo listener]) [page:todo]</h3>
-		<div>
-		type -- todo <br />
-		listener -- todo
-		</div>
-		<div>
-		todo
-		</div>
+        Creates a new [page:Material material] of the type 'json.type' and with parameters defined in the json object.
+        </div>
 
 		<h2>Source</h2>