RectAreaLightHelper.html 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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. <div class="desc">
  14. Creates a visual aid for a [page:RectAreaLight].
  15. </div>
  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. scene.add( helper );
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [page:HemisphereLight light] )</h3>
  24. <div>[page:HemisphereLight light] -- The light being visualized.</div>
  25. <h2>Properties</h2>
  26. <div>See the base [page:Object3D] class for common properties.</div>
  27. <h3>[property:HemisphereLight light]</h3>
  28. <div>Reference to the RectAreaLight being visualized.</div>
  29. <h3>[property:Mesh lightMat]</h3>
  30. <div>[page:MeshBasicMaterial] used to visualize the light. This be be rendered the same color as the [page:.light]</div>
  31. <h3>[property:Mesh lightMesh]</h3>
  32. <div>[page:Mesh] used to visualize the light. Used to show the front (light-emitting side) of the light.</div>
  33. <h3>[property:Mesh lightShape]</h3>
  34. <div>[page:ShapeGeometry] used to create the mesh's that visualize the light.</div>
  35. <h3>[property:Mesh lightWireMat]</h3>
  36. <div>[page:MeshBasicMaterial] used to visualize the light's outline. This be be rendered the same color as the [page:.light]</div>
  37. <h3>[property:Mesh lightWireMesh]</h3>
  38. <div>[page:Mesh] used to visualize the light's outline. Used to show the back (non light-emitting side) of the light.</div>
  39. <h2>Methods</h2>
  40. <div>See the base [page:Object3D] class for common methods.</div>
  41. <h3>[method:null dispose]()</h3>
  42. <div>Dispose of the rectAreaLightHelper.</div>
  43. <h3>[method:null update]()</h3>
  44. <div>Updates the helper to match the position and direction of the [page:.light].</div>
  45. <h2>Source</h2>
  46. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  47. </body>
  48. </html>