HemisphereLightHelper.html 2.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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;
  11. <h1>[name]</h1>
  12. <p class="desc">
  13. Creates a visual aid consisting of a spherical [page:Mesh] for a
  14. [page:HemisphereLight HemisphereLight].
  15. </p>
  16. <h2>Code Example</h2>
  17. <code>
  18. const light = new THREE.HemisphereLight( 0xffffbb, 0x080820, 1 );
  19. const helper = new THREE.HemisphereLightHelper( light, 5 );
  20. scene.add( helper );
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>
  24. [name]( [param:HemisphereLight light], [param:Number sphereSize],
  25. [param:Hex color] )
  26. </h3>
  27. <p>
  28. [page:HemisphereLight light] -- The light being visualized. <br /><br />
  29. [page:Number size] -- The size of the mesh used to visualize the light.<br /><br />
  30. [page:Hex color] -- (optional) if this is not the set the helper will take
  31. the color of the light.
  32. </p>
  33. <h2>Properties</h2>
  34. <p>See the base [page:Object3D] class for common properties.</p>
  35. <h3>[property:HemisphereLight light]</h3>
  36. <p>Reference to the HemisphereLight being visualized.</p>
  37. <h3>[property:Object matrix]</h3>
  38. <p>
  39. Reference to the hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
  40. </p>
  41. <h3>[property:Object matrixAutoUpdate]</h3>
  42. <p>
  43. See [page:Object3D.matrixAutoUpdate]. Set to `false` here as the helper is
  44. using the hemisphereLight's [page:Object3D.matrixWorld matrixWorld].
  45. </p>
  46. <h3>[property:hex color]</h3>
  47. <p>
  48. The color parameter passed in the constructor. Default is `undefined`. If
  49. this is changed, the helper's color will update the next time
  50. [page:.update update] is called.
  51. </p>
  52. <h2>Methods</h2>
  53. <p>See the base [page:Object3D] class for common methods.</p>
  54. <h3>[method:undefined dispose]()</h3>
  55. <p>
  56. Frees the GPU-related resources allocated by this instance. Call this
  57. method whenever this instance is no longer used in your app.
  58. </p>
  59. <h3>[method:undefined update]()</h3>
  60. <p>
  61. Updates the helper to match the position and direction of the
  62. [page:.light].
  63. </p>
  64. <h2>Source</h2>
  65. <p>
  66. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  67. </p>
  68. </body>
  69. </html>