SpotLight.html 6.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201
  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 with a falloff cone.</div>
  14. <div class="desc">Affects objects using [page:MeshLambertMaterial] or [page:MeshPhongMaterial].</div>
  15. <h2>Example</h2>
  16. <div>[example:webgl_lights_spotlight lights / spotlight ]</div>
  17. <div>[example:webgl_lights_spotlights lights / spotlights ]</div>
  18. <div>[example:webgl_interactive_cubes_gpu interactive / cubes / gpu ]</div>
  19. <div>[example:webgl_interactive_draggablecubes interactive / draggablecubes ]</div>
  20. <div>[example:webgl_materials_bumpmap_skin materials / bumpmap / skin ]</div>
  21. <div>[example:webgl_materials_cubemap_dynamic materials / cubemap / dynamic ]</div>
  22. <div>[example:webgl_morphtargets_md2 morphtargets / md2 ]</div>
  23. <div>[example:webgl_shading_physical shading / physical ]</div>
  24. <code>
  25. // white spotlight shining from the side, casting shadow
  26. var spotLight = new THREE.SpotLight( 0xffffff );
  27. spotLight.position.set( 100, 1000, 100 );
  28. spotLight.castShadow = true;
  29. spotLight.shadowMapWidth = 1024;
  30. spotLight.shadowMapHeight = 1024;
  31. spotLight.shadowCameraNear = 500;
  32. spotLight.shadowCameraFar = 4000;
  33. spotLight.shadowCameraFov = 30;
  34. scene.add( spotLight );
  35. </code>
  36. <div>
  37. [example:webgl_materials_bumpmap materials / bumpmap]<br/>
  38. [example:webgl_shading_physical shading / physical]<br/>
  39. [example:webgl_shadowmap shadowmap]<br/>
  40. [example:webgl_shadowmap_viewer shadowmap / performance]<br/>
  41. [example:webgl_shadowmap_viewer shadowmap / viewer]
  42. </div>
  43. <h2>Constructor</h2>
  44. <h3>[name]([page:Integer hex], [page:Float intensity], [page:Float distance], [page:Radians angle], [page:Float penumbra], [page:Float decay])</h3>
  45. <div>
  46. [page:Integer hex] — Numeric value of the RGB component of the color. <br />
  47. [page:Float intensity] — Numeric value of the light's strength/intensity. <br />
  48. [page:Float distance] -- Maximum distance from origin where light will shine whose intensity is attenuated linearly based on distance from origin. <br />
  49. [page:Radians angle] -- Maximum angle of light dispersion from its direction whose upper bound is Math.PI/2.<br />
  50. [page:Float penumbra] -- Percent of the spotlight cone that is attenuated due to penumbra. Takes values between zero and 1. Default is zero.<br />
  51. [page:Float decay] -- The amount the light dims along the distance of the light.
  52. </div>
  53. <h2>Properties</h2>
  54. <h3>[property:Object3D target]</h3>
  55. <div>
  56. Spotlight focus points at target.position.<br />
  57. Default position — *(0,0,0)*.<br />
  58. *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>
  59. </div>
  60. <h3>[property:Float intensity]</h3>
  61. <div>
  62. Light's intensity.<br />
  63. In "physically correct" mode, the product of color * intensity is interpreted as luminous intensity measured in candela.<br/>
  64. Default — *1.0*.
  65. </div>
  66. <h3>[property:Float power]</h3>
  67. <div>
  68. Light's power.<br />
  69. In "physically correct" mode, the luminous power of the light measured in lumens.<br/>
  70. Default - *4PI*.
  71. </div>
  72. <h3>[property:Float distance]</h3>
  73. <div>
  74. If non-zero, light will attenuate linearly from maximum intensity at light *position* down to zero at *distance*.<br />
  75. Default — *0.0*.
  76. </div>
  77. <h3>[property:Float angle]</h3>
  78. <div>
  79. Maximum extent of the spotlight, in radians, from its direction. Should be no more than *Math.PI/2*.<br />
  80. Default — *Math.PI/3*.
  81. </div>
  82. <h3>[property:Float penumbra]</h3>
  83. <div>
  84. Percent of the spotlight cone that is attenuated due to penumbra. Takes values between zero and 1.<br />
  85. Default — *0.0*.
  86. </div>
  87. <h3>[property:Float decay]</h3>
  88. <div>
  89. The amount the light dims along the distance of the light<br />
  90. In "physically correct" mode, decay = 2 leads to physically realistic light falloff.<br/>
  91. Default — *1*.
  92. </div>
  93. <h3>[property:Boolean castShadow]</h3>
  94. <div>
  95. If set to *true* light will cast dynamic shadows. *Warning*: This is expensive and requires tweaking to get shadows looking right.<br />
  96. Default — *false*.
  97. </div>
  98. <h3>[property:Float shadowCameraNear]</h3>
  99. <div>
  100. Perspective shadow camera frustum <em>near</em> parameter.<br />
  101. Default — *50*.
  102. </div>
  103. <h3>[property:Float shadowCameraFar]</h3>
  104. <div>
  105. Perspective shadow camera frustum <em>far</em> parameter.<br />
  106. Default — *5000*.
  107. </div>
  108. <h3>[property:Float shadowCameraFov]</h3>
  109. <div>
  110. Perspective shadow camera frustum <em>field of view</em> parameter.<br />
  111. Default — *50*.
  112. </div>
  113. <h3>[property:Boolean shadowCameraVisible]</h3>
  114. <div>
  115. Show debug shadow camera frustum.<br />
  116. Default — *false*.
  117. </div>
  118. <h3>[property:Float shadowBias]</h3>
  119. <div>
  120. Shadow map bias, how much to add or subtract from the normalized depth when deciding whether a surface is in shadow.<br />
  121. Default — *0*.
  122. </div>
  123. <h3>[property:Integer shadowMapWidth]</h3>
  124. <div>
  125. Shadow map texture width in pixels.<br />
  126. Default — *512*.
  127. </div>
  128. <h3>[property:Integer shadowMapHeight]</h3>
  129. <div>
  130. Shadow map texture height in pixels.<br />
  131. Default — *512*.
  132. </div>
  133. <h3>[property:Vector2 shadowMapSize]</h3>
  134. <div>
  135. The shadowMapWidth and shadowMapHeight stored in a [page:Vector2 THREE.Vector2]. Set internally during rendering.
  136. </div>
  137. <h3>[property:PerspectiveCamera shadowCamera]</h3>
  138. <div>
  139. The shadow's view of the world. Computed internally during rendering from the shadowCamera* settings.
  140. </div>
  141. <h3>[property:Matrix4 shadowMatrix]</h3>
  142. <div>
  143. Model to shadow camera space, to compute location and depth in shadow map. Computed internally during rendering.
  144. </div>
  145. <h3>[property:WebGLRenderTarget shadowMap]</h3>
  146. <div>
  147. The depth map generated using the shadowCamera; a location beyond a pixel's depth is in shadow. Computed internally during rendering.
  148. </div>
  149. <h2>Methods</h2>
  150. <h3>[method:SpotLight clone]()</h3>
  151. <div>
  152. <br />
  153. It returns a clone of SpotLight.
  154. </div>
  155. <h3>[method:JSON toJSON]()</h3>
  156. <div>
  157. Return SpotLight data in JSON format.
  158. </div>
  159. <h2>Source</h2>
  160. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  161. </body>
  162. </html>