Browse Source

Docs: Clean up.

Mugen87 5 years ago
parent
commit
cfe32fbfb2

+ 1 - 1
docs/api/en/audio/PositionalAudio.html

@@ -44,7 +44,7 @@
 		});
 
 		// create an object for the sound to play from
-		var sphere = new THREE.SphereGeometry( 20, 32, 16 );
+		var sphere = new THREE.SphereBufferGeometry( 20, 32, 16 );
 		var material = new THREE.MeshPhongMaterial( { color: 0xff2200 } );
 		var mesh = new THREE.Mesh( sphere, material );
 		scene.add( mesh );

+ 1 - 1
docs/api/en/extras/core/Interpolations.html

@@ -11,7 +11,7 @@
 		<h1>[name]</h1>
 
 		<p class="desc">
-		TODO
+			[name] contains spline and Bézier functions internally used by concrete curve classes.
 		</p>
 
 		<h2>Methods</h2>

+ 9 - 9
docs/api/en/extras/core/Path.html

@@ -19,19 +19,19 @@
 		<h2>Example</h2>
 
 		<code>
-			var path = new THREE.Path();
+		var path = new THREE.Path();
 
-			path.lineTo( 0, 0.8 );
-			path.quadraticCurveTo( 0, 1, 0.2, 1 );
-			path.lineTo( 1, 1 );
+		path.lineTo( 0, 0.8 );
+		path.quadraticCurveTo( 0, 1, 0.2, 1 );
+		path.lineTo( 1, 1 );
 
-			var points = path.getPoints();
+		var points = path.getPoints();
 
-			var geometry = new THREE.BufferGeometry().setFromPoints( points );
-			var material = new THREE.LineBasicMaterial( { color: 0xffffff } );
+		var geometry = new THREE.BufferGeometry().setFromPoints( points );
+		var material = new THREE.LineBasicMaterial( { color: 0xffffff } );
 
-			var line = new THREE.Line( geometry, material );
-			scene.add( line );
+		var line = new THREE.Line( geometry, material );
+		scene.add( line );
 		</code>
 
 

+ 1 - 1
docs/api/en/extras/core/Shape.html

@@ -30,7 +30,7 @@
 
 		var extrudeSettings = { amount: 8, bevelEnabled: true, bevelSegments: 2, steps: 2, bevelSize: 1, bevelThickness: 1 };
 
-		var geometry = new THREE.ExtrudeGeometry( heartShape, extrudeSettings );
+		var geometry = new THREE.ExtrudeBufferGeometry( heartShape, extrudeSettings );
 
 		var mesh = new THREE.Mesh( geometry, new THREE.MeshPhongMaterial() );
 		</code>

+ 3 - 2
docs/api/en/extras/core/ShapePath.html

@@ -17,8 +17,9 @@
 		</p>
 
 		<h2>Example</h2>
