javascript
/
three.js
mirror of https://github.com/tazdij/three.js.git


			
							1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
							<!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 torus knot, the particular shape of which is defined by a pair of coprime integers, p and q.  If p and q are not coprime, the result will be a torus link.</div>

		<iframe src='scenes/geometry-browser.html#TorusKnotGeometry'></iframe>


		<h2>Example</h2>

		<code>var geometry = new THREE.TorusKnotGeometry( 10, 3, 100, 16 );
		var material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
		var torusKnot = new THREE.Mesh( geometry, material );
		scene.add( torusKnot );
		</code>


		<h2>Constructor</h2>


		<h3>[name]([page:Float radius], [page:Float tube], [page:Integer radialSegments], [page:Integer tubularSegments], [page:Integer p], [page:Integer q], [page:Float heightScale], [page:Float arc])</h3>
		<div>
			<ul>
				<li>radius — Default is 100.</li>
				<li>tube — Diameter of the tube. Default is 40.</li>
				<li>radialSegments — Default is 64.</li>
				<li>tubularSegments — Default is 8.</li>
				<li>p — This value determines, how many times the geometry winds around its axis of rotational symmetry. Default is 2.</li>
				<li>q — This value determines, how many times the geometry winds around a circle in the interior of the torus. Default is 3.</li>
				<li>heightScale — Default is 1.</li>
				<li>arc — Central angle.  Default is Math.PI * 2.</li>
			</ul>
		</div>


		<h2>Properties</h2>


		<div>
		Each of the contructor parameters is accessible as a property of the same name. Any modification of these properties after instantiation does not change the geometry.
		</div>


		<h2>Source</h2>

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