BoxBufferGeometry.html 2.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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">This is the [page:BufferGeometry] port of [page:BoxGeometry].</p>
  13. <iframe id="scene" src="scenes/geometry-browser.html#BoxBufferGeometry"></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.BoxBufferGeometry( 1, 1, 1 );
  25. const material = new THREE.MeshBasicMaterial( {color: 0x00ff00} );
  26. const cube = new THREE.Mesh( geometry, material );
  27. scene.add( cube );
  28. </code>
  29. <h2>Constructor</h2>
  30. <h3>[name]([param:Float width], [param:Float height], [param:Float depth], [param:Integer widthSegments], [param:Integer heightSegments], [param:Integer depthSegments])</h3>
  31. <p>
  32. width — Width; that is, the length of the edges parallel to the X axis. Optional; defaults to 1.<br />
  33. height — Height; that is, the length of the edges parallel to the Y axis. Optional; defaults to 1.<br />
  34. depth — Depth; that is, the length of the edges parallel to the Z axis. Optional; defaults to 1.<br />
  35. widthSegments — Number of segmented rectangular faces along the width of the sides. Optional; defaults to 1.<br />
  36. heightSegments — Number of segmented rectangular faces along the height of the sides. Optional; defaults to 1.<br />
  37. depthSegments — Number of segmented rectangular faces along the depth of the sides. Optional; defaults to 1.<br />
  38. </p>
  39. <h2>Properties</h2>
  40. <p>See the base [page:BufferGeometry] class for common properties.</p>
  41. <h3>[property:Object parameters]</h3>
  42. <p>
  43. An object with a property for each of the constructor parameters. Any modification after instantiation does not change the geometry.
  44. </p>
  45. <p>
  46. Using the above example:
  47. <code>
  48. geometry.parameters; // {width: 1, height: 1, depth: 1, widthSegments: undefined, heightSegments: undefined, depthSegments: undefined}
  49. cube.geometry.parameters; // as above
  50. cube.geometry.parameters.width; // === 1
  51. cube.geometry.parameters.widthSegments; // === undefined.
  52. </code>
  53. </p>
  54. <h2>Methods</h2>
  55. <p>See the base [page:BufferGeometry] class for common methods.</p>
  56. <h2>Source</h2>
  57. <p>
  58. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  59. </p>
  60. </body>
  61. </html>