RectAreaLight.html 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283
  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; [page:Light] &rarr;
  12. <h1>[name]</h1>
  13. <div class="desc">
  14. RectAreaLight emits light uniformly across the face a rectangular plane. This light type can be
  15. used to simulate light sources such as bright windows or strip lighting.<br /><br />
  16. RectAreaLight does not support shadows.<br /><br />
  17. </div>
  18. <h2>Examples</h2>
  19. <div>
  20. [example:webgl_lights_rectarealight WebGL / rectarealight ]
  21. <code>
  22. var width = 10;
  23. var height = 10;
  24. var intensity = 1;
  25. var rectLight = new THREE.RectAreaLight( 0xffffff, intensity, width, height );
  26. rectLight.position.set( 5, 5, 0 );
  27. rectLight.lookAt( 0, 0, 0 );
  28. scene.add( rectLight )
  29. rectLightHelper = new THREE.RectAreaLightHelper( rectLight );
  30. scene.add( rectLightHelper );
  31. </code>
  32. </div>
  33. <h2>Constructor</h2>
  34. <h3>[name]( [page:Integer color], [page:Float intensity], [page:Float width], [page:Float height] )</h3>
  35. <div>
  36. [page:Integer color] - (optional) hexadecimal color of the light. Default is 0xffffff (white).<br />
  37. [page:Float intensity] - (optional) the light's intensity, or brightness. Default is 1.<br />
  38. [page:Float width] - (optional) width of the light. Default is 10.<br />
  39. [page:Float height] - (optional) height of the light. Default is 10.<br /><br />
  40. Creates a new [name].
  41. </div>
  42. <h2>Properties</h2>
  43. <div>
  44. See the base [page:Light Light] class for common properties.
  45. </div>
  46. <h3>[property:Boolean isRectAreaLight]</h3>
  47. <div>
  48. Used to check whether this or derived classes are RectAreaLights. Default is *true*.<br /><br />
  49. You should not change this, as it used internally for optimisation.
  50. </div>
  51. <h2>Methods</h2>
  52. <div>
  53. See the base [page:Light Light] class for common methods.
  54. </div>
  55. <h3>[method:RectAreaLight copy]( [page:RectAreaLight source] )</h3>
  56. <div>
  57. Copies value of all the properties from the [page:RectAreaLight source] to this
  58. RectAreaLight.
  59. </div>
  60. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  61. </body>
  62. </html>