DirectionalLightHelper.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485
  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. Helper object to assist with visualizing a [page:DirectionalLight]'s effect on the scene.
  14. This consists of plane and a line representing the light's position and direction.
  15. </p>
  16. <h2>Code Example</h2>
  17. <code>
  18. const light = new THREE.DirectionalLight( 0xFFFFFF );
  19. const helper = new THREE.DirectionalLightHelper( light, 5 );
  20. scene.add( helper );
  21. </code>
  22. <h2>Constructor</h2>
  23. <h3>[name]( [param:DirectionalLight light], [param:Number size], [param:Hex color] )</h3>
  24. <p>
  25. [page:DirectionalLight light]-- The light to be visualized. <br /><br />
  26. [page:Number size] -- (optional) dimensions of the plane. Default is `1`.<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:Line lightPlane]</h3>
  32. <p>Contains the line mesh showing the location of the directional light.</p>
  33. <h3>[property:DirectionalLight light]</h3>
  34. <p>Reference to the [page:DirectionalLight directionalLight] being visualized.</p>
  35. <h3>[property:Object matrix]</h3>
  36. <p>Reference to the light's [page:Object3D.matrixWorld matrixWorld].</p>
  37. <h3>[property:Object matrixAutoUpdate]</h3>
  38. <p>
  39. See [page:Object3D.matrixAutoUpdate]. Set to `false` here as the helper is using the
  40. light's [page:Object3D.matrixWorld matrixWorld].
  41. </p>
  42. <h3>[property:hex color]</h3>
  43. <p>
  44. The color parameter passed in the constructor. Default is `undefined`. If this is changed,
  45. the helper's color will update the next time [page:.update update] is called.
  46. </p>
  47. <h2>Methods</h2>
  48. <p>See the base [page:Object3D] class for common properties.</p>
  49. <h3>[method:undefined dispose]()</h3>
  50. <p>
  51. Frees the GPU-related resources allocated by this instance. Call this method whenever this instance is no longer used in your app.
  52. </p>
  53. <h3>[method:undefined update]()</h3>
  54. <p>Updates the helper to match the position and direction of the [page:.light directionalLight] being visualized.</p>
  55. <h2>Source</h2>
  56. <p>
  57. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  58. </p>
  59. </body>
  60. </html>