samien
/
three.js
mirror of https://github.com/mrdoob/three.js.git


			
				
					
						
						
							123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
							<!DOCTYPE html>
<html lang="en">
<head>
	<meta charset="utf-8">
	<title>TorusKnotGeometry - Three.js Docs</title>
	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
	<script src="../scripts/highlight.min.js"></script>
	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
	<link type="text/css" rel="stylesheet" href="../styles/page.css">
</head>
<body>
		<p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="BufferGeometry.html">BufferGeometry</a> → </p>
	<h1 translate="no">TorusKnotGeometry</h1>
		<section>
			<header>
				<div class="class-description"><p>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.</p></div>
				<iframe id="viewer" src="../scenes/geometry-browser.html#TorusKnotGeometry"></iframe>
				<h2>Code Example</h2>
				<div translate="no"><pre><code class="language-js">const geometry = new THREE.TorusKnotGeometry( 10, 3, 100, 16 );
const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
const torusKnot = new THREE.Mesh( geometry, material );
scene.add( torusKnot );
</code></pre></div>
			</header>
			<article>
				<div class="container-overview">
					<h2>Constructor</h2>
					<h3 class="name name-method" id="TorusKnotGeometry" translate="no">new <a href="#TorusKnotGeometry">TorusKnotGeometry</a><span class="signature">( radius : <span class="param-type">number</span>, tube : <span class="param-type">number</span>, tubularSegments : <span class="param-type">number</span>, radialSegments : <span class="param-type">number</span>, p : <span class="param-type">number</span>, q : <span class="param-type">number</span> )</span> </h3>
					<div class="method">
						<div class="description">
							<p>Constructs a new torus knot geometry.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>radius</code></td>
									<td class="description last"><p>Radius of the torus knot.<br/>Default is <code>1</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>tube</code></td>
									<td class="description last"><p>Radius of the tube.<br/>Default is <code>0.4</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>tubularSegments</code></td>
									<td class="description last"><p>The number of tubular segments.<br/>Default is <code>64</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>radialSegments</code></td>
									<td class="description last"><p>The number of radial segments.<br/>Default is <code>8</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>p</code></td>
									<td class="description last"><p>This value determines, how many times the geometry winds around its axis of rotational symmetry.<br/>Default is <code>2</code>.</p></td>
								</tr>
								<tr>
									<td class="name"><code>q</code></td>
									<td class="description last"><p>This value determines, how many times the geometry winds around a circle in the interior of the torus.<br/>Default is <code>3</code>.</p></td>
								</tr>
							</tbody>
						</table>
					</div>
				</div>
				<h2 class="subsection-title">Properties</h2>
				<div class="member">
					<h3 class="name" id="parameters" translate="no">.<a href="#parameters">parameters</a><span class="type-signature"> : Object</span> </h3>
					<div class="description">
						<p>Holds the constructor parameters that have been
used to generate the geometry. Any modification
after instantiation does not change the geometry.</p>
					</div>
				</div>
				<h2 class="subsection-title">Static Methods</h2>
					<h3 class="name name-method" id=".fromJSON" translate="no">.<a href="#.fromJSON">fromJSON</a><span class="signature">( data : <span class="param-type">Object</span> )</span><span class="type-signature"> : <a href="TorusKnotGeometry.html">TorusKnotGeometry</a></span> </h3>
					<div class="method">
						<div class="description">
							<p>Factory method for creating an instance of this class from the given
JSON object.</p>
						</div>
						<table class="params">
							<tbody>
								<tr>
									<td class="name"><code>data</code></td>
									<td class="description last"><p>A JSON object representing the serialized geometry.</p></td>
								</tr>
							</tbody>
						</table>
						<dl class="details">
							<dt class="tag-returns"><strong>Returns:</strong> A new instance.</dt>
						</dl>
					</div>
				<h2 class="subsection-title">Source</h2>
				<p>
					<a href="https://github.com/mrdoob/three.js/blob/master/src/geometries/TorusKnotGeometry.js" target="_blank" rel="noopener" translate="no">src/geometries/TorusKnotGeometry.js</a>
				</p>
			</article>
		</section>
<script src="../scripts/linenumber.js"></script>
<script src="../scripts/page.js"></script>
</body>
</html>