SpotLightHelper.html 2.1 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980
  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">This displays a cone shaped helper object for a [page:SpotLight].</p>
  13. <h2>Code Example</h2>
  14. <code>
  15. const spotLight = new THREE.SpotLight( 0xffffff );
  16. spotLight.position.set( 10, 10, 10 );
  17. scene.add( spotLight );
  18. const spotLightHelper = new THREE.SpotLightHelper( spotLight );
  19. scene.add( spotLightHelper );
  20. </code>
  21. <h2>Examples</h2>
  22. <p>
  23. [example:webgl_lights_spotlights WebGL/ lights / spotlights ]
  24. </p>
  25. <h2>Constructor</h2>
  26. <h3>[name]( [param:SpotLight light], [param:Hex color] )</h3>
  27. <p>
  28. [page:SpotLight light] -- The [page:SpotLight] to be visualized. <br /><br/>
  29. [page:Hex color] -- (optional) if this is not the set the helper will take the color of the light.
  30. </p>
  31. <h2>Properties</h2>
  32. <p>See the base [page:Object3D] class for common properties.</p>
  33. <h3>[property:LineSegments cone]</h3>
  34. <p>[page:LineSegments] used to visualize the light.</p>
  35. <h3>[property:SpotLight light]</h3>
  36. <p>Reference to the [page:SpotLight] being visualized.</p>
  37. <h3>[property:Object matrix]</h3>
  38. <p>Reference to the spotLight's [page:Object3D.matrixWorld matrixWorld].</p>
  39. <h3>[property:Object matrixAutoUpdate]</h3>
  40. <p>
  41. See [page:Object3D.matrixAutoUpdate]. Set to *false* here as the helper is using the
  42. spotLight's [page:Object3D.matrixWorld matrixWorld].
  43. </p>
  44. <h3>[property:hex color]</h3>
  45. <p>
  46. The color parameter passed in the constructor. Default is *undefined*. If this is changed, the helper's color will update
  47. the next time [page:.update update] is called.
  48. </p>
  49. <h2>Methods</h2>
  50. <p>See the base [page:Object3D] class for common methods.</p>
  51. <h3>[method:null dispose]()</h3>
  52. <p>Disposes of the light helper.</p>
  53. <h3>[method:null update]()</h3>
  54. <p>Updates the light helper.</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>