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

Updated CubeTextureLoader doc

looeee 8 years ago
parent
51fc1c8f00
commit
ab28e7bc8e
3 changed files with 32 additions and 25 deletions
Unified View Show Diff Stats
  1. 1 1
      docs/api/loaders/CompressedTextureLoader.html
  2. 29 22
      docs/api/loaders/CubeTextureLoader.html
  3. 2 2
      docs/api/loaders/FileLoader.html

+ 1 - 1
docs/api/loaders/CompressedTextureLoader.html
View File 

@@ -61,7 +61,7 @@
 
 
 
 		<h3>[method:FileLoader setPath]( [page:String path] )</h3>
 
 		<h3>[method:FileLoader setPath]( [page:String path] )</h3>
 
 		<div>
 
 		<div>
 
-			Set the base path or URL from which to load files. This can be useful if, for example,
 
+			Set the base path or URL from which to load files. This can be useful if
 
 			you are loading many textures from the same directory.
 
 			you are loading many textures from the same directory.
 
 		</div>
 
 		</div>

+ 29 - 22
docs/api/loaders/CubeTextureLoader.html
View File 

@@ -10,10 +10,22 @@
 
 	<body>
 
 	<body>
 
 		<h1>[name]</h1>
 
 		<h1>[name]</h1>
 
 
 
-		<div class="desc">Class for loading a [page:CubeTexture CubeTexture].</div>
 
+		<div class="desc">
 
+			Class for loading a [page:CubeTexture CubeTexture].
 
+			This uses the [page:ImageLoader] internally for loading files.
 
+		</div>
 
 
 
 		<h2>Example</h2>
 
 		<h2>Example</h2>
 
 
 
+		<div>
 
+			[example:webgl_materials_cubemap materials / cubemap]<br />
 
+			[example:webgl_materials_cubemap_balls_reflection materials / cubemap / balls / reflection]<br />
 
+			[example:webgl_materials_cubemap_balls_refraction materials / cubemap / balls / refraction]<br />
 
+			[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
 
+			[example:webgl_materials_cubemap_dynamic2 materials / cubemap / dynamic2]<br />
 
+			[example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
 
+		</div>
 
+
 
 		<code>
 
 		<code>
 
 var scene = new THREE.Scene();
 
 var scene = new THREE.Scene();
 
 scene.background = new THREE.CubeTextureLoader()
 
 scene.background = new THREE.CubeTextureLoader()
 
@@ -28,22 +40,12 @@ scene.background = new THREE.CubeTextureLoader()
 
 			] );
 
 			] );
 
 		</code>
 
 		</code>
 
 
 
-		<div>
 
-			[example:webgl_materials_cubemap materials / cubemap]<br />
 
-			[example:webgl_materials_cubemap_balls_reflection materials / cubemap / balls / reflection]<br />
 
-			[example:webgl_materials_cubemap_balls_refraction materials / cubemap / balls / refraction]<br />
 
-			[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic]<br />
 
-			[example:webgl_materials_cubemap_dynamic2 materials / cubemap / dynamic2]<br />
 
-			[example:webgl_materials_cubemap_refraction materials / cubemap / refraction]
 
-		</div>
 
-
 
 		<h2>Constructor</h2>
 
 		<h2>Constructor</h2>
 
 
 
 		<h3>[name]( [page:LoadingManager manager] )</h3>
 
 		<h3>[name]( [page:LoadingManager manager] )</h3>
 
 		<div>
 
 		<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].
 
 		Creates a new [name].
 
 		</div>
 
 		</div>
 
 
 
@@ -52,16 +54,22 @@ scene.background = new THREE.CubeTextureLoader()
 
 
 
 		<h3>[property:String crossOrigin]</h3>
 
 		<h3>[property:String crossOrigin]</h3>
 
 		<div>
 
 		<div>
 
-		default — *null*.<br />
 
-		If set, assigns the *crossOrigin* attribute of the image to the value of *crossOrigin*, prior to starting the load.
 
+		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>
 
 		</div>
 
 
 
 
 
 		<h2>Methods</h2>
 
 		<h2>Methods</h2>
 
 
 
-		<h3>[method:null load]( [page:String url], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 
+		<h3>[method:null load]( [page:String urls], [page:Function onLoad], [page:Function onProgress], [page:Function onError] )</h3>
 
 		<div>
 
 		<div>
 
-		[page:String url] — required<br />
 
+		[page:String urls] — array of 6 urls to images, one for each side of the CubeTexture.<br />
 
 		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
 
 		[page:Function onLoad] — Will be called when load completes. The argument will be the loaded [page:Texture texture].<br />
 
 		[page:Function 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 />
 
 		[page:Function 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 />
 
 		[page:Function onError] — Will be called when load errors.<br />
 
 		[page:Function onError] — Will be called when load errors.<br />
 
@@ -71,13 +79,12 @@ scene.background = new THREE.CubeTextureLoader()
 
 		</div>
 
 		</div>
 
 
 
 		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 
 		<h3>[method:null setCrossOrigin]( [page:String value] )</h3>
 
-		<div>
 
-		Set the crossOrigin attribute.
 
-		</div>
 
+		<div>		Set the [page:.crossOrigin] attribute.</div>
 
 
 
-		<h3>[method:null setPath]( [page:String value] )</h3>
 
+		<h3>[method:FileLoader setPath]( [page:String path] )</h3>
 
 		<div>
 
 		<div>
 
-		Set the path from which to load textures.	
+			Set the base path or URL from which to load files. This can be useful if
 
+			you are loading many textures from the same directory.
 
 		</div>
 
 		</div>
 
 
 
 		<h2>Source</h2>
 
 		<h2>Source</h2>

+ 2 - 2
docs/api/loaders/FileLoader.html
View File 

@@ -115,8 +115,8 @@ loader.load(
 
 
 
 		<h3>[method:FileLoader setPath]( [page:String path] )</h3>
 
 		<h3>[method:FileLoader setPath]( [page:String path] )</h3>
 
 		<div>
 
 		<div>
 
-			Set the base path or URL from which to load files. This can be useful if, for example, you are loading many models from the
 
-		same directory.
 
+			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>
 
 		</div>
 
 
 
 		<h3>[method:FileLoader setResponseType]( [page:String responseType] )</h3>
 
 		<h3>[method:FileLoader setResponseType]( [page:String responseType] )</h3>