RectAreaLightNode.html 4.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>RectAreaLightNode - Three.js Docs</title>
  6. <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
  7. <script src="../scripts/highlight.min.js"></script>
  8. <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
  9. <link type="text/css" rel="stylesheet" href="../styles/page.css">
  10. </head>
  11. <body>
  12. <p class="inheritance" translate="no"><a href="EventDispatcher.html">EventDispatcher</a> → <a href="Node.html">Node</a> → <a href="LightingNode.html">LightingNode</a> → <a href="AnalyticLightNode.html">AnalyticLightNode</a> → </p>
  13. <h1 translate="no">RectAreaLightNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Module for representing rect area lights as nodes.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="RectAreaLightNode" translate="no">new <a href="#RectAreaLightNode">RectAreaLightNode</a><span class="signature">( light : <span class="param-type">RectAreaLight</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new rect area light node.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>light</code></td>
  30. <td class="description last"><p>The rect area light source.<br/>Default is <code>null</code>.</p></td>
  31. </tr>
  32. </tbody>
  33. </table>
  34. </div>
  35. </div>
  36. <h2 class="subsection-title">Properties</h2>
  37. <div class="member">
  38. <h3 class="name" id="halfHeight" translate="no">.<a href="#halfHeight">halfHeight</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;vec3></span> </h3>
  39. <div class="description">
  40. <p>Uniform node representing the half height of the are light.</p>
  41. </div>
  42. </div>
  43. <div class="member">
  44. <h3 class="name" id="halfWidth" translate="no">.<a href="#halfWidth">halfWidth</a><span class="type-signature"> : <a href="UniformNode.html">UniformNode</a>.&lt;vec3></span> </h3>
  45. <div class="description">
  46. <p>Uniform node representing the half width of the are light.</p>
  47. </div>
  48. </div>
  49. <div class="member">
  50. <h3 class="name" id="updateType" translate="no">.<a href="#updateType">updateType</a><span class="type-signature"> : string</span> </h3>
  51. <div class="description">
  52. <p>The <code>updateType</code> is set to <code>NodeUpdateType.RENDER</code> since the light
  53. relies on <code>viewMatrix</code> which might vary per render call.<br/>Default is <code>'render'</code>.</p>
  54. </div>
  55. <dl class="details">
  56. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="AnalyticLightNode.html#updateType">AnalyticLightNode#updateType</a></dt>
  57. </dl>
  58. </div>
  59. <h2 class="subsection-title">Methods</h2>
  60. <h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">( frame : <span class="param-type">NodeFrame</span> )</span> </h3>
  61. <div class="method">
  62. <div class="description">
  63. <p>Overwritten to updated rect area light specific uniforms.</p>
  64. </div>
  65. <table class="params">
  66. <tbody>
  67. <tr>
  68. <td class="name"><code>frame</code></td>
  69. <td class="description last"><p>A reference to the current node frame.</p></td>
  70. </tr>
  71. </tbody>
  72. </table>
  73. <dl class="details">
  74. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="AnalyticLightNode.html#update">AnalyticLightNode#update</a></dt>
  75. </dl>
  76. </div>
  77. <h2 class="subsection-title">Static Methods</h2>
  78. <h3 class="name name-method" id=".setLTC" translate="no">.<a href="#.setLTC">setLTC</a><span class="signature">( ltc : <span class="param-type">RectAreaLightTexturesLib</span> )</span> </h3>
  79. <div class="method">
  80. <div class="description">
  81. <p>Used to configure the internal BRDF approximation texture data.</p>
  82. </div>
  83. <table class="params">
  84. <tbody>
  85. <tr>
  86. <td class="name"><code>ltc</code></td>
  87. <td class="description last"><p>The BRDF approximation texture data.</p></td>
  88. </tr>
  89. </tbody>
  90. </table>
  91. </div>
  92. <h2 class="subsection-title">Source</h2>
  93. <p>
  94. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/RectAreaLightNode.js" target="_blank" rel="noopener" translate="no">src/nodes/lighting/RectAreaLightNode.js</a>
  95. </p>
  96. </article>
  97. </section>
  98. <script src="../scripts/linenumber.js"></script>
  99. <script src="../scripts/page.js"></script>
  100. </body>
  101. </html>
粤ICP备19079148号