ExtrudeBufferGeometry.html 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../" />
  6. <script src="list.js"></script>
  7. <script src="page.js"></script>
  8. <link type="text/css" rel="stylesheet" href="page.css" />
  9. </head>
  10. <body>
  11. [page:BufferGeometry] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">Creates extruded BufferGeometry from a path shape.</div>
  14. <iframe id="scene" src="scenes/geometry-browser.html#ExtrudeBufferGeometry"></iframe>
  15. <script>
  16. // iOS iframe auto-resize workaround
  17. if ( /(iPad|iPhone|iPod)/g.test( navigator.userAgent ) ) {
  18. var scene = document.getElementById( 'scene' );
  19. scene.style.width = getComputedStyle( scene ).width;
  20. scene.style.height = getComputedStyle( scene ).height;
  21. scene.setAttribute( 'scrolling', 'no' );
  22. }
  23. </script>
  24. <h2>Example</h2>
  25. <code>
  26. var length = 12, width = 8;
  27. var shape = new THREE.Shape();
  28. shape.moveTo( 0,0 );
  29. shape.lineTo( 0, width );
  30. shape.lineTo( length, width );
  31. shape.lineTo( length, 0 );
  32. shape.lineTo( 0, 0 );
  33. var extrudeSettings = {
  34. steps: 2,
  35. amount: 16,
  36. bevelEnabled: true,
  37. bevelThickness: 1,
  38. bevelSize: 1,
  39. bevelSegments: 1
  40. };
  41. var geometry = new THREE.ExtrudeBufferGeometry( shape, extrudeSettings );
  42. var material = new THREE.MeshBasicMaterial( { color: 0x00ff00 } );
  43. var mesh = new THREE.Mesh( geometry, material ) ;
  44. scene.add( mesh );
  45. </code>
  46. <h2>Constructor</h2>
  47. <h3>[name]([page:Array shapes], [page:Object options])</h3>
  48. <div>
  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>amount — int. 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>bevelSegments — int. Number of bevel layers. Default is 3.</li>
  59. <li>extrudePath — THREE.CurvePath. A 3D spline path along which the shape should be extruded (creates Frames if frames aren't defined).</li>
  60. <li>frames — An object containing arrays of tangents, normals, binormals for each step along the extrudePath. </li>
  61. <li>UVGenerator — Object. object that provides UV generator functions</li>
  62. </ul>
  63. </div>
  64. <div>
  65. This object extrudes a 2D shape to a 3D geometry.
  66. </div>
  67. <div>
  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. </div>
  72. <h2>Properties</h2>
  73. <h2>Methods</h2>
  74. <h3>[method:null addShapeList]([page:Array shapes], [page:Object options])</h3>
  75. <div>
  76. shapes — An Array of shapes to add. <br />
  77. options — Object that can contain the following parameters.
  78. <ul>
  79. <li>curveSegments — int. Number of points on the curves. Default is 12.</li>
  80. <li>steps — int. Number of points used for subdividing segments along the depth of the extruded spline. Default is 1.</li>
  81. <li>amount — int. Depth to extrude the shape. Default is 100.</li>
  82. <li>bevelEnabled — bool. Apply beveling to the shape. Default is true.</li>
  83. <li>bevelThickness — float. How deep into the original shape the bevel goes. Default is 6.</li>
  84. <li>bevelSize — float. Distance from the shape outline that the bevel extends. Default is bevelThickness - 2.</li>
  85. <li>bevelSegments — int. Number of bevel layers. Default is 3.</li>
  86. <li>extrudePath — THREE.CurvePath. A 3D spline path along which the shape should be extruded (creates Frames if frames aren't defined).</li>
  87. <li>frames — An object containing arrays of tangents, normals, binormals for each step along the extrudePath. </li>
  88. <li>UVGenerator — Object. object that provides UV generator functions</li>
  89. </ul>
  90. </div>
  91. <div>Adds the shapes to the list to extrude.</div>
  92. <h3>[method:null addShape]([page:Shape shape], [page:Object options])</h3>
  93. <div>
  94. shape — A shape to add. <br />
  95. options — Object that can contain the following parameters.
  96. <ul>
  97. <li>curveSegments — int. Number of points on the curves. Default is 12.</li>
  98. <li>steps — int. Number of points used for subdividing segments along the depth of the extruded spline. Default is 1.</li>
  99. <li>amount — int. Depth to extrude the shape. Default is 100.</li>
  100. <li>bevelEnabled — bool. Apply beveling to the shape. Default is true.</li>
  101. <li>bevelThickness — float. How deep into the original shape the bevel goes. Default is 6.</li>
  102. <li>bevelSize — float. Distance from the shape outline that the bevel extends. Default is bevelThickness - 2.</li>
  103. <li>bevelSegments — int. Number of bevel layers. Default is 3.</li>
  104. <li>extrudePath — THREE.CurvePath. A 3D spline path along which the shape should be extruded (creates Frames if frames aren't defined).</li>
  105. <li>frames — An object containing arrays of tangents, normals, binormals for each step along the extrudePath. </li>
  106. <li>UVGenerator — Object. object that provides UV generator functions</li>
  107. </ul>
  108. </div>
  109. <div>Add the shape to the list to extrude.</div>
  110. <h2>Source</h2>
  111. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  112. </body>
  113. </html>