PlaneHelper.html 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  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:LineSegments] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">
  14. Helper object to visualize a [page:Plane].
  15. </div>
  16. <h2>Example</h2>
  17. <code>
  18. var plane = new THREE.Plane( new THREE.Vector3( 1, 1, 0.2 ), 3 );
  19. var helper = new THREE.PlaneHelper( plane, 1, 0xffff00 );
  20. scene.add( helper );
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [page:Plane plane], [page:Float size], [page:Color hex] )</h3>
  24. <div>
  25. [page:Plane plane] -- the plane to visualize.<br />
  26. [page:Float size] -- (optional) side length of plane helper. Default is 1.<br />
  27. [page:Color color] -- (optional) the color of the helper. Default is 0xffff00.<br /><br />
  28. Creates a new wireframe representation of the passed plane.
  29. </div>
  30. <h2>Properties</h2>
  31. <div>See the base [page:LineSegments] class for common properties.</div>
  32. <h3>[property:Plane plane]</h3>
  33. <div>The [page:Plane plane] being visualized.</div>
  34. <h3>[property:Float size]</h3>
  35. <div>The side lengths of plane helper.</div>
  36. <h2>Methods</h2>
  37. <div>See the base [page:LineSegments] class for common methods.</div>
  38. <h3>[method:void updateMatrixWorld]( force )</h3>
  39. <div>
  40. This overrides the method in the base [page:Object3D] class so that it also
  41. updates the helper object according to the [page:PlaneHelper.plane .plane] and
  42. [page:PlaneHelper.size .size] properties.
  43. </div>
  44. <h2>Source</h2>
  45. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  46. </body>
  47. </html>