PhysicalLightingModel.html 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>PhysicalLightingModel - 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="LightingModel.html">LightingModel</a> → </p>
  13. <h1 translate="no">PhysicalLightingModel</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>Represents the lighting model for a PBR material.</p></div>
  17. </header>
  18. <article>
  19. <div class="container-overview">
  20. <h2>Constructor</h2>
  21. <h3 class="name name-method" id="PhysicalLightingModel" translate="no">new <a href="#PhysicalLightingModel">PhysicalLightingModel</a><span class="signature">( clearcoat : <span class="param-type">boolean</span>, sheen : <span class="param-type">boolean</span>, iridescence : <span class="param-type">boolean</span>, anisotropy : <span class="param-type">boolean</span>, transmission : <span class="param-type">boolean</span>, dispersion : <span class="param-type">boolean</span> )</span> </h3>
  22. <div class="method">
  23. <div class="description">
  24. <p>Constructs a new physical lighting model.</p>
  25. </div>
  26. <table class="params">
  27. <tbody>
  28. <tr>
  29. <td class="name"><code>clearcoat</code></td>
  30. <td class="description last"><p>Whether clearcoat is supported or not.<br/>Default is <code>false</code>.</p></td>
  31. </tr>
  32. <tr>
  33. <td class="name"><code>sheen</code></td>
  34. <td class="description last"><p>Whether sheen is supported or not.<br/>Default is <code>false</code>.</p></td>
  35. </tr>
  36. <tr>
  37. <td class="name"><code>iridescence</code></td>
  38. <td class="description last"><p>Whether iridescence is supported or not.<br/>Default is <code>false</code>.</p></td>
  39. </tr>
  40. <tr>
  41. <td class="name"><code>anisotropy</code></td>
  42. <td class="description last"><p>Whether anisotropy is supported or not.<br/>Default is <code>false</code>.</p></td>
  43. </tr>
  44. <tr>
  45. <td class="name"><code>transmission</code></td>
  46. <td class="description last"><p>Whether transmission is supported or not.<br/>Default is <code>false</code>.</p></td>
  47. </tr>
  48. <tr>
  49. <td class="name"><code>dispersion</code></td>
  50. <td class="description last"><p>Whether dispersion is supported or not.<br/>Default is <code>false</code>.</p></td>
  51. </tr>
  52. </tbody>
  53. </table>
  54. </div>
  55. </div>
  56. <h2 class="subsection-title">Properties</h2>
  57. <div class="member">
  58. <h3 class="name" id="anisotropy" translate="no">.<a href="#anisotropy">anisotropy</a><span class="type-signature"> : boolean</span> </h3>
  59. <div class="description">
  60. <p>Whether anisotropy is supported or not.<br/>Default is <code>false</code>.</p>
  61. </div>
  62. </div>
  63. <div class="member">
  64. <h3 class="name" id="clearcoat" translate="no">.<a href="#clearcoat">clearcoat</a><span class="type-signature"> : boolean</span> </h3>
  65. <div class="description">
  66. <p>Whether clearcoat is supported or not.<br/>Default is <code>false</code>.</p>
  67. </div>
  68. </div>
  69. <div class="member">
  70. <h3 class="name" id="clearcoatRadiance" translate="no">.<a href="#clearcoatRadiance">clearcoatRadiance</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  71. <div class="description">
  72. <p>The clear coat radiance.<br/>Default is <code>null</code>.</p>
  73. </div>
  74. </div>
  75. <div class="member">
  76. <h3 class="name" id="clearcoatSpecularDirect" translate="no">.<a href="#clearcoatSpecularDirect">clearcoatSpecularDirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  77. <div class="description">
  78. <p>The clear coat specular direct.<br/>Default is <code>null</code>.</p>
  79. </div>
  80. </div>
  81. <div class="member">
  82. <h3 class="name" id="clearcoatSpecularIndirect" translate="no">.<a href="#clearcoatSpecularIndirect">clearcoatSpecularIndirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  83. <div class="description">
  84. <p>The clear coat specular indirect.<br/>Default is <code>null</code>.</p>
  85. </div>
  86. </div>
  87. <div class="member">
  88. <h3 class="name" id="dispersion" translate="no">.<a href="#dispersion">dispersion</a><span class="type-signature"> : boolean</span> </h3>
  89. <div class="description">
  90. <p>Whether dispersion is supported or not.<br/>Default is <code>false</code>.</p>
  91. </div>
  92. </div>
  93. <div class="member">
  94. <h3 class="name" id="iridescence" translate="no">.<a href="#iridescence">iridescence</a><span class="type-signature"> : boolean</span> </h3>
  95. <div class="description">
  96. <p>Whether iridescence is supported or not.<br/>Default is <code>false</code>.</p>
  97. </div>
  98. </div>
  99. <div class="member">
  100. <h3 class="name" id="iridescenceF0" translate="no">.<a href="#iridescenceF0">iridescenceF0</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  101. <div class="description">
  102. <p>The iridescence F0.<br/>Default is <code>null</code>.</p>
  103. </div>
  104. </div>
  105. <div class="member">
  106. <h3 class="name" id="iridescenceFresnel" translate="no">.<a href="#iridescenceFresnel">iridescenceFresnel</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  107. <div class="description">
  108. <p>The iridescence Fresnel.<br/>Default is <code>null</code>.</p>
  109. </div>
  110. </div>
  111. <div class="member">
  112. <h3 class="name" id="sheen" translate="no">.<a href="#sheen">sheen</a><span class="type-signature"> : boolean</span> </h3>
  113. <div class="description">
  114. <p>Whether sheen is supported or not.<br/>Default is <code>false</code>.</p>
  115. </div>
  116. </div>
  117. <div class="member">
  118. <h3 class="name" id="sheenSpecularDirect" translate="no">.<a href="#sheenSpecularDirect">sheenSpecularDirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  119. <div class="description">
  120. <p>The sheen specular direct.<br/>Default is <code>null</code>.</p>
  121. </div>
  122. </div>
  123. <div class="member">
  124. <h3 class="name" id="sheenSpecularIndirect" translate="no">.<a href="#sheenSpecularIndirect">sheenSpecularIndirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  125. <div class="description">
  126. <p>The sheen specular indirect.<br/>Default is <code>null</code>.</p>
  127. </div>
  128. </div>
  129. <div class="member">
  130. <h3 class="name" id="transmission" translate="no">.<a href="#transmission">transmission</a><span class="type-signature"> : boolean</span> </h3>
  131. <div class="description">
  132. <p>Whether transmission is supported or not.<br/>Default is <code>false</code>.</p>
  133. </div>
  134. </div>
  135. <h2 class="subsection-title">Methods</h2>
  136. <h3 class="name name-method" id="ambientOcclusion" translate="no">.<a href="#ambientOcclusion">ambientOcclusion</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  137. <div class="method">
  138. <div class="description">
  139. <p>Implements the ambient occlusion term.</p>
  140. </div>
  141. <table class="params">
  142. <tbody>
  143. <tr>
  144. <td class="name"><code>builder</code></td>
  145. <td class="description last"><p>The current node builder.</p></td>
  146. </tr>
  147. </tbody>
  148. </table>
  149. <dl class="details">
  150. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#ambientOcclusion">LightingModel#ambientOcclusion</a></dt>
  151. </dl>
  152. </div>
  153. <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">NodeBuilder</span> )</span> </h3>
  154. <div class="method">
  155. <div class="description">
  156. <p>Implements the direct light.</p>
  157. </div>
  158. <table class="params">
  159. <tbody>
  160. <tr>
  161. <td class="name"><code>lightData</code></td>
  162. <td class="description last"><p>The light data.</p></td>
  163. </tr>
  164. <tr>
  165. <td class="name"><code>builder</code></td>
  166. <td class="description last"><p>The current node builder.</p></td>
  167. </tr>
  168. </tbody>
  169. </table>
  170. <dl class="details">
  171. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#direct">LightingModel#direct</a></dt>
  172. </dl>
  173. </div>
  174. <h3 class="name name-method" id="directRectArea" translate="no">.<a href="#directRectArea">directRectArea</a><span class="signature">( input : <span class="param-type">Object</span>, builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  175. <div class="method">
  176. <div class="description">
  177. <p>This method is intended for implementing the direct light term for
  178. rect area light nodes.</p>
  179. </div>
  180. <table class="params">
  181. <tbody>
  182. <tr>
  183. <td class="name"><code>input</code></td>
  184. <td class="description last"><p>The input data.</p></td>
  185. </tr>
  186. <tr>
  187. <td class="name"><code>builder</code></td>
  188. <td class="description last"><p>The current node builder.</p></td>
  189. </tr>
  190. </tbody>
  191. </table>
  192. <dl class="details">
  193. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#directRectArea">LightingModel#directRectArea</a></dt>
  194. </dl>
  195. </div>
  196. <h3 class="name name-method" id="finish" translate="no">.<a href="#finish">finish</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  197. <div class="method">
  198. <div class="description">
  199. <p>Used for final lighting accumulations depending on the requested features.</p>
  200. </div>
  201. <table class="params">
  202. <tbody>
  203. <tr>
  204. <td class="name"><code>builder</code></td>
  205. <td class="description last"><p>The current node builder.</p></td>
  206. </tr>
  207. </tbody>
  208. </table>
  209. <dl class="details">
  210. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#finish">LightingModel#finish</a></dt>
  211. </dl>
  212. </div>
  213. <h3 class="name name-method" id="indirect" translate="no">.<a href="#indirect">indirect</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  214. <div class="method">
  215. <div class="description">
  216. <p>Implements the indirect lighting.</p>
  217. </div>
  218. <table class="params">
  219. <tbody>
  220. <tr>
  221. <td class="name"><code>builder</code></td>
  222. <td class="description last"><p>The current node builder.</p></td>
  223. </tr>
  224. </tbody>
  225. </table>
  226. <dl class="details">
  227. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#indirect">LightingModel#indirect</a></dt>
  228. </dl>
  229. </div>
  230. <h3 class="name name-method" id="indirectDiffuse" translate="no">.<a href="#indirectDiffuse">indirectDiffuse</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  231. <div class="method">
  232. <div class="description">
  233. <p>Implements the indirect diffuse term.</p>
  234. </div>
  235. <table class="params">
  236. <tbody>
  237. <tr>
  238. <td class="name"><code>builder</code></td>
  239. <td class="description last"><p>The current node builder.</p></td>
  240. </tr>
  241. </tbody>
  242. </table>
  243. </div>
  244. <h3 class="name name-method" id="indirectSpecular" translate="no">.<a href="#indirectSpecular">indirectSpecular</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  245. <div class="method">
  246. <div class="description">
  247. <p>Implements the indirect specular term.</p>
  248. </div>
  249. <table class="params">
  250. <tbody>
  251. <tr>
  252. <td class="name"><code>builder</code></td>
  253. <td class="description last"><p>The current node builder.</p></td>
  254. </tr>
  255. </tbody>
  256. </table>
  257. </div>
  258. <h3 class="name name-method" id="start" translate="no">.<a href="#start">start</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  259. <div class="method">
  260. <div class="description">
  261. <p>Depending on what features are requested, the method prepares certain node variables
  262. which are later used for lighting computations.</p>
  263. </div>
  264. <table class="params">
  265. <tbody>
  266. <tr>
  267. <td class="name"><code>builder</code></td>
  268. <td class="description last"><p>The current node builder.</p></td>
  269. </tr>
  270. </tbody>
  271. </table>
  272. <dl class="details">
  273. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#start">LightingModel#start</a></dt>
  274. </dl>
  275. </div>
  276. <h2 class="subsection-title">Source</h2>
  277. <p>
  278. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/functions/PhysicalLightingModel.js" target="_blank" rel="noopener" translate="no">src/nodes/functions/PhysicalLightingModel.js</a>
  279. </p>
  280. </article>
  281. </section>
  282. <script src="../scripts/linenumber.js"></script>
  283. <script src="../scripts/page.js"></script>
  284. </body>
  285. </html>
粤ICP备19079148号