LightingModel.html 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LightingModel - 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. <h1 translate="no">LightingModel</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>Abstract class for implementing lighting models. The module defines
  16. multiple methods that concrete lighting models can implement. These
  17. methods are executed at different points during the light evaluation
  18. process.</p></div>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <h2>Constructor</h2>
  23. <h3 class="name name-method" id="LightingModel" translate="no">new <a href="#LightingModel">LightingModel</a><span class="signature">()</span> </h3>
  24. <div class="method">
  25. </div>
  26. </div>
  27. <h2 class="subsection-title">Methods</h2>
  28. <h3 class="name name-method" id="ambientOcclusion" translate="no">.<a href="#ambientOcclusion">ambientOcclusion</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  29. <div class="method">
  30. <div class="description">
  31. <p>This method is intended for implementing the ambient occlusion term.
  32. Unlike other methods, this method must be called manually by the lighting
  33. model in its indirect term.</p>
  34. </div>
  35. <table class="params">
  36. <tbody>
  37. <tr>
  38. <td class="name">
  39. <strong>builder</strong>
  40. </td>
  41. <td class="description last">
  42. <p>The current node builder.</p>
  43. </td>
  44. </tr>
  45. </tbody>
  46. </table>
  47. </div>
  48. <h3 class="name name-method" id="direct" translate="no">.<a href="#direct">direct</a><span class="signature">( lightData : <span class="param-type">Object</span>, builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  49. <div class="method">
  50. <div class="description">
  51. <p>This method is intended for implementing the direct light term and
  52. executed during the build process of directional, point and spot light nodes.</p>
  53. </div>
  54. <table class="params">
  55. <tbody>
  56. <tr>
  57. <td class="name">
  58. <strong>lightData</strong>
  59. </td>
  60. <td class="description last">
  61. <p>The light data.</p>
  62. </td>
  63. </tr>
  64. <tr>
  65. <td class="name">
  66. <strong>builder</strong>
  67. </td>
  68. <td class="description last">
  69. <p>The current node builder.</p>
  70. </td>
  71. </tr>
  72. </tbody>
  73. </table>
  74. </div>
  75. <h3 class="name name-method" id="directRectArea" translate="no">.<a href="#directRectArea">directRectArea</a><span class="signature">( lightData : <span class="param-type">Object</span>, builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  76. <div class="method">
  77. <div class="description">
  78. <p>This method is intended for implementing the direct light term for
  79. rect area light nodes.</p>
  80. </div>
  81. <table class="params">
  82. <tbody>
  83. <tr>
  84. <td class="name">
  85. <strong>lightData</strong>
  86. </td>
  87. <td class="description last">
  88. <p>The light data.</p>
  89. </td>
  90. </tr>
  91. <tr>
  92. <td class="name">
  93. <strong>builder</strong>
  94. </td>
  95. <td class="description last">
  96. <p>The current node builder.</p>
  97. </td>
  98. </tr>
  99. </tbody>
  100. </table>
  101. </div>
  102. <h3 class="name name-method" id="finish" translate="no">.<a href="#finish">finish</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  103. <div class="method">
  104. <div class="description">
  105. <p>This method is intended for executing final tasks like final updates
  106. to the outgoing light.</p>
  107. </div>
  108. <table class="params">
  109. <tbody>
  110. <tr>
  111. <td class="name">
  112. <strong>builder</strong>
  113. </td>
  114. <td class="description last">
  115. <p>The current node builder.</p>
  116. </td>
  117. </tr>
  118. </tbody>
  119. </table>
  120. </div>
  121. <h3 class="name name-method" id="indirect" translate="no">.<a href="#indirect">indirect</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  122. <div class="method">
  123. <div class="description">
  124. <p>This method is intended for implementing the indirect light term.</p>
  125. </div>
  126. <table class="params">
  127. <tbody>
  128. <tr>
  129. <td class="name">
  130. <strong>builder</strong>
  131. </td>
  132. <td class="description last">
  133. <p>The current node builder.</p>
  134. </td>
  135. </tr>
  136. </tbody>
  137. </table>
  138. </div>
  139. <h3 class="name name-method" id="start" translate="no">.<a href="#start">start</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> <span class="type-signature">(abstract) </span></h3>
  140. <div class="method">
  141. <div class="description">
  142. <p>This method is intended for setting up lighting model and context data
  143. which are later used in the evaluation process.</p>
  144. </div>
  145. <table class="params">
  146. <tbody>
  147. <tr>
  148. <td class="name">
  149. <strong>builder</strong>
  150. </td>
  151. <td class="description last">
  152. <p>The current node builder.</p>
  153. </td>
  154. </tr>
  155. </tbody>
  156. </table>
  157. </div>
  158. <h2 class="subsection-title">Source</h2>
  159. <p>
  160. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/core/LightingModel.js" translate="no" target="_blank" rel="noopener">src/nodes/core/LightingModel.js</a>
  161. </p>
  162. </article>
  163. </section>
  164. <script src="../scripts/linenumber.js"></script>
  165. <script src="../scripts/page.js"></script>
  166. </body>
  167. </html>
粤ICP备19079148号