ExtrudeGeometry.html 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  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 extruded geometry from a path shape.</p>
  13. <iframe id="scene" src="scenes/geometry-browser.html#ExtrudeGeometry"></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>
  25. const length = 12, width = 8;
  26. const shape = new THREE.Shape();
  27. shape.moveTo( 0,0 );
  28. shape.lineTo( 0, width );
  29. shape.lineTo( length, width );
  30. shape.lineTo( length, 0 );
  31. shape.lineTo( 0, 0 );
  32. const extrudeSettings = {
  33. steps: 2,
  34. depth: 16,
  35. bevelEnabled: true,
  36. bevelThickness: 1,
  37. bevelSize: 1,
  38. bevelOffset: 0,
  39. bevelSegments: 1
  40. };
  41. const geometry = new THREE.ExtrudeGeometry( shape, extrudeSettings );
  42. const material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  43. const mesh = new THREE.Mesh( geometry, material ) ;
  44. scene.add( mesh );
  45. </code>
  46. <h2>Constructor</h2>
  47. <h3>[name]([param:Array shapes], [param:Object options])</h3>
  48. <p>
  49. shapes — Shape or an array of shapes. <br />
  50. options — Object that can contain the following parameters.
  51. <ul>
  52. <li>curveSegments — int. Number of points on the curves. Default is 12.</li>
  53. <li>steps — int. Number of points used for subdividing segments along the depth of the extruded spline. Default is 1.</li>
  54. <li>depth — float. Depth to extrude the shape. Default is 100.</li>
  55. <li>bevelEnabled — bool. Apply beveling to the shape. Default is true.</li>
  56. <li>bevelThickness — float. How deep into the original shape the bevel goes. Default is 6.</li>
  57. <li>bevelSize — float. Distance from the shape outline that the bevel extends. Default is bevelThickness - 2.</li>
  58. <li>bevelOffset — float. Distance from the shape outline that the bevel starts. Default is 0.</li>
  59. <li>bevelSegments — int. Number of bevel layers. Default is 3.</li>
  60. <li>extrudePath — THREE.Curve. A 3D spline path along which the shape should be extruded. Bevels not supported for path extrusion.</li>
  61. <li>UVGenerator — Object. object that provides UV generator functions</li>
  62. </ul>
  63. </p>
  64. <p>
  65. This object extrudes a 2D shape to a 3D geometry.
  66. </p>
  67. <p>
  68. When creating a Mesh with this geometry, if you'd like to have a separate material used for its face
  69. and its extruded sides, you can use an array of materials. The first material will be
  70. applied to the face; the second material will be applied to the sides.
  71. </p>
  72. <h2>Properties</h2>
  73. <p>See the base [page:BufferGeometry] class for common properties.</p>
  74. <h3>[property:Object parameters]</h3>
  75. <p>
  76. An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
  77. </p>
  78. <h2>Methods</h2>
  79. <p>See the base [page:BufferGeometry] class for common methods.</p>
  80. <h2>Source</h2>
  81. <p>
  82. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  83. </p>
  84. </body>
  85. </html>