Skip to content

Commit

Permalink
Merge pull request #12847 from MagnuzBinder/patch-29
Browse files Browse the repository at this point in the history
Change parameter name to be consistent with code.
  • Loading branch information
mrdoob authored Dec 12, 2017
2 parents 621fe0a + aa75571 commit d276746
Showing 1 changed file with 104 additions and 104 deletions.
208 changes: 104 additions & 104 deletions docs/api/geometries/TubeGeometry.html
Original file line number Diff line number Diff line change
@@ -1,105 +1,105 @@
<!DOCTYPE html>
<html lang="en">
<head>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<base href="../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Geometry] &rarr;

<h1>[name]</h1>

<div class="desc">Creates a tube that extrudes along a 3d curve.</div>

<iframe id="scene" src="scenes/geometry-browser.html#TubeGeometry"></iframe>

<script>

// iOS iframe auto-resize workaround

if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {

var scene = document.getElementById( 'scene' );

scene.style.width = getComputedStyle( scene ).width;
scene.style.height = getComputedStyle( scene ).height;
scene.setAttribute( 'scrolling', 'no' );

}

</script>

<h2>Example</h2>

<code>
function CustomSinCurve( scale ) {

THREE.Curve.call( this );

this.scale = ( scale === undefined ) ? 1 : scale;

}

CustomSinCurve.prototype = Object.create( THREE.Curve.prototype );
CustomSinCurve.prototype.constructor = CustomSinCurve;

CustomSinCurve.prototype.getPoint = function ( t ) {

var tx = t * 3 - 1.5;
var ty = Math.sin( 2 * Math.PI * t );
var tz = 0;

return new THREE.Vector3( tx, ty, tz ).multiplyScalar( this.scale );

};

var path = new CustomSinCurve( 10 );
var geometry = new THREE.TubeGeometry( path, 20, 2, 8, false );
var material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
var mesh = new THREE.Mesh( geometry, material );
scene.add( mesh );
</code>

<h2>Constructor</h2>


<h3>[name]([page:Curve path], [page:Integer tubularSegments], [page:Float radius], [page:Integer radiusSegments], [page:Boolean closed])</h3>
<div>
path — [page:Curve] - A path that inherits from the [page:Curve] base class<br />
tubularSegments — [page:Integer] - The number of segments that make up the tube, default is 64<br />
radius — [page:Float] - The radius of the tube, default is 1<br />
radiusSegments — [page:Integer] - The number of segments that make up the cross-section, default is 8 <br />
closed — [page:Boolean] Is the tube open or closed, default is false <br />
</div>


<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<div>
An object with all of the parameters that were used to generate the geometry.
</div>

<h3>[property:Array tangents]</h3>
<div>
An array of [page:Vector3] tangents
</div>

<h3>[property:Array normals]</h3>
<div>
An array of [page:Vector3] normals
</div>

<h3>[property:Array binormals]</h3>
<div>
An array of [page:Vector3] binormals
</div>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>
<base href="../../" />
<script src="list.js"></script>
<script src="page.js"></script>
<link type="text/css" rel="stylesheet" href="page.css" />
</head>
<body>
[page:Geometry] &rarr;

<h1>[name]</h1>

<div class="desc">Creates a tube that extrudes along a 3d curve.</div>

<iframe id="scene" src="scenes/geometry-browser.html#TubeGeometry"></iframe>

<script>

// iOS iframe auto-resize workaround

if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {

var scene = document.getElementById( 'scene' );

scene.style.width = getComputedStyle( scene ).width;
scene.style.height = getComputedStyle( scene ).height;
scene.setAttribute( 'scrolling', 'no' );

}

</script>

<h2>Example</h2>

<code>
function CustomSinCurve( scale ) {

THREE.Curve.call( this );

this.scale = ( scale === undefined ) ? 1 : scale;

}

CustomSinCurve.prototype = Object.create( THREE.Curve.prototype );
CustomSinCurve.prototype.constructor = CustomSinCurve;

CustomSinCurve.prototype.getPoint = function ( t ) {

var tx = t * 3 - 1.5;
var ty = Math.sin( 2 * Math.PI * t );
var tz = 0;

return new THREE.Vector3( tx, ty, tz ).multiplyScalar( this.scale );

};

var path = new CustomSinCurve( 10 );
var geometry = new THREE.TubeGeometry( path, 20, 2, 8, false );
var material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
var mesh = new THREE.Mesh( geometry, material );
scene.add( mesh );
</code>

<h2>Constructor</h2>


<h3>[name]([page:Curve path], [page:Integer tubularSegments], [page:Float radius], [page:Integer radialSegments], [page:Boolean closed])</h3>
<div>
path — [page:Curve] - A path that inherits from the [page:Curve] base class<br />
tubularSegments — [page:Integer] - The number of segments that make up the tube, default is 64<br />
radius — [page:Float] - The radius of the tube, default is 1<br />
radialSegments — [page:Integer] - The number of segments that make up the cross-section, default is 8 <br />
closed — [page:Boolean] Is the tube open or closed, default is false <br />
</div>


<h2>Properties</h2>

<h3>[property:Object parameters]</h3>
<div>
An object with all of the parameters that were used to generate the geometry.
</div>

<h3>[property:Array tangents]</h3>
<div>
An array of [page:Vector3] tangents
</div>

<h3>[property:Array normals]</h3>
<div>
An array of [page:Vector3] normals
</div>

<h3>[property:Array binormals]</h3>
<div>
An array of [page:Vector3] binormals
</div>

<h2>Source</h2>

[link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
</body>
</html>

0 comments on commit d276746

Please sign in to comment.