HemisphereLightHelper.html 2.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778
  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 consisting of a spherical [page:Mesh] for a [page:HemisphereLight HemisphereLight].
  15. </p>
  16. <h2>Code Example</h2>
  17. <code>
  18. var light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  19. var helper = new THREE.HemisphereLightHelper( light, 5 );
  20. scene.add( helper );
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [param:HemisphereLight light], [param:Number sphereSize], [param:Hex color] )</h3>
  24. <p>
  25. [page:HemisphereLight light] -- The light being visualized. <br /><br />
  26. [page:Number size] -- The size of the mesh used to visualize the light.<br /><br />
  27. [page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
  28. </p>
  29. <h2>Properties</h2>
  30. <p>See the base [page:Object3D] class for common properties.</p>
  31. <h3>[property:HemisphereLight light]</h3>
  32. <p>Reference to the HemisphereLight being visualized.</p>
  33. <h3>[property:object matrix]</h3>
  34. <p>Reference to the hemisphereLight's [page:Object3D.matrixWorld matrixWorld].</p>
  35. <h3>[property:object matrixAutoUpdate]</h3>
  36. <p>
  37. See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
  38. hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
  39. </p>
  40. <h3>[property:hex color]</h3>
  41. <p>
  42. The color parameter passed in the constructor. Default is *undefined*. If this is changed, the helper's color will update
  43. the next time [page:.update update] is called.
  44. </p>
  45. <h2>Methods</h2>
  46. <p>See the base [page:Object3D] class for common methods.</p>
  47. <h3>[method:null dispose]()</h3>
  48. <p>Dispose of the hemisphereLightHelper.</p>
  49. <h3>[method:null update]()</h3>
  50. <p>Updates the helper to match the position and direction of the [page:.light].</p>
  51. <h2>Source</h2>
  52. <p>
  53. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  54. </p>
  55. </body>
  56. </html>