-
-		[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
+		<p>
+			[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
+		</p>
 
 		<h2>Constructor</h2>
 

+ 4 - 4
docs/api/en/helpers/BoxHelper.html

@@ -28,10 +28,10 @@
 		</p>
 
 		<code>
-			var sphere = new THREE.SphereGeometry();
-			var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
-			var box = new THREE.BoxHelper( object, 0xffff00 );
-			scene.add( box );
+		var sphere = new THREE.SphereBufferGeometry();
+		var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
+		var box = new THREE.BoxHelper( object, 0xffff00 );
+		scene.add( box );
 		</code>
 
 

+ 8 - 7
docs/api/en/objects/Line.html

@@ -25,16 +25,17 @@
 
 		<h2>Example</h2>
 
-		<code>var material = new THREE.LineBasicMaterial({
+		<code>
+		var material = new THREE.LineBasicMaterial({
 			color: 0x0000ff
 		});
 
-		var geometry = new THREE.Geometry();
-		geometry.vertices.push(
-			new THREE.Vector3( -10, 0, 0 ),
-			new THREE.Vector3( 0, 10, 0 ),
-			new THREE.Vector3( 10, 0, 0 )
-		);
+		var points = [];
+		points.push( new THREE.Vector3( - 10, 0, 0 ) );
+		points.push( new THREE.Vector3( 0, 10, 0 ) );
+		points.push( new THREE.Vector3( 10, 0, 0 ) );
+
+		var geometry = new THREE.BufferGeometry().setFromPoints( points );
 
 		var line = new THREE.Line( geometry, material );
 		scene.add( line );

+ 1 - 1
docs/api/en/objects/Sprite.html

@@ -23,7 +23,7 @@
 
 		<code>
 var spriteMap = new THREE.TextureLoader().load( "sprite.png" );
-var spriteMaterial = new THREE.SpriteMaterial( { map: spriteMap, color: 0xffffff } );
+var spriteMaterial = new THREE.SpriteMaterial( { map: spriteMap } );
 var sprite = new THREE.Sprite( spriteMaterial );
 scene.add( sprite );
 		</code>

+ 1 - 1
docs/api/zh/audio/PositionalAudio.html

@@ -44,7 +44,7 @@
 		});
 
 		// create an object for the sound to play from
-		var sphere = new THREE.SphereGeometry( 20, 32, 16 );
+		var sphere = new THREE.SphereBufferGeometry( 20, 32, 16 );
 		var material = new THREE.MeshPhongMaterial( { color: 0xff2200 } );
 		var mesh = new THREE.Mesh( sphere, material );
 		scene.add( mesh );

+ 1 - 1
docs/api/zh/extras/core/Interpolations.html

@@ -11,7 +11,7 @@
 		<h1>插值([name])</h1>
 
 		<p class="desc">
-		TODO
+			[name] contains spline and Bézier functions internally used by concrete curve classes.
 		</p>
 
 		<h2>方法</h2>

+ 9 - 9
docs/api/zh/extras/core/Path.html

@@ -19,19 +19,19 @@
 		<h2>示例</h2>
 
 		<code>
-			var path = new THREE.Path();
+		var path = new THREE.Path();
 
-			path.lineTo( 0, 0.8 );
-			path.quadraticCurveTo( 0, 1, 0.2, 1 );
-			path.lineTo( 1, 1 );
+		path.lineTo( 0, 0.8 );
+		path.quadraticCurveTo( 0, 1, 0.2, 1 );
+		path.lineTo( 1, 1 );
 
-			var points = path.getPoints();
+		var points = path.getPoints();
 
-			var geometry = new THREE.BufferGeometry().setFromPoints( points );
-			var material = new THREE.LineBasicMaterial( { color: 0xffffff } );
+		var geometry = new THREE.BufferGeometry().setFromPoints( points );
+		var material = new THREE.LineBasicMaterial( { color: 0xffffff } );
 
-			var line = new THREE.Line( geometry, material );
-			scene.add( line );
+		var line = new THREE.Line( geometry, material );
+		scene.add( line );
 		</code>
 
 

+ 1 - 1
docs/api/zh/extras/core/Shape.html

@@ -30,7 +30,7 @@
 
 		var extrudeSettings = { amount: 8, bevelEnabled: true, bevelSegments: 2, steps: 2, bevelSize: 1, bevelThickness: 1 };
 
-		var geometry = new THREE.ExtrudeGeometry( heartShape, extrudeSettings );
+		var geometry = new THREE.ExtrudeBufferGeometry( heartShape, extrudeSettings );
 
 		var mesh = new THREE.Mesh( geometry, new THREE.MeshPhongMaterial() );
 		</code>

+ 3 - 2
docs/api/zh/extras/core/ShapePath.html

@@ -16,8 +16,9 @@
 		</p>
 
 		<h2>示例</h2>
-
-		[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
+		<p>
+			[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
+		</p>
 
 		<h2>构造函数</h2>
 

+ 4 - 4
docs/api/zh/helpers/BoxHelper.html

@@ -29,10 +29,10 @@
 		</p>
 
 		<code>
-			var sphere = new THREE.SphereGeometry();
-			var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
-			var box = new THREE.BoxHelper( object, 0xffff00 );
-			scene.add( box );
+		var sphere = new THREE.SphereBufferGeometry();
+		var object = new THREE.Mesh( sphere, new THREE.MeshBasicMaterial( 0xff0000 ) );
+		var box = new THREE.BoxHelper( object, 0xffff00 );
+		scene.add( box );
 		</code>
 
 

+ 8 - 7
docs/api/zh/objects/Line.html

@@ -22,16 +22,17 @@
 
 		<h2>示例</h2>
 
-		<code>var material = new THREE.LineBasicMaterial({
+		<code>
+		var material = new THREE.LineBasicMaterial({
 			color: 0x0000ff
 		});
 
-		var geometry = new THREE.Geometry();
-		geometry.vertices.push(
-			new THREE.Vector3( -10, 0, 0 ),
-			new THREE.Vector3( 0, 10, 0 ),
-			new THREE.Vector3( 10, 0, 0 )
-		);
+		var points = [];
+		points.push( new THREE.Vector3( - 10, 0, 0 ) );
+		points.push( new THREE.Vector3( 0, 10, 0 ) );
+		points.push( new THREE.Vector3( 10, 0, 0 ) );
+
+		var geometry = new THREE.BufferGeometry().setFromPoints( points );
 
 		var line = new THREE.Line( geometry, material );
 		scene.add( line );

+ 1 - 1
docs/api/zh/objects/Sprite.html

@@ -21,7 +21,7 @@
 
 		<code>
 var spriteMap = new THREE.TextureLoader().load( "sprite.png" );
-var spriteMaterial = new THREE.SpriteMaterial( { map: spriteMap, color: 0xffffff } );
+var spriteMaterial = new THREE.SpriteMaterial( { map: spriteMap } );
 var sprite = new THREE.Sprite( spriteMaterial );
 scene.add( sprite );
 		</code>

+ 1 - 1
docs/examples/en/helpers/VertexNormalsHelper.html

@@ -26,7 +26,7 @@
 		</p>
 
 		<code>
-		var geometry = new THREE.BoxGeometry( 10, 10, 10, 2, 2, 2 );
+		var geometry = new THREE.BoxBufferGeometry( 10, 10, 10, 2, 2, 2 );
 		var material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
 		var box = new THREE.Mesh( geometry, material );
 

+ 5 - 4
docs/examples/en/math/Lut.html

@@ -16,10 +16,11 @@
 
 
 		<h2>Example</h2>
-		<code>var lut = new THREE.Lut( "rainbow", 512 );</code>
-		<code>var data = [0, 10.1, 4.2, 3.4, 63, 28];</code>
-		<code>lut.setMax(63);</code>
-		<code>color = lut.getColor(10);</code>
+
+		<code>
+		var lut = new THREE.Lut( 'rainbow', 512 );
+		var color = lut.getColor( 0.5 );
+		</code>
 
 		<h2>Constructor</h2>
 

+ 1 - 1
docs/examples/zh/helpers/VertexNormalsHelper.html

@@ -26,7 +26,7 @@
 		</p>
 
 		<code>
-		var geometry = new THREE.BoxGeometry( 10, 10, 10, 2, 2, 2 );
+		var geometry = new THREE.BoxBufferGeometry( 10, 10, 10, 2, 2, 2 );
 		var material = new THREE.MeshBasicMaterial( { color: 0xff0000 } );
 		var box = new THREE.Mesh( geometry, material );
 

+ 4 - 4
docs/examples/zh/math/Lut.html

@@ -16,10 +16,10 @@
 
 
 		<h2>Example</h2>
-		<code>var lut = new THREE.Lut( "rainbow", 512 );</code>
-		<code>var data = [0, 10.1, 4.2, 3.4, 63, 28];</code>
-		<code>lut.setMax(63);</code>
-		<code>color = lut.getColor(10);</code>
+		<code>
+		var lut = new THREE.Lut( 'rainbow', 512 );
+		var color = lut.getColor( 0.5 );
+		</code>
 
 		<h2>Constructor</h2>