RectAreaLightHelper.html 1.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869
  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:Object3D] &rarr;
  12. <h1>[name]</h1>
  13. <p class="desc">
  14. Creates a visual aid for a [page:RectAreaLight].
  15. </p>
  16. <h3>Example</h3>
  17. <code>
  18. var light = new THREE.RectAreaLight( 0xffffbb, 1.0, 5, 5 );
  19. var helper = new THREE.RectAreaLightHelper( light );
  20. light.add( helper ); // helper must be added as a child of the light
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [param:RectAreaLight light], [param:Hex color] )</h3>
  24. <p>
  25. [page:RectAreaLight light] -- The light being visualized.<br /><br />
  26. [page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
  27. </p>
  28. <h2>Properties</h2>
  29. <p>See the base [page:Object3D] class for common properties.</p>
  30. <h3>[property:RectAreaLight light]</h3>
  31. <p>Reference to the RectAreaLight being visualized.</p>
  32. <h3>[property:hex color]</h3>
  33. <p>
  34. The color parameter passed in the constructor. Default is *undefined*. If this is changed, the helper's color will update
  35. the next time [page:.update update] is called.
  36. </p>
  37. <h2>Methods</h2>
  38. <p>See the base [page:Object3D] class for common methods.</p>
  39. <h3>[method:null dispose]()</h3>
  40. <p>Dispose of the rectAreaLightHelper.</p>
  41. <h3>[method:null update]()</h3>
  42. <p>Updates the helper to match the position and direction of the [page:.light].</p>
  43. <h2>Source</h2>
  44. <p>
  45. [link:https://github.com/mrdoob/three.js/blob/master/examples/jsm/helpers/RectAreaLightHelper.js examples/jsm/helpers/RectAreaLightHelper.js]
  46. </p>
  47. </body>
  48. </html>