RectAreaLightNode.html 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115
  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"><a href="RectAreaLight.html">RectAreaLight</a></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">
  30. <strong>light</strong>
  31. </td>
  32. <td class="description last">
  33. <p>The rect area light source.</p>
  34. <p>Default is <code>null</code>.</p>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. </div>
  41. <h2 class="subsection-title">Properties</h2>
  42. <div class="member">
  43. <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>
  44. <div class="description">
  45. <p>Uniform node representing the half height of the are light.</p>
  46. </div>
  47. </div>
  48. <div class="member">
  49. <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>
  50. <div class="description">
  51. <p>Uniform node representing the half width of the are light.</p>
  52. </div>
  53. </div>
  54. <div class="member">
  55. <h3 class="name" id="updateType" translate="no">.<a href="#updateType">updateType</a><span class="type-signature"> : string</span> </h3>
  56. <div class="description">
  57. <p>The <code>updateType</code> is set to <code>NodeUpdateType.RENDER</code> since the light
  58. relies on <code>viewMatrix</code> which might vary per render call.</p>
  59. <p>Default is <code>'render'</code>.</p>
  60. </div>
  61. <dl class="details">
  62. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="AnalyticLightNode.html#updateType">AnalyticLightNode#updateType</a></dt>
  63. </dl>
  64. </div>
  65. <h2 class="subsection-title">Methods</h2>
  66. <h3 class="name name-method" id="update" translate="no">.<a href="#update">update</a><span class="signature">( frame : <span class="param-type"><a href="NodeFrame.html">NodeFrame</a></span> )</span> </h3>
  67. <div class="method">
  68. <div class="description">
  69. <p>Overwritten to updated rect area light specific uniforms.</p>
  70. </div>
  71. <table class="params">
  72. <tbody>
  73. <tr>
  74. <td class="name">
  75. <strong>frame</strong>
  76. </td>
  77. <td class="description last">
  78. <p>A reference to the current node frame.</p>
  79. </td>
  80. </tr>
  81. </tbody>
  82. </table>
  83. <dl class="details">
  84. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="AnalyticLightNode.html#update">AnalyticLightNode#update</a></dt>
  85. </dl>
  86. </div>
  87. <h2 class="subsection-title">Static Methods</h2>
  88. <h3 class="name name-method" id=".setLTC" translate="no">.<a href="#.setLTC">setLTC</a><span class="signature">( ltc : <span class="param-type"><a href="RectAreaLightTexturesLib.html">RectAreaLightTexturesLib</a></span> )</span> </h3>
  89. <div class="method">
  90. <div class="description">
  91. <p>Used to configure the internal BRDF approximation texture data.</p>
  92. </div>
  93. <table class="params">
  94. <tbody>
  95. <tr>
  96. <td class="name">
  97. <strong>ltc</strong>
  98. </td>
  99. <td class="description last">
  100. <p>The BRDF approximation texture data.</p>
  101. </td>
  102. </tr>
  103. </tbody>
  104. </table>
  105. </div>
  106. <h2 class="subsection-title">Source</h2>
  107. <p>
  108. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/RectAreaLightNode.js" translate="no" target="_blank" rel="noopener">src/nodes/lighting/RectAreaLightNode.js</a>
  109. </p>
  110. </article>
  111. </section>
  112. <script src="../scripts/linenumber.js"></script>
  113. <script src="../scripts/page.js"></script>
  114. </body>
  115. </html>
粤ICP备19079148号