LightingContextNode.html 5.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>LightingContextNode - 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="ContextNode.html">ContextNode</a> → </p>
  13. <h1 translate="no">LightingContextNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p><code>LightingContextNode</code> represents an extension of the <a href="ContextNode.html">ContextNode</a> module
  17. by adding lighting specific context data. It represents the runtime context of
  18. <a href="LightsNode.html">LightsNode</a>.</p></div>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <h2>Constructor</h2>
  23. <h3 class="name name-method" id="LightingContextNode" translate="no">new <a href="#LightingContextNode">LightingContextNode</a><span class="signature">( lightsNode : <span class="param-type"><a href="LightsNode.html">LightsNode</a></span>, lightingModel : <span class="param-type"><a href="LightingModel.html">LightingModel</a></span>, materialLightings : <span class="param-type">Array.&lt;<a href="LightingNode.html">LightingNode</a>></span>, backdropNode : <span class="param-type"><a href="Node.html">Node</a>.&lt;vec3></span>, backdropAlphaNode : <span class="param-type"><a href="Node.html">Node</a>.&lt;float></span> )</span> </h3>
  24. <div class="method">
  25. <div class="description">
  26. <p>Constructs a new lighting context node.</p>
  27. </div>
  28. <table class="params">
  29. <tbody>
  30. <tr>
  31. <td class="name">
  32. <strong translate="no">lightsNode</strong>
  33. </td>
  34. <td class="description last">
  35. <p>The lights node.</p>
  36. </td>
  37. </tr>
  38. <tr>
  39. <td class="name">
  40. <strong translate="no">lightingModel</strong>
  41. </td>
  42. <td class="description last">
  43. <p>The current lighting model.</p>
  44. <p>Default is <code>null</code>.</p>
  45. </td>
  46. </tr>
  47. <tr>
  48. <td class="name">
  49. <strong translate="no">materialLightings</strong>
  50. </td>
  51. <td class="description last">
  52. <p>The material lightings nodes.</p>
  53. </td>
  54. </tr>
  55. <tr>
  56. <td class="name">
  57. <strong translate="no">backdropNode</strong>
  58. </td>
  59. <td class="description last">
  60. <p>A backdrop node.</p>
  61. <p>Default is <code>null</code>.</p>
  62. </td>
  63. </tr>
  64. <tr>
  65. <td class="name">
  66. <strong translate="no">backdropAlphaNode</strong>
  67. </td>
  68. <td class="description last">
  69. <p>A backdrop alpha node.</p>
  70. <p>Default is <code>null</code>.</p>
  71. </td>
  72. </tr>
  73. </tbody>
  74. </table>
  75. </div>
  76. </div>
  77. <h2 class="subsection-title">Properties</h2>
  78. <div class="member">
  79. <h3 class="name" id="backdropAlphaNode" translate="no">.<a href="#backdropAlphaNode">backdropAlphaNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;float></span> </h3>
  80. <div class="description">
  81. <p>A backdrop alpha node.</p>
  82. <p>Default is <code>null</code>.</p>
  83. </div>
  84. </div>
  85. <div class="member">
  86. <h3 class="name" id="backdropNode" translate="no">.<a href="#backdropNode">backdropNode</a><span class="type-signature"> : <a href="Node.html">Node</a>.&lt;vec3></span> </h3>
  87. <div class="description">
  88. <p>A backdrop node.</p>
  89. <p>Default is <code>null</code>.</p>
  90. </div>
  91. </div>
  92. <div class="member">
  93. <h3 class="name" id="lightingModel" translate="no">.<a href="#lightingModel">lightingModel</a><span class="type-signature"> : <a href="LightingModel.html">LightingModel</a></span> </h3>
  94. <div class="description">
  95. <p>The current lighting model.</p>
  96. <p>Default is <code>null</code>.</p>
  97. </div>
  98. </div>
  99. <div class="member">
  100. <h3 class="name" id="materialLightings" translate="no">.<a href="#materialLightings">materialLightings</a><span class="type-signature"> : Array.&lt;<a href="LightingNode.html">LightingNode</a>></span> </h3>
  101. </div>
  102. <h2 class="subsection-title">Methods</h2>
  103. <h3 class="name name-method" id="getContext" translate="no">.<a href="#getContext">getContext</a><span class="signature">()</span><span class="type-signature"> : Object</span> </h3>
  104. <div class="method">
  105. <div class="description">
  106. <p>Returns a lighting context object.</p>
  107. </div>
  108. <dl class="details">
  109. <dt class="tag-returns"><strong>Returns:</strong> The lighting context object.</dt>
  110. </dl>
  111. </div>
  112. <h2 class="subsection-title">Source</h2>
  113. <p>
  114. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/lighting/LightingContextNode.js" translate="no" target="_blank" rel="noopener">src/nodes/lighting/LightingContextNode.js</a>
  115. </p>
  116. </article>
  117. </section>
  118. <script src="../scripts/linenumber.js"></script>
  119. <script src="../scripts/page.js"></script>
  120. </body>
  121. </html>
粤ICP备19079148号