NodeMaterialObserver.html 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>NodeMaterialObserver - 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">NodeMaterialObserver</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>This class is used by <a href="WebGPURenderer.html">WebGPURenderer</a> as management component.
  16. It's primary purpose is to determine whether render objects require a
  17. refresh right before they are going to be rendered or not.</p></div>
  18. </header>
  19. <article>
  20. <div class="container-overview">
  21. <h2>Constructor</h2>
  22. <h3 class="name name-method" id="NodeMaterialObserver" translate="no">new <a href="#NodeMaterialObserver">NodeMaterialObserver</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span> </h3>
  23. <div class="method">
  24. <div class="description">
  25. <p>Constructs a new node material observer.</p>
  26. </div>
  27. <table class="params">
  28. <tbody>
  29. <tr>
  30. <td class="name"><code>builder</code></td>
  31. <td class="description last"><p>The node builder.</p></td>
  32. </tr>
  33. </tbody>
  34. </table>
  35. </div>
  36. </div>
  37. <h2 class="subsection-title">Properties</h2>
  38. <div class="member">
  39. <h3 class="name" id="hasAnimation" translate="no">.<a href="#hasAnimation">hasAnimation</a><span class="type-signature"> : boolean</span> </h3>
  40. <div class="description">
  41. <p>Whether the node builder's 3D object is animated or not.</p>
  42. </div>
  43. </div>
  44. <div class="member">
  45. <h3 class="name" id="hasNode" translate="no">.<a href="#hasNode">hasNode</a><span class="type-signature"> : boolean</span> </h3>
  46. <div class="description">
  47. <p>Whether the material uses node objects or not.</p>
  48. </div>
  49. </div>
  50. <div class="member">
  51. <h3 class="name" id="refreshUniforms" translate="no">.<a href="#refreshUniforms">refreshUniforms</a><span class="type-signature"> : Array.&lt;string></span> </h3>
  52. <div class="description">
  53. <p>A list of all possible material uniforms</p>
  54. </div>
  55. </div>
  56. <div class="member">
  57. <h3 class="name" id="renderId" translate="no">.<a href="#renderId">renderId</a><span class="type-signature"> : number</span> </h3>
  58. <div class="description">
  59. <p>Holds the current render ID from the node frame.<br/>Default is <code>0</code>.</p>
  60. </div>
  61. </div>
  62. <div class="member">
  63. <h3 class="name" id="renderObjects" translate="no">.<a href="#renderObjects">renderObjects</a><span class="type-signature"> : WeakMap.&lt;<a href="RenderObject.html">RenderObject</a>, Object></span> </h3>
  64. <div class="description">
  65. <p>A node material can be used by more than one render object so the
  66. monitor must maintain a list of render objects.</p>
  67. </div>
  68. </div>
  69. <h2 class="subsection-title">Methods</h2>
  70. <h3 class="name name-method" id="containsNode" translate="no">.<a href="#containsNode">containsNode</a><span class="signature">( builder : <span class="param-type">NodeBuilder</span> )</span><span class="type-signature"> : boolean</span> </h3>
  71. <div class="method">
  72. <div class="description">
  73. <p>Returns <code>true</code> if the node builder's material uses
  74. node properties.</p>
  75. </div>
  76. <table class="params">
  77. <tbody>
  78. <tr>
  79. <td class="name"><code>builder</code></td>
  80. <td class="description last"><p>The current node builder.</p></td>
  81. </tr>
  82. </tbody>
  83. </table>
  84. <dl class="details">
  85. <dt class="tag-returns"><strong>Returns:</strong> Whether the node builder's material uses node properties or not.</dt>
  86. </dl>
  87. </div>
  88. <h3 class="name name-method" id="equals" translate="no">.<a href="#equals">equals</a><span class="signature">( renderObject : <span class="param-type">RenderObject</span>, lightsData : <span class="param-type">Array.&lt;Light></span> )</span><span class="type-signature"> : boolean</span> </h3>
  89. <div class="method">
  90. <div class="description">
  91. <p>Returns <code>true</code> if the given render object has not changed its state.</p>
  92. </div>
  93. <table class="params">
  94. <tbody>
  95. <tr>
  96. <td class="name"><code>renderObject</code></td>
  97. <td class="description last"><p>The render object.</p></td>
  98. </tr>
  99. <tr>
  100. <td class="name"><code>lightsData</code></td>
  101. <td class="description last"><p>The current material lights.</p></td>
  102. </tr>
  103. </tbody>
  104. </table>
  105. <dl class="details">
  106. <dt class="tag-returns"><strong>Returns:</strong> Whether the given render object has changed its state or not.</dt>
  107. </dl>
  108. </div>
  109. <h3 class="name name-method" id="firstInitialization" translate="no">.<a href="#firstInitialization">firstInitialization</a><span class="signature">( renderObject : <span class="param-type">RenderObject</span> )</span><span class="type-signature"> : boolean</span> </h3>
  110. <div class="method">
  111. <div class="description">
  112. <p>Returns <code>true</code> if the given render object is verified for the first time of this observer.</p>
  113. </div>
  114. <table class="params">
  115. <tbody>
  116. <tr>
  117. <td class="name"><code>renderObject</code></td>
  118. <td class="description last"><p>The render object.</p></td>
  119. </tr>
  120. </tbody>
  121. </table>
  122. <dl class="details">
  123. <dt class="tag-returns"><strong>Returns:</strong> Whether the given render object is verified for the first time of this observer.</dt>
  124. </dl>
  125. </div>
  126. <h3 class="name name-method" id="getAttributesData" translate="no">.<a href="#getAttributesData">getAttributesData</a><span class="signature">( attributes : <span class="param-type">Object</span> )</span><span class="type-signature"> : Object</span> </h3>
  127. <div class="method">
  128. <div class="description">
  129. <p>Returns an attribute data structure holding the attributes versions for
  130. monitoring.</p>
  131. </div>
  132. <table class="params">
  133. <tbody>
  134. <tr>
  135. <td class="name"><code>attributes</code></td>
  136. <td class="description last"><p>The geometry attributes.</p></td>
  137. </tr>
  138. </tbody>
  139. </table>
  140. <dl class="details">
  141. <dt class="tag-returns"><strong>Returns:</strong> An object for monitoring the versions of attributes.</dt>
  142. </dl>
  143. </div>
  144. <h3 class="name name-method" id="getLights" translate="no">.<a href="#getLights">getLights</a><span class="signature">( lightsNode : <span class="param-type">LightsNode</span>, renderId : <span class="param-type">number</span> )</span><span class="type-signature"> : Array.&lt;Object></span> </h3>
  145. <div class="method">
  146. <div class="description">
  147. <p>Returns the lights for the given lights node and render ID.</p>
  148. </div>
  149. <table class="params">
  150. <tbody>
  151. <tr>
  152. <td class="name"><code>lightsNode</code></td>
  153. <td class="description last"><p>The lights node.</p></td>
  154. </tr>
  155. <tr>
  156. <td class="name"><code>renderId</code></td>
  157. <td class="description last"><p>The render ID.</p></td>
  158. </tr>
  159. </tbody>
  160. </table>
  161. <dl class="details">
  162. <dt class="tag-returns"><strong>Returns:</strong> The lights for the given lights node and render ID.</dt>
  163. </dl>
  164. </div>
  165. <h3 class="name name-method" id="getLightsData" translate="no">.<a href="#getLightsData">getLightsData</a><span class="signature">( materialLights : <span class="param-type">Array.&lt;Light></span> )</span><span class="type-signature"> : Array.&lt;Object></span> </h3>
  166. <div class="method">
  167. <div class="description">
  168. <p>Returns the lights data for the given material lights.</p>
  169. </div>
  170. <table class="params">
  171. <tbody>
  172. <tr>
  173. <td class="name"><code>materialLights</code></td>
  174. <td class="description last"><p>The material lights.</p></td>
  175. </tr>
  176. </tbody>
  177. </table>
  178. <dl class="details">
  179. <dt class="tag-returns"><strong>Returns:</strong> The lights data for the given material lights.</dt>
  180. </dl>
  181. </div>
  182. <h3 class="name name-method" id="getMaterialData" translate="no">.<a href="#getMaterialData">getMaterialData</a><span class="signature">( material : <span class="param-type">Material</span> )</span><span class="type-signature"> : Object</span> </h3>
  183. <div class="method">
  184. <div class="description">
  185. <p>Returns a material data structure holding the material property values for
  186. monitoring.</p>
  187. </div>
  188. <table class="params">
  189. <tbody>
  190. <tr>
  191. <td class="name"><code>material</code></td>
  192. <td class="description last"><p>The material.</p></td>
  193. </tr>
  194. </tbody>
  195. </table>
  196. <dl class="details">
  197. <dt class="tag-returns"><strong>Returns:</strong> An object for monitoring material properties.</dt>
  198. </dl>
  199. </div>
  200. <h3 class="name name-method" id="getRenderObjectData" translate="no">.<a href="#getRenderObjectData">getRenderObjectData</a><span class="signature">( renderObject : <span class="param-type">RenderObject</span> )</span><span class="type-signature"> : Object</span> </h3>
  201. <div class="method">
  202. <div class="description">
  203. <p>Returns monitoring data for the given render object.</p>
  204. </div>
  205. <table class="params">
  206. <tbody>
  207. <tr>
  208. <td class="name"><code>renderObject</code></td>
  209. <td class="description last"><p>The render object.</p></td>
  210. </tr>
  211. </tbody>
  212. </table>
  213. <dl class="details">
  214. <dt class="tag-returns"><strong>Returns:</strong> The monitoring data.</dt>
  215. </dl>
  216. </div>
  217. <h3 class="name name-method" id="needsRefresh" translate="no">.<a href="#needsRefresh">needsRefresh</a><span class="signature">( renderObject : <span class="param-type">RenderObject</span>, nodeFrame : <span class="param-type">NodeFrame</span> )</span><span class="type-signature"> : boolean</span> </h3>
  218. <div class="method">
  219. <div class="description">
  220. <p>Checks if the given render object requires a refresh.</p>
  221. </div>
  222. <table class="params">
  223. <tbody>
  224. <tr>
  225. <td class="name"><code>renderObject</code></td>
  226. <td class="description last"><p>The render object.</p></td>
  227. </tr>
  228. <tr>
  229. <td class="name"><code>nodeFrame</code></td>
  230. <td class="description last"><p>The current node frame.</p></td>
  231. </tr>
  232. </tbody>
  233. </table>
  234. <dl class="details">
  235. <dt class="tag-returns"><strong>Returns:</strong> Whether the given render object requires a refresh or not.</dt>
  236. </dl>
  237. </div>
  238. <h3 class="name name-method" id="needsVelocity" translate="no">.<a href="#needsVelocity">needsVelocity</a><span class="signature">( renderer : <span class="param-type">Renderer</span> )</span><span class="type-signature"> : boolean</span> </h3>
  239. <div class="method">
  240. <div class="description">
  241. <p>Returns <code>true</code> if the current rendering produces motion vectors.</p>
  242. </div>
  243. <table class="params">
  244. <tbody>
  245. <tr>
  246. <td class="name"><code>renderer</code></td>
  247. <td class="description last"><p>The renderer.</p></td>
  248. </tr>
  249. </tbody>
  250. </table>
  251. <dl class="details">
  252. <dt class="tag-returns"><strong>Returns:</strong> Whether the current rendering produces motion vectors or not.</dt>
  253. </dl>
  254. </div>
  255. <h2 class="subsection-title">Source</h2>
  256. <p>
  257. <a href="https://github.com/mrdoob/three.js/blob/master/src/materials/nodes/manager/NodeMaterialObserver.js" target="_blank" rel="noopener" translate="no">src/materials/nodes/manager/NodeMaterialObserver.js</a>
  258. </p>
  259. </article>
  260. </section>
  261. <script src="../scripts/linenumber.js"></script>
  262. <script src="../scripts/page.js"></script>
  263. </body>
  264. </html>
粤ICP备19079148号