HemisphereLightHelper.html 1.8 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. <div class="desc">
  14. Creates a visual aid consisting of a spherical [page:Mesh] for a [page:HemisphereLight HemisphereLight].
  15. </div>
  16. <h3>Example</h3>
  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]([page:HemisphereLight light], [page:Number sphereSize])</h3>
  24. <div>
  25. [page:HemisphereLight light] -- The light being visualized. <br />
  26. [page:Number size] -- The size of the mesh used to visualize the light.
  27. </div>
  28. <h2>Properties</h2>
  29. <div>See the base [page:Object3D] class for common properties.</div>
  30. <h3>[property:HemisphereLight light]</h3>
  31. <div>Reference to the HemisphereLight being visualized.</div>
  32. <h3>[property:object matrix]</h3>
  33. <div>Reference to the hemisphereLight's [page:Object3D.matrixWorld matrixWorld].</div>
  34. <h3>[property:object matrixAutoUpdate]</h3>
  35. <div>
  36. See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
  37. hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
  38. </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 hemisphereLightHelper.</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>