SpotLight.html 5.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142
  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">A point light that can cast a shadow in one direction within a falloff cone.</div>
  14. <div class="desc">Affects objects using [page:MeshLambertMaterial] or [page:MeshPhongMaterial].</div>
  15. <h2>Example</h2>
  16. <iframe src='../examples/webgl_lights_spotlight.html'></iframe>
  17. <a target="THREE_Examples" href="../examples/#webgl_lights_spotlight">View in Examples</a><br />
  18. <h2>Other Examples</h2>
  19. <div>[example:webgl_lights_spotlights lights / spotlights ]</div>
  20. <div>[example:webgl_interactive_cubes_gpu interactive / cubes / gpu ]</div>
  21. <div>[example:webgl_interactive_draggablecubes interactive / draggablecubes ]</div>
  22. <div>[example:webgl_materials_bumpmap_skin materials / bumpmap / skin ]</div>
  23. <div>[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic ]</div>
  24. <div>[example:webgl_morphtargets_md2 morphtargets / md2 ]</div>
  25. <div>[example:webgl_shading_physical shading / physical ]</div>
  26. <h2>Code Example</h2>
  27. <code>
  28. // white spotlight shining from the side, casting shadow
  29. var spotLight = new THREE.SpotLight( 0xffffff );
  30. spotLight.position.set( 100, 1000, 100 );
  31. spotLight.castShadow = true;
  32. spotLight.shadow.mapSize.width = 1024;
  33. spotLight.shadow.mapSize.height = 1024;
  34. spotLight.shadow.camera.near = 500;
  35. spotLight.shadow.camera.far = 4000;
  36. spotLight.shadow.camera.fov = 30;
  37. scene.add( spotLight );
  38. </code>
  39. <h2>Extra Examples</h2>
  40. <div>
  41. [example:webgl_materials_bumpmap materials / bumpmap]<br/>
  42. [example:webgl_shading_physical shading / physical]<br/>
  43. [example:webgl_shadowmap shadowmap]<br/>
  44. [example:webgl_shadowmap_viewer shadowmap / performance]<br/>
  45. [example:webgl_shadowmap_viewer shadowmap / viewer]
  46. </div>
  47. <h2>Constructor</h2>
  48. <h3>[name]( [page:Integer color], [page:Float intensity], [page:Float distance], [page:Radians angle], [page:Float penumbra], [page:Float decay] )</h3>
  49. <div>
  50. [page:Integer color] — Numeric value of the RGB component of the color. <br />
  51. [page:Float intensity] — Numeric value of the light's strength/intensity. <br />
  52. [page:Float distance] -- Maximum distance from origin where light will shine whose intensity is attenuated linearly based on distance from origin. <br />
  53. [page:Radians angle] -- Maximum angle of light dispersion from its direction whose upper bound is Math.PI/2.<br />
  54. [page:Float penumbra] -- Percent of the spotlight cone that is attenuated due to penumbra. Takes values between zero and 1. Default is zero.<br />
  55. [page:Float decay] -- The amount the light dims along the distance of the light.
  56. </div>
  57. <h2>Properties</h2>
  58. See the base [page:Light Light] class for common properties.
  59. <h3>[property:Object3D target]</h3>
  60. <div>
  61. Spotlight focus points at target.position.<br />
  62. Default position — *(0,0,0)*.<br />
  63. *Note*: Currently for target property to work properly, it must be part of the [page:Scene scene], e.g. this will help: <code>scene.add( light.target )</code>
  64. </div>
  65. <h3>[property:Float power]</h3>
  66. <div>
  67. Light's power.<br />
  68. In "physically correct" mode, the luminous power of the light measured in lumens.<br/>
  69. Default - *4PI*.
  70. </div>
  71. <h3>[property:Float distance]</h3>
  72. <div>
  73. If non-zero, light will attenuate linearly from maximum intensity at light *position* down to zero at *distance*.<br />
  74. Default — *0.0*.
  75. </div>
  76. <h3>[property:Float angle]</h3>
  77. <div>
  78. Maximum extent of the spotlight, in radians, from its direction. Should be no more than *Math.PI/2*.<br />
  79. Default — *Math.PI/3*.
  80. </div>
  81. <h3>[property:Float penumbra]</h3>
  82. <div>
  83. Percent of the spotlight cone that is attenuated due to penumbra. Takes values between zero and 1.<br />
  84. Default — *0.0*.
  85. </div>
  86. <h3>[property:Float decay]</h3>
  87. <div>
  88. The amount the light dims along the distance of the light<br />
  89. In "physically correct" mode, decay = 2 leads to physically realistic light falloff.<br/>
  90. Default — *1*.
  91. </div>
  92. <h3>[property:SpotLightShadow shadow]</h3>
  93. <div>
  94. This property stores all relevant information for rendering the shadow of the light.<br />
  95. </div>
  96. <h3>[property:Boolean castShadow]</h3>
  97. <div>
  98. If set to *true* light will cast dynamic shadows. *Warning*: This is expensive and requires tweaking to get shadows looking right.<br />
  99. Default — *false*.
  100. </div>
  101. <h2>Methods</h2>
  102. See the base [page:Light Light] class for common methods.
  103. <h3>[method:SpotLight copy]( [page:SpotLight source] )</h3>
  104. <div>
  105. <br />
  106. Copies value of *source* to this SpotLight object.
  107. </div>
  108. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  109. </body>
  110. </html>