TorusKnotGeometry.html 2.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. [page:BufferGeometry] &rarr;
  11. <h1>[name]</h1>
  12. <p 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.</p>
  13. <iframe id="scene" src="scenes/geometry-browser.html#TorusKnotGeometry"></iframe>
  14. <script>
  15. // iOS iframe auto-resize workaround
  16. if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {
  17. const scene = document.getElementById( 'scene' );
  18. scene.style.width = getComputedStyle( scene ).width;
  19. scene.style.height = getComputedStyle( scene ).height;
  20. scene.setAttribute( 'scrolling', 'no' );
  21. }
  22. </script>
  23. <h2>Code Example</h2>
  24. <code>const geometry = new THREE.TorusKnotGeometry( 10, 3, 100, 16 );
  25. const material = new THREE.MeshBasicMaterial( { color: 0xffff00 } );
  26. const torusKnot = new THREE.Mesh( geometry, material );
  27. scene.add( torusKnot );
  28. </code>
  29. <h2>Constructor</h2>
  30. <h3>[name]([param:Float radius], [param:Float tube], [param:Integer tubularSegments], [param:Integer radialSegments], [param:Integer p], [param:Integer q])</h3>
  31. <p>
  32. <ul>
  33. <li>radius - Radius of the torus. Default is 1.</li>
  34. <li>tube — Radius of the tube. Default is 0.4.</li>
  35. <li>tubularSegments — Default is 64.</li>
  36. <li>radialSegments — Default is 8.</li>
  37. <li>p — This value determines, how many times the geometry winds around its axis of rotational symmetry. Default is 2.</li>
  38. <li>q — This value determines, how many times the geometry winds around a circle in the interior of the torus. Default is 3.</li>
  39. </ul>
  40. </p>
  41. <h2>Properties</h2>
  42. <p>See the base [page:BufferGeometry] class for common properties.</p>
  43. <h3>[property:Object parameters]</h3>
  44. <p>
  45. An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
  46. </p>
  47. <h2>Methods</h2>
  48. <p>See the base [page:BufferGeometry] class for common methods.</p>
  49. <h2>Source</h2>
  50. <p>
  51. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  52. </p>
  53. </body>
  54. </html>