DirectionalLight.html 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267
  1. <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  2. "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
  3. <html xmlns="http://www.w3.org/1999/xhtml">
  4. <head>
  5. <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
  6. <title>DirectionalLight - A directional light &mdash; three.js v48dev documentation</title>
  7. <link rel="stylesheet" href="../../_static/nature.css" type="text/css" />
  8. <link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
  9. <script type="text/javascript">
  10. var DOCUMENTATION_OPTIONS = {
  11. URL_ROOT: '../../',
  12. VERSION: '48dev',
  13. COLLAPSE_INDEX: false,
  14. FILE_SUFFIX: '.html',
  15. HAS_SOURCE: true
  16. };
  17. </script>
  18. <script type="text/javascript" src="../../_static/jquery.js"></script>
  19. <script type="text/javascript" src="../../_static/underscore.js"></script>
  20. <script type="text/javascript" src="../../_static/doctools.js"></script>
  21. <link rel="top" title="three.js v48dev documentation" href="../../index.html" />
  22. <link rel="up" title="Lights" href="index.html" />
  23. <link rel="next" title="PointLight - A point light" href="PointLight.html" />
  24. <link rel="prev" title="AmbientLight - An ambient light" href="AmbientLight.html" />
  25. </head>
  26. <body>
  27. <div class="related">
  28. <h3>Navigation</h3>
  29. <ul>
  30. <li class="right" style="margin-right: 10px">
  31. <a href="../../genindex.html" title="General Index"
  32. accesskey="I">index</a></li>
  33. <li class="right" >
  34. <a href="PointLight.html" title="PointLight - A point light"
  35. accesskey="N">next</a> |</li>
  36. <li class="right" >
  37. <a href="AmbientLight.html" title="AmbientLight - An ambient light"
  38. accesskey="P">previous</a> |</li>
  39. <li><a href="../../index.html">three.js v48dev documentation</a> &raquo;</li>
  40. <li><a href="index.html" accesskey="U">Lights</a> &raquo;</li>
  41. </ul>
  42. </div>
  43. <div class="document">
  44. <div class="documentwrapper">
  45. <div class="bodywrapper">
  46. <div class="body">
  47. <div class="section" id="directionallight-a-directional-light">
  48. <h1>DirectionalLight - A directional light<a class="headerlink" href="#directionallight-a-directional-light" title="Permalink to this headline">¶</a></h1>
  49. <p class="rubric">Constructor</p>
  50. <dl class="class">
  51. <dt id="DirectionalLight">
  52. <em class="property">class </em><tt class="descname">DirectionalLight</tt><big>(</big><em>hex</em>, <em>intensity</em>, <em>distance</em><big>)</big><a class="headerlink" href="#DirectionalLight" title="Permalink to this definition">¶</a></dt>
  53. <dd><p>A directional light</p>
  54. <p>Part of scene graph</p>
  55. <p>Inherits from <a class="reference internal" href="Light.html#Light" title="Light"><tt class="xref js js-class docutils literal"><span class="pre">Light()</span></tt></a> <a class="reference internal" href="../core/Object3D.html#Object3D" title="Object3D"><tt class="xref js js-class docutils literal"><span class="pre">Object3D()</span></tt></a></p>
  56. <p>Affects <tt class="xref js js-class docutils literal"><span class="pre">MeshLambertMaterial()</span></tt> and <tt class="xref js js-class docutils literal"><span class="pre">MeshPhongMaterial()</span></tt></p>
  57. <table class="docutils field-list" frame="void" rules="none">
  58. <col class="field-name" />
  59. <col class="field-body" />
  60. <tbody valign="top">
  61. <tr class="field"><th class="field-name">Arguments:</th><td class="field-body"><ul class="first last simple">
  62. <li><strong>hex</strong> (<em>integer</em>) &#8211; light color</li>
  63. <li><strong>intensity</strong> (<em>float</em>) &#8211; light intensity</li>
  64. <li><strong>distance</strong> (<em>float</em>) &#8211; distance affected by light</li>
  65. </ul>
  66. </td>
  67. </tr>
  68. </tbody>
  69. </table>
  70. </dd></dl>
  71. <p class="rubric">Attributes</p>
  72. <dl class="attribute">
  73. <dt id="DirectionalLight.color">
  74. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">color</tt><a class="headerlink" href="#DirectionalLight.color" title="Permalink to this definition">¶</a></dt>
  75. <dd><p>Light <a class="reference internal" href="../core/Color.html#Color" title="Color"><tt class="xref js js-class docutils literal"><span class="pre">Color()</span></tt></a></p>
  76. </dd></dl>
  77. <dl class="attribute">
  78. <dt id="DirectionalLight.intensity">
  79. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">intensity</tt><a class="headerlink" href="#DirectionalLight.intensity" title="Permalink to this definition">¶</a></dt>
  80. <dd><p>Light intensity</p>
  81. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">1.0</span></tt></p>
  82. </dd></dl>
  83. <dl class="attribute">
  84. <dt id="DirectionalLight.position">
  85. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">position</tt><a class="headerlink" href="#DirectionalLight.position" title="Permalink to this definition">¶</a></dt>
  86. <dd><p>Direction of the light is normalized vector from <tt class="docutils literal"><span class="pre">position</span></tt> to <tt class="docutils literal"><span class="pre">(0,0,0)</span></tt>.</p>
  87. </dd></dl>
  88. <dl class="attribute">
  89. <dt id="DirectionalLight.distance">
  90. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">distance</tt><a class="headerlink" href="#DirectionalLight.distance" title="Permalink to this definition">¶</a></dt>
  91. <dd><p>Modulating directional light by distance not implemented in <tt class="xref js js-class docutils literal"><span class="pre">WebGLRenderer()</span></tt></p>
  92. </dd></dl>
  93. <p class="rubric">Shadow attributes</p>
  94. <dl class="attribute">
  95. <dt id="DirectionalLight.castShadow">
  96. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">castShadow</tt><a class="headerlink" href="#DirectionalLight.castShadow" title="Permalink to this definition">¶</a></dt>
  97. <dd><p>If set to <cite>true</cite> light will cast dynamic shadows</p>
  98. <p>Warning: this is expensive and requires tweaking to get shadows looking right.</p>
  99. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">false</span></tt></p>
  100. </dd></dl>
  101. <dl class="attribute">
  102. <dt id="DirectionalLight.onlyShadow">
  103. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">onlyShadow</tt><a class="headerlink" href="#DirectionalLight.onlyShadow" title="Permalink to this definition">¶</a></dt>
  104. <dd><p>If set to <cite>true</cite> light will only cast shadow but not contribute any lighting (as if intensity was 0 but cheaper to compute)</p>
  105. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">false</span></tt></p>
  106. </dd></dl>
  107. <dl class="attribute">
  108. <dt id="DirectionalLight.target">
  109. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">target</tt><a class="headerlink" href="#DirectionalLight.target" title="Permalink to this definition">¶</a></dt>
  110. <dd><p><a class="reference internal" href="../core/Object3D.html#Object3D" title="Object3D"><tt class="xref js js-class docutils literal"><span class="pre">Object3D()</span></tt></a> target used for shadow camera orientation</p>
  111. </dd></dl>
  112. <dl class="attribute">
  113. <dt id="DirectionalLight.shadowCameraNear">
  114. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraNear</tt><a class="headerlink" href="#DirectionalLight.shadowCameraNear" title="Permalink to this definition">¶</a></dt>
  115. <dd><p>Orthographic shadow camera frustum parameter</p>
  116. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">50</span></tt></p>
  117. </dd></dl>
  118. <dl class="attribute">
  119. <dt id="DirectionalLight.shadowCameraFar">
  120. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraFar</tt><a class="headerlink" href="#DirectionalLight.shadowCameraFar" title="Permalink to this definition">¶</a></dt>
  121. <dd><p>Orthographic shadow camera frustum parameter</p>
  122. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">5000</span></tt></p>
  123. </dd></dl>
  124. <dl class="attribute">
  125. <dt id="DirectionalLight.shadowCameraLeft">
  126. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraLeft</tt><a class="headerlink" href="#DirectionalLight.shadowCameraLeft" title="Permalink to this definition">¶</a></dt>
  127. <dd><p>Orthographic shadow camera frustum parameter</p>
  128. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">-500</span></tt></p>
  129. </dd></dl>
  130. <dl class="attribute">
  131. <dt id="DirectionalLight.shadowCameraRight">
  132. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraRight</tt><a class="headerlink" href="#DirectionalLight.shadowCameraRight" title="Permalink to this definition">¶</a></dt>
  133. <dd><p>Orthographic shadow camera frustum parameter</p>
  134. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">500</span></tt></p>
  135. </dd></dl>
  136. <dl class="attribute">
  137. <dt id="DirectionalLight.shadowCameraTop">
  138. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraTop</tt><a class="headerlink" href="#DirectionalLight.shadowCameraTop" title="Permalink to this definition">¶</a></dt>
  139. <dd><p>Orthographic shadow camera frustum parameter</p>
  140. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">500</span></tt></p>
  141. </dd></dl>
  142. <dl class="attribute">
  143. <dt id="DirectionalLight.shadowCameraBottom">
  144. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraBottom</tt><a class="headerlink" href="#DirectionalLight.shadowCameraBottom" title="Permalink to this definition">¶</a></dt>
  145. <dd><p>Orthographic shadow camera frustum parameter</p>
  146. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">-500</span></tt></p>
  147. </dd></dl>
  148. <dl class="attribute">
  149. <dt id="DirectionalLight.shadowCameraVisible">
  150. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowCameraVisible</tt><a class="headerlink" href="#DirectionalLight.shadowCameraVisible" title="Permalink to this definition">¶</a></dt>
  151. <dd><p>Show debug shadow camera frustum</p>
  152. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">false</span></tt></p>
  153. </dd></dl>
  154. <dl class="attribute">
  155. <dt id="DirectionalLight.shadowBias">
  156. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowBias</tt><a class="headerlink" href="#DirectionalLight.shadowBias" title="Permalink to this definition">¶</a></dt>
  157. <dd><p>Shadow map bias</p>
  158. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">0</span></tt></p>
  159. </dd></dl>
  160. <dl class="attribute">
  161. <dt id="DirectionalLight.shadowDarkness">
  162. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowDarkness</tt><a class="headerlink" href="#DirectionalLight.shadowDarkness" title="Permalink to this definition">¶</a></dt>
  163. <dd><p>Darkness of shadow casted by this light (<tt class="docutils literal"><span class="pre">float</span></tt> from 0 to 1)</p>
  164. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">0.5</span></tt></p>
  165. </dd></dl>
  166. <dl class="attribute">
  167. <dt id="DirectionalLight.shadowMapWidth">
  168. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowMapWidth</tt><a class="headerlink" href="#DirectionalLight.shadowMapWidth" title="Permalink to this definition">¶</a></dt>
  169. <dd><p>Shadow map texture width in pixels</p>
  170. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">512</span></tt></p>
  171. </dd></dl>
  172. <dl class="attribute">
  173. <dt id="DirectionalLight.shadowMapHeight">
  174. <tt class="descclassname">DirectionalLight.</tt><tt class="descname">shadowMapHeight</tt><a class="headerlink" href="#DirectionalLight.shadowMapHeight" title="Permalink to this definition">¶</a></dt>
  175. <dd><p>Shadow map texture height in pixels</p>
  176. <p><tt class="docutils literal"><span class="pre">default</span> <span class="pre">512</span></tt></p>
  177. </dd></dl>
  178. <p class="rubric">Example</p>
  179. <div class="highlight-javascript"><div class="highlight"><pre><span class="c1">// white directional light at half intensity shining from the top</span>
  180. <span class="kd">var</span> <span class="nx">directionalLight</span> <span class="o">=</span> <span class="k">new</span> <span class="nx">THREE</span><span class="p">.</span><span class="nx">DirectionalLight</span><span class="p">(</span> <span class="mh">0xffffff</span><span class="p">,</span> <span class="mf">0.5</span> <span class="p">);</span>
  181. <span class="nx">directionalLight</span><span class="p">.</span><span class="nx">position</span><span class="p">.</span><span class="nx">set</span><span class="p">(</span> <span class="mi">0</span><span class="p">,</span> <span class="mi">1</span><span class="p">,</span> <span class="mi">0</span> <span class="p">);</span>
  182. <span class="nx">scene</span><span class="p">.</span><span class="nx">add</span><span class="p">(</span> <span class="nx">directionalLight</span> <span class="p">);</span>
  183. </pre></div>
  184. </div>
  185. </div>
  186. </div>
  187. </div>
  188. </div>
  189. <div class="sphinxsidebar">
  190. <div class="sphinxsidebarwrapper">
  191. <h4>Previous topic</h4>
  192. <p class="topless"><a href="AmbientLight.html"
  193. title="previous chapter">AmbientLight - An ambient light</a></p>
  194. <h4>Next topic</h4>
  195. <p class="topless"><a href="PointLight.html"
  196. title="next chapter">PointLight - A point light</a></p>
  197. <h3>This Page</h3>
  198. <ul class="this-page-menu">
  199. <li><a href="../../_sources/api/lights/DirectionalLight.txt"
  200. rel="nofollow">Show Source</a></li>
  201. </ul>
  202. <div id="searchbox" style="display: none">
  203. <h3>Quick search</h3>
  204. <form class="search" action="../../search.html" method="get">
  205. <input type="text" name="q" size="18" />
  206. <input type="submit" value="Go" />
  207. <input type="hidden" name="check_keywords" value="yes" />
  208. <input type="hidden" name="area" value="default" />
  209. </form>
  210. <p class="searchtip" style="font-size: 90%">
  211. Enter search terms or a module, class or function name.
  212. </p>
  213. </div>
  214. <script type="text/javascript">$('#searchbox').show(0);</script>
  215. </div>
  216. </div>
  217. <div class="clearer"></div>
  218. </div>
  219. <div class="related">
  220. <h3>Navigation</h3>
  221. <ul>
  222. <li class="right" style="margin-right: 10px">
  223. <a href="../../genindex.html" title="General Index"
  224. >index</a></li>
  225. <li class="right" >
  226. <a href="PointLight.html" title="PointLight - A point light"
  227. >next</a> |</li>
  228. <li class="right" >
  229. <a href="AmbientLight.html" title="AmbientLight - An ambient light"
  230. >previous</a> |</li>
  231. <li><a href="../../index.html">three.js v48dev documentation</a> &raquo;</li>
  232. <li><a href="index.html" >Lights</a> &raquo;</li>
  233. </ul>
  234. </div>
  235. <div class="footer">
  236. &copy; Copyright 2010-2012, three.js Authors.
  237. Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
  238. </div>
  239. </body>
  240. </html>