PlaneHelper.html 1.7 KB

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