PhysicalLightingModel.html 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368
  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">
  30. <strong>clearcoat</strong>
  31. </td>
  32. <td class="description last">
  33. <p>Whether clearcoat is supported or not.</p>
  34. <p>Default is <code>false</code>.</p>
  35. </td>
  36. </tr>
  37. <tr>
  38. <td class="name">
  39. <strong>sheen</strong>
  40. </td>
  41. <td class="description last">
  42. <p>Whether sheen is supported or not.</p>
  43. <p>Default is <code>false</code>.</p>
  44. </td>
  45. </tr>
  46. <tr>
  47. <td class="name">
  48. <strong>iridescence</strong>
  49. </td>
  50. <td class="description last">
  51. <p>Whether iridescence is supported or not.</p>
  52. <p>Default is <code>false</code>.</p>
  53. </td>
  54. </tr>
  55. <tr>
  56. <td class="name">
  57. <strong>anisotropy</strong>
  58. </td>
  59. <td class="description last">
  60. <p>Whether anisotropy is supported or not.</p>
  61. <p>Default is <code>false</code>.</p>
  62. </td>
  63. </tr>
  64. <tr>
  65. <td class="name">
  66. <strong>transmission</strong>
  67. </td>
  68. <td class="description last">
  69. <p>Whether transmission is supported or not.</p>
  70. <p>Default is <code>false</code>.</p>
  71. </td>
  72. </tr>
  73. <tr>
  74. <td class="name">
  75. <strong>dispersion</strong>
  76. </td>
  77. <td class="description last">
  78. <p>Whether dispersion is supported or not.</p>
  79. <p>Default is <code>false</code>.</p>
  80. </td>
  81. </tr>
  82. </tbody>
  83. </table>
  84. </div>
  85. </div>
  86. <h2 class="subsection-title">Properties</h2>
  87. <div class="member">
  88. <h3 class="name" id="anisotropy" translate="no">.<a href="#anisotropy">anisotropy</a><span class="type-signature"> : boolean</span> </h3>
  89. <div class="description">
  90. <p>Whether anisotropy is supported or not.</p>
  91. <p>Default is <code>false</code>.</p>
  92. </div>
  93. </div>
  94. <div class="member">
  95. <h3 class="name" id="clearcoat" translate="no">.<a href="#clearcoat">clearcoat</a><span class="type-signature"> : boolean</span> </h3>
  96. <div class="description">
  97. <p>Whether clearcoat is supported or not.</p>
  98. <p>Default is <code>false</code>.</p>
  99. </div>
  100. </div>
  101. <div class="member">
  102. <h3 class="name" id="clearcoatRadiance" translate="no">.<a href="#clearcoatRadiance">clearcoatRadiance</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  103. <div class="description">
  104. <p>The clear coat radiance.</p>
  105. <p>Default is <code>null</code>.</p>
  106. </div>
  107. </div>
  108. <div class="member">
  109. <h3 class="name" id="clearcoatSpecularDirect" translate="no">.<a href="#clearcoatSpecularDirect">clearcoatSpecularDirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  110. <div class="description">
  111. <p>The clear coat specular direct.</p>
  112. <p>Default is <code>null</code>.</p>
  113. </div>
  114. </div>
  115. <div class="member">
  116. <h3 class="name" id="clearcoatSpecularIndirect" translate="no">.<a href="#clearcoatSpecularIndirect">clearcoatSpecularIndirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  117. <div class="description">
  118. <p>The clear coat specular indirect.</p>
  119. <p>Default is <code>null</code>.</p>
  120. </div>
  121. </div>
  122. <div class="member">
  123. <h3 class="name" id="dispersion" translate="no">.<a href="#dispersion">dispersion</a><span class="type-signature"> : boolean</span> </h3>
  124. <div class="description">
  125. <p>Whether dispersion is supported or not.</p>
  126. <p>Default is <code>false</code>.</p>
  127. </div>
  128. </div>
  129. <div class="member">
  130. <h3 class="name" id="iridescence" translate="no">.<a href="#iridescence">iridescence</a><span class="type-signature"> : boolean</span> </h3>
  131. <div class="description">
  132. <p>Whether iridescence is supported or not.</p>
  133. <p>Default is <code>false</code>.</p>
  134. </div>
  135. </div>
  136. <div class="member">
  137. <h3 class="name" id="iridescenceF0" translate="no">.<a href="#iridescenceF0">iridescenceF0</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  138. <div class="description">
  139. <p>The iridescence F0.</p>
  140. <p>Default is <code>null</code>.</p>
  141. </div>
  142. </div>
  143. <div class="member">
  144. <h3 class="name" id="iridescenceFresnel" translate="no">.<a href="#iridescenceFresnel">iridescenceFresnel</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  145. <div class="description">
  146. <p>The iridescence Fresnel.</p>
  147. <p>Default is <code>null</code>.</p>
  148. </div>
  149. </div>
  150. <div class="member">
  151. <h3 class="name" id="sheen" translate="no">.<a href="#sheen">sheen</a><span class="type-signature"> : boolean</span> </h3>
  152. <div class="description">
  153. <p>Whether sheen is supported or not.</p>
  154. <p>Default is <code>false</code>.</p>
  155. </div>
  156. </div>
  157. <div class="member">
  158. <h3 class="name" id="sheenSpecularDirect" translate="no">.<a href="#sheenSpecularDirect">sheenSpecularDirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  159. <div class="description">
  160. <p>The sheen specular direct.</p>
  161. <p>Default is <code>null</code>.</p>
  162. </div>
  163. </div>
  164. <div class="member">
  165. <h3 class="name" id="sheenSpecularIndirect" translate="no">.<a href="#sheenSpecularIndirect">sheenSpecularIndirect</a><span class="type-signature"> : <a href="Node.html">Node</a></span> </h3>
  166. <div class="description">
  167. <p>The sheen specular indirect.</p>
  168. <p>Default is <code>null</code>.</p>
  169. </div>
  170. </div>
  171. <div class="member">
  172. <h3 class="name" id="transmission" translate="no">.<a href="#transmission">transmission</a><span class="type-signature"> : boolean</span> </h3>
  173. <div class="description">
  174. <p>Whether transmission is supported or not.</p>
  175. <p>Default is <code>false</code>.</p>
  176. </div>
  177. </div>
  178. <h2 class="subsection-title">Methods</h2>
  179. <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> </h3>
  180. <div class="method">
  181. <div class="description">
  182. <p>Implements the ambient occlusion term.</p>
  183. </div>
  184. <table class="params">
  185. <tbody>
  186. <tr>
  187. <td class="name">
  188. <strong>builder</strong>
  189. </td>
  190. <td class="description last">
  191. <p>The current node builder.</p>
  192. </td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <dl class="details">
  197. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#ambientOcclusion">LightingModel#ambientOcclusion</a></dt>
  198. </dl>
  199. </div>
  200. <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> </h3>
  201. <div class="method">
  202. <div class="description">
  203. <p>Implements the direct light.</p>
  204. </div>
  205. <table class="params">
  206. <tbody>
  207. <tr>
  208. <td class="name">
  209. <strong>lightData</strong>
  210. </td>
  211. <td class="description last">
  212. <p>The light data.</p>
  213. </td>
  214. </tr>
  215. <tr>
  216. <td class="name">
  217. <strong>builder</strong>
  218. </td>
  219. <td class="description last">
  220. <p>The current node builder.</p>
  221. </td>
  222. </tr>
  223. </tbody>
  224. </table>
  225. <dl class="details">
  226. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#direct">LightingModel#direct</a></dt>
  227. </dl>
  228. </div>
  229. <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"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
  230. <div class="method">
  231. <div class="description">
  232. <p>This method is intended for implementing the direct light term for
  233. rect area light nodes.</p>
  234. </div>
  235. <table class="params">
  236. <tbody>
  237. <tr>
  238. <td class="name">
  239. <strong>input</strong>
  240. </td>
  241. <td class="description last">
  242. <p>The input data.</p>
  243. </td>
  244. </tr>
  245. <tr>
  246. <td class="name">
  247. <strong>builder</strong>
  248. </td>
  249. <td class="description last">
  250. <p>The current node builder.</p>
  251. </td>
  252. </tr>
  253. </tbody>
  254. </table>
  255. <dl class="details">
  256. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#directRectArea">LightingModel#directRectArea</a></dt>
  257. </dl>
  258. </div>
  259. <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> </h3>
  260. <div class="method">
  261. <div class="description">
  262. <p>Used for final lighting accumulations depending on the requested features.</p>
  263. </div>
  264. <table class="params">
  265. <tbody>
  266. <tr>
  267. <td class="name">
  268. <strong>builder</strong>
  269. </td>
  270. <td class="description last">
  271. <p>The current node builder.</p>
  272. </td>
  273. </tr>
  274. </tbody>
  275. </table>
  276. <dl class="details">
  277. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#finish">LightingModel#finish</a></dt>
  278. </dl>
  279. </div>
  280. <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> </h3>
  281. <div class="method">
  282. <div class="description">
  283. <p>Implements the indirect lighting.</p>
  284. </div>
  285. <table class="params">
  286. <tbody>
  287. <tr>
  288. <td class="name">
  289. <strong>builder</strong>
  290. </td>
  291. <td class="description last">
  292. <p>The current node builder.</p>
  293. </td>
  294. </tr>
  295. </tbody>
  296. </table>
  297. <dl class="details">
  298. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#indirect">LightingModel#indirect</a></dt>
  299. </dl>
  300. </div>
  301. <h3 class="name name-method" id="indirectDiffuse" translate="no">.<a href="#indirectDiffuse">indirectDiffuse</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
  302. <div class="method">
  303. <div class="description">
  304. <p>Implements the indirect diffuse term.</p>
  305. </div>
  306. <table class="params">
  307. <tbody>
  308. <tr>
  309. <td class="name">
  310. <strong>builder</strong>
  311. </td>
  312. <td class="description last">
  313. <p>The current node builder.</p>
  314. </td>
  315. </tr>
  316. </tbody>
  317. </table>
  318. </div>
  319. <h3 class="name name-method" id="indirectSpecular" translate="no">.<a href="#indirectSpecular">indirectSpecular</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
  320. <div class="method">
  321. <div class="description">
  322. <p>Implements the indirect specular term.</p>
  323. </div>
  324. <table class="params">
  325. <tbody>
  326. <tr>
  327. <td class="name">
  328. <strong>builder</strong>
  329. </td>
  330. <td class="description last">
  331. <p>The current node builder.</p>
  332. </td>
  333. </tr>
  334. </tbody>
  335. </table>
  336. </div>
  337. <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> </h3>
  338. <div class="method">
  339. <div class="description">
  340. <p>Depending on what features are requested, the method prepares certain node variables
  341. which are later used for lighting computations.</p>
  342. </div>
  343. <table class="params">
  344. <tbody>
  345. <tr>
  346. <td class="name">
  347. <strong>builder</strong>
  348. </td>
  349. <td class="description last">
  350. <p>The current node builder.</p>
  351. </td>
  352. </tr>
  353. </tbody>
  354. </table>
  355. <dl class="details">
  356. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="LightingModel.html#start">LightingModel#start</a></dt>
  357. </dl>
  358. </div>
  359. <h2 class="subsection-title">Source</h2>
  360. <p>
  361. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/functions/PhysicalLightingModel.js" translate="no" target="_blank" rel="noopener">src/nodes/functions/PhysicalLightingModel.js</a>
  362. </p>
  363. </article>
  364. </section>
  365. <script src="../scripts/linenumber.js"></script>
  366. <script src="../scripts/page.js"></script>
  367. </body>
  368. </html>
粤ICP备19079148号