首页 发现 帮助
登录
javascript
/
three.js
镜像自地址 https://github.com/tazdij/three.js.git
2
0
派生 0
文件 工单管理 0 Wiki
浏览代码

Merge pull request #12748 from duhaime/document-texture-loader-progress

document lack of xhr progress in TextureLoader
Mr.doob 7 年之前
父节点
0e12847099 de21e1d5f9
当前提交
d75f390efd
共有 11 个文件被更改，包括 123 次插入 和 98 次删除
分列视图 显示文件统计
  1. 7 4
      docs/api/loaders/AnimationLoader.html
  2. 7 4
      docs/api/loaders/AudioLoader.html
  3. 8 5
      docs/api/loaders/BufferGeometryLoader.html
  4. 24 24
      docs/api/loaders/FileLoader.html
  5. 7 4
      docs/api/loaders/FontLoader.html
  6. 8 7
      docs/api/loaders/ImageBitmapLoader.html
  7. 11 11
      docs/api/loaders/ImageLoader.html
  8. 10 4
      docs/api/loaders/JSONLoader.html
  9. 8 5
      docs/api/loaders/MaterialLoader.html
  10. 22 22
      docs/api/loaders/ObjectLoader.html
  11. 11 8
      docs/api/loaders/TextureLoader.html

+ 7 - 4
docs/api/loaders/AnimationLoader.html
查看文件 

