Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: Clean up. #18591

Merged
merged 2 commits into from
Feb 10, 2020
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
Docs: Clean up.
Mugen87 committed Feb 10, 2020

Verified

This commit was signed with the committer’s verified signature.
addaleax Anna Henningsen
commit cfe32fbfb2430d35fb0a0b95b0df0bafdeffb5ac
2 changes: 1 addition & 1 deletion docs/api/en/audio/PositionalAudio.html
Original file line number Diff line number Diff line change
@@ -44,7 +44,7 @@ <h2>Example</h2>
});

// 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 );
2 changes: 1 addition & 1 deletion docs/api/en/extras/core/Interpolations.html
Original file line number Diff line number Diff line change
@@ -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>
18 changes: 9 additions & 9 deletions docs/api/en/extras/core/Path.html
Original file line number Diff line number Diff line change
@@ -19,19 +19,19 @@ <h1>[name]</h1>
<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>


2 changes: 1 addition & 1 deletion docs/api/en/extras/core/Shape.html
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ <h1>[name]</h1>

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>
5 changes: 3 additions & 2 deletions docs/api/en/extras/core/ShapePath.html
Original file line number Diff line number Diff line change
@@ -17,8 +17,9 @@ <h1>[name]</h1>
</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>

8 changes: 4 additions & 4 deletions docs/api/en/helpers/BoxHelper.html
Original file line number Diff line number Diff line change
@@ -28,10 +28,10 @@ <h2>Example</h2>
</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>


15 changes: 8 additions & 7 deletions docs/api/en/objects/Line.html
Original file line number Diff line number Diff line change
@@ -25,16 +25,17 @@ <h1>[name]</h1>

<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 );
2 changes: 1 addition & 1 deletion docs/api/en/objects/Sprite.html
Original file line number Diff line number Diff line change
@@ -23,7 +23,7 @@ <h2>Example</h2>

<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>
2 changes: 1 addition & 1 deletion docs/api/zh/audio/PositionalAudio.html
Original file line number Diff line number Diff line change
@@ -44,7 +44,7 @@ <h2>示例</h2>
});

// 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 );
2 changes: 1 addition & 1 deletion docs/api/zh/extras/core/Interpolations.html
Original file line number Diff line number Diff line change
@@ -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>
18 changes: 9 additions & 9 deletions docs/api/zh/extras/core/Path.html
Original file line number Diff line number Diff line change
@@ -19,19 +19,19 @@ <h1>路径([name])</h1>
<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>


2 changes: 1 addition & 1 deletion docs/api/zh/extras/core/Shape.html
Original file line number Diff line number Diff line change
@@ -30,7 +30,7 @@ <h1>形状([name])</h1>

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>
5 changes: 3 additions & 2 deletions docs/api/zh/extras/core/ShapePath.html
Original file line number Diff line number Diff line change
@@ -16,8 +16,9 @@ <h1>形状路径([name])</h1>
</p>

<h2>示例</h2>

[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
<p>
[example:webgl_geometry_extrude_shapes2 geometry / extrude / shapes2]
</p>

<h2>构造函数</h2>

8 changes: 4 additions & 4 deletions docs/api/zh/helpers/BoxHelper.html
Original file line number Diff line number Diff line change
@@ -29,10 +29,10 @@ <h2>例子</h2>
</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>


15 changes: 8 additions & 7 deletions docs/api/zh/objects/Line.html
Original file line number Diff line number Diff line change
@@ -22,16 +22,17 @@ <h1>线([name])</h1>

<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 );
2 changes: 1 addition & 1 deletion docs/api/zh/objects/Sprite.html
Original file line number Diff line number Diff line change
@@ -21,7 +21,7 @@ <h2>示例</h2>

<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>
2 changes: 1 addition & 1 deletion docs/examples/en/helpers/VertexNormalsHelper.html
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ <h2>Example</h2>
</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 );

9 changes: 5 additions & 4 deletions docs/examples/en/math/Lut.html
Original file line number Diff line number Diff line change
@@ -16,10 +16,11 @@ <h1>[name]</h1>


<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>

2 changes: 1 addition & 1 deletion docs/examples/zh/helpers/VertexNormalsHelper.html
Original file line number Diff line number Diff line change
@@ -26,7 +26,7 @@ <h2>例子</h2>
</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 );

8 changes: 4 additions & 4 deletions docs/examples/zh/math/Lut.html
Original file line number Diff line number Diff line change
@@ -16,10 +16,10 @@ <h1>[name]</h1>


<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>