@@ -25,16 +25,19 @@
 
 		loader.load(
 
 			// resource URL
 
 			'animations/animation.js',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( animations ) {
 
 				// animations is an array of AnimationClips
 
 			},
 
-			// Function called when download progresses
 
+
 
+			// onProgress callback
 
 			function ( xhr ) {
 
 				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
 			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 7 - 4
docs/api/loaders/AudioLoader.html
查看文件 

@@ -38,7 +38,8 @@
 
 		loader.load(
 
 			// resource URL
 
 			'audio/ambient_ocean.ogg',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( audioBuffer ) {
 
 				// set the audio object buffer to the loaded object
 
 				oceanAmbientSound.setBuffer( audioBuffer );
 
@@ -46,12 +47,14 @@
 
 				// play the audio
 
 				oceanAmbientSound.play();
 
 			},
 
-			// Function called when download progresses
 
+
 
+			// onProgress callback
 
 			function ( xhr ) {
 
 				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
 			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 8 - 5
docs/api/loaders/BufferGeometryLoader.html
查看文件 

@@ -1,7 +1,7 @@
 
 <!DOCTYPE html>
 
 <html lang="en">
 
 	<head>
 
-		<meta charset="utf-8" />

+		<meta charset="utf-8" />
 
 		<base href="../../" />
 
 		<script src="list.js"></script>
 
 		<script src="page.js"></script>
 
@@ -27,18 +27,21 @@
 
 		loader.load(
 
 			// resource URL
 
 			'models/json/pressure.json',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( geometry ) {
 
 				var material = new THREE.MeshLambertMaterial( { color: 0xF5F5F5 } );
 
 				var object = new THREE.Mesh( geometry, material );
 
 				scene.add( object );
 
 			},
 
-			// Function called when download progresses
 
+
 
+			// onProgress callback
 
 			function ( xhr ) {
 
 				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
 			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 24 - 24
docs/api/loaders/FileLoader.html
查看文件 

@@ -1,7 +1,7 @@
 
 <!DOCTYPE html>
 
 <html lang="en">
 
 	<head>
 
-		<meta charset="utf-8" />

+		<meta charset="utf-8" />
 
 		<base href="../../" />
 
 		<script src="list.js"></script>
 
 		<script src="page.js"></script>
 
@@ -22,29 +22,29 @@
 
 			[example:webgl_morphtargets_human WebGL / morphtargets / human]<br />
 
 		</div>
 
 		<code>
 
-var loader = new THREE.FileLoader();
 
-
 
-//load a text file a output the result to the console
 
-loader.load(
 
-    // resource URL
 
-    'example.txt',
 
-
 
-    // Function when resource is loaded
 
-    function ( data ) {
 
-        // output the text to the console
 
-        console.log( data )
 
-    },
 
-
 
-    // Function called when download progresses
 
-    function ( xhr ) {
 
-        console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
-    },
 
-
 
-    // Function called when download errors
 
-    function ( xhr ) {
 
-        console.error( 'An error happened' );
 
-    }
 
-);
 
+		var loader = new THREE.FileLoader();
 
+
 
+		//load a text file a output the result to the console
 
+		loader.load(
 
+			// resource URL
 
+			'example.txt',
 
+
 
+			// onLoad callback
 
+			function ( data ) {
 
+				// output the text to the console
 
+				console.log( data )
 
+			},
 
+
 
+			// onProgress callback
 
+			function ( xhr ) {
 
+				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
+			},
 
+
 
+			// onError callback
 
+			function ( err ) {
 
+				console.error( 'An error happened' );
 
+			}
 
+		);
 
 		</code>
 
 
 		<h2>Constructor</h2>

+ 7 - 4
docs/api/loaders/FontLoader.html
查看文件 

@@ -30,17 +30,20 @@
 
 		var font = loader.load(
 
 			// resource URL
 
 			'fonts/helvetiker_bold.typeface.json'
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( font ) {
 
 				// do something with the font
 
 				scene.add( font );
 
 			},
 
-			// Function called when download progresses
 
+
 
+			// onProgress callback
 
 			function ( xhr ) {
 
 				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
 			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 8 - 7
docs/api/loaders/ImageBitmapLoader.html
查看文件 

@@ -29,17 +29,18 @@
 
 		loader.load(
 
 			// resource URL
 
 			'textures/skyboxsun25degtest.png',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( imageBitmap ) {
 
 				var texture = new THREE.CanvasTexture( imageBitmap );
 
 				var material = new THREE.MeshBasicMaterial( { map: texture } );
 
 			},
 
-			// Function called when download progresses
 
-			function ( xhr ) {
 
-				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
-			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onProgress callback currently not supported
 
+			undefined,
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 11 - 11
docs/api/loaders/ImageLoader.html
查看文件 

@@ -32,26 +32,26 @@
 
 		loader.load(
 
 			// resource URL
 
 			'textures/skyboxsun25degtest.png',
 
-			// Function when resource is loaded
 
-			function ( image ) {
 
-				// do something with it
 
 
-				// like drawing a part of it on a canvas
 
+			// onLoad callback
 
+			function ( image ) {
 
+				// use the image, e.g. draw part of it on a canvas
 
 				var canvas = document.createElement( 'canvas' );
 
 				var context = canvas.getContext( '2d' );
 
 				context.drawImage( image, 100, 100 );
 
 			},
 
-			// Function called when download progresses
 
-			function ( xhr ) {
 
-				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
-			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
-				console.log( 'An error happened' );
 
+
 
+			// onProgress callback currently not supported
 
+			undefined,
 
+
 
+			// onError callback
 
+			function () {
 
+				console.error( 'An error happened.' );
 
 			}
 
 		);
 
 		</code>
 
 
+		Please note three.js r84 dropped support for ImageLoader progress events. For an ImageLoader that supports progress events, see [link:https://github.com/mrdoob/three.js/issues/10439#issuecomment-275785639 this thread].
 
 
 		<h2>Constructor</h2>

+ 10 - 4
docs/api/loaders/JSONLoader.html
查看文件 

@@ -28,18 +28,24 @@
 
 

 		// load a resource

 		loader.load(

-

 			// resource URL

 			'models/animated/monster/monster.js',

 

-			// Function when resource is loaded

+			// onLoad callback

 			function ( geometry, materials ) {

-

 				var material = materials[ 0 ];

 				var object = new THREE.Mesh( geometry, material );

-

 				scene.add( object );

+			},

+

+			// onProgress callback

+			function ( xhr ) {

+				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );

+			},

 

+			// onError callback

+			function( err ) {

+				console.log( 'An error happened' );

 			}

 		);

 		</code>

+ 8 - 5
docs/api/loaders/MaterialLoader.html
查看文件 

@@ -1,7 +1,7 @@
 
 <!DOCTYPE html>
 
 <html lang="en">
 
 	<head>
 
-		<meta charset="utf-8" />

+		<meta charset="utf-8" />
 
 		<base href="../../" />
 
 		<script src="list.js"></script>
 
 		<script src="page.js"></script>
 
@@ -26,16 +26,19 @@
 
 		loader.load(
 
 			// resource URL
 
 			'path/to/material.json',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( material ) {
 
 				object.material = material;
 
 			},
 
-			// Function called when download progresses
 
+
 
+			// onProgress callback
 
 			function ( xhr ) {
 
 				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );
 
 			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
+
 
+			// onError callback
 
+			function ( err ) {
 
 				console.log( 'An error happened' );
 
 			}
 
 		);

+ 22 - 22
docs/api/loaders/ObjectLoader.html
查看文件 

@@ -29,35 +29,35 @@
 
 		</div>

 

 		<code>

-var loader = new THREE.ObjectLoader();

+		var loader = new THREE.ObjectLoader();

 

-loader.load(

-    // resource URL

-    "models/json/example.json",

+		loader.load(

+			// resource URL

+			"models/json/example.json",

 

-    // pass the loaded data to the onLoad function.

-		//Here it is assumed to be an object

-    function ( obj ) {

-				//add the loaded object to the scene

-        scene.add( obj );

-    },

+			// onLoad callback

+			// Here the loaded data is assumed to be an object

+			function ( obj ) {

+				// Add the loaded object to the scene

+				scene.add( obj );

+			},

 

-    // Function called when download progresses

-    function ( xhr ) {

-        console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );

-    },

+			// onProgress callback

+			function ( err ) {

+				console.log( (xhr.loaded / xhr.total * 100) + '% loaded' );

+			},

 

-    // Function called when download errors

-    function ( xhr ) {

-        console.error( 'An error happened' );

-    }

-);

+			// onError callback

+			function ( xhr ) {

+				console.error( 'An error happened' );

+			}

+		);

 

 

-// Alternatively, to parse a previously loaded JSON structure

-var object = loader.parse( a_json_object );

+		// Alternatively, to parse a previously loaded JSON structure

+		var object = loader.parse( a_json_object );

 

-scene.add( object );

+		scene.add( object );

 		</code>

+ 11 - 8
docs/api/loaders/TextureLoader.html
查看文件 

@@ -36,24 +36,27 @@
 
 		loader.load(
 
 			// resource URL
 
 			'textures/land_ocean_ice_cloud_2048.jpg',
 
-			// Function when resource is loaded
 
+
 
+			// onLoad callback
 
 			function ( texture ) {
 
 				// in this example we create the material when the texture is loaded
 
 				var material = new THREE.MeshBasicMaterial( {
 
 					map: texture
 
 				 } );
 
 			},
 
-			// Function called when download progresses
 
-			function ( xhr ) {
 
-				console.log( ( xhr.loaded / xhr.total * 100 ) + '% loaded' );
 
-			},
 
-			// Function called when download errors
 
-			function ( xhr ) {
 
-				console.error( 'An error happened' );
 
+
 
+			// onProgress callback currently not supported
 
+			undefined,
 
+
 
+			// onError callback
 
+			function ( err ) {
 
+				console.error( 'An error happened.' );
 
 			}
 
 		);
 
 		</code>
 
 
+		Please note three.js r84 dropped support for TextureLoader progress events. For a TextureLoader that supports progress events, see [link:https://github.com/mrdoob/three.js/issues/10439#issuecomment-293260145 this thread].
 
+
 
 		<h2>Constructor</h2>
 
 
 		<h3>[name]( [page:LoadingManager manager] )</h3>