Главная Обзор Помощь
Регистрация Вход
samien
/
three.js
зеркало из https://github.com/mrdoob/three.js.git
1
0
Ответвить 0
Файлы Задачи 0 Вики
Дерево: 2dbf388df8
Ветки Метки
three.js
/
docs
/
pages
/
NodeMaterialObserver.html

NodeMaterialObserver.html 14 KB
История Исходник

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351 
  1. <!DOCTYPE html>
    2. 

  2. <html lang="en">
    3. 

  3. <head>
    4. 

  4. 	<meta charset="utf-8">
    5. 

  5. 	<title>NodeMaterialObserver - Three.js Docs</title>
    6. 

  6. 	<meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
    7. 

  7. 	<script src="../scripts/highlight.min.js"></script>
    8. 

  8. 	<link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
    9. 

  9. 	<link type="text/css" rel="stylesheet" href="../styles/page.css">
    10. 

  10. </head>
    11. 

  11. <body>
    12. 

  12. 	<h1 translate="no">NodeMaterialObserver</h1>
    13. 

  13. 		<section>
    14. 

  14. 			<header>
    15. 

  15. 				<div class="class-description"><p>This class is used by <a href="WebGPURenderer.html">WebGPURenderer</a> as management component.
    16. 

  16. It's primary purpose is to determine whether render objects require a
    17. 

  17. refresh right before they are going to be rendered or not.</p></div>
    18. 

  18. 			</header>
    19. 

  19. 			<article>
    20. 

  20. 				<div class="container-overview">
    21. 

  21. 					<h2>Constructor</h2>
    22. 

  22. 					<h3 class="name name-method" id="NodeMaterialObserver" translate="no">new <a href="#NodeMaterialObserver">NodeMaterialObserver</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span> </h3>
    23. 

  23. 					<div class="method">
    24. 

  24. 						<div class="description">
    25. 

  25. 							<p>Constructs a new node material observer.</p>
    26. 

  26. 						</div>
    27. 

  27. 						<table class="params">
    28. 

  28. 							<tbody>
    29. 

  29. 								<tr>
    30. 

  30. 									<td class="name">
    31. 

  31. 										<strong translate="no">builder</strong>
    32. 

  32. 									</td>
    33. 

  33. 									<td class="description last">
    34. 

  34. 										<p>The node builder.</p>
    35. 

  35. 									</td>
    36. 

  36. 								</tr>
    37. 

  37. 							</tbody>
    38. 

  38. 						</table>
    39. 

  39. 					</div>
    40. 

  40. 				</div>
    41. 

  41. 				<h2 class="subsection-title">Properties</h2>
    42. 

  42. 				<div class="member">
    43. 

  43. 					<h3 class="name" id="hasAnimation" translate="no">.<a href="#hasAnimation">hasAnimation</a><span class="type-signature"> : boolean</span> </h3>
    44. 

  44. 					<div class="description">
    45. 

  45. 						<p>Whether the node builder's 3D object is animated or not.</p>
    46. 

  46. 					</div>
    47. 

  47. 				</div>
    48. 

  48. 				<div class="member">
    49. 

  49. 					<h3 class="name" id="hasNode" translate="no">.<a href="#hasNode">hasNode</a><span class="type-signature"> : boolean</span> </h3>
    50. 

  50. 					<div class="description">
    51. 

  51. 						<p>Whether the material uses node objects or not.</p>
    52. 

  52. 					</div>
    53. 

  53. 				</div>
    54. 

  54. 				<div class="member">
    55. 

  55. 					<h3 class="name" id="refreshUniforms" translate="no">.<a href="#refreshUniforms">refreshUniforms</a><span class="type-signature"> : Array.&lt;string></span> </h3>
    56. 

  56. 					<div class="description">
    57. 

  57. 						<p>A list of all possible material uniforms</p>
    58. 

  58. 					</div>
    59. 

  59. 				</div>
    60. 

  60. 				<div class="member">
    61. 

  61. 					<h3 class="name" id="renderId" translate="no">.<a href="#renderId">renderId</a><span class="type-signature"> : number</span> </h3>
    62. 

  62. 					<div class="description">
    63. 

  63. 						<p>Holds the current render ID from the node frame.</p>
    64. 

  64. 						<p>Default is <code>0</code>.</p>
    65. 

  65. 					</div>
    66. 

  66. 				</div>
    67. 

  67. 				<div class="member">
    68. 

  68. 					<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>
    69. 

  69. 					<div class="description">
    70. 

  70. 						<p>A node material can be used by more than one render object so the
    71. 

  71. monitor must maintain a list of render objects.</p>
    72. 

  72. 					</div>
    73. 

  73. 				</div>
    74. 

  74. 				<h2 class="subsection-title">Methods</h2>
    75. 

  75. 					<h3 class="name name-method" id="containsNode" translate="no">.<a href="#containsNode">containsNode</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
    76. 

  76. 					<div class="method">
    77. 

  77. 						<div class="description">
    78. 

  78. 							<p>Returns <code>true</code> if the node builder's material uses
    79. 

  79. node properties.</p>
    80. 

  80. 						</div>
    81. 

  81. 						<table class="params">
    82. 

  82. 							<tbody>
    83. 

  83. 								<tr>
    84. 

  84. 									<td class="name">
    85. 

  85. 										<strong translate="no">builder</strong>
    86. 

  86. 									</td>
    87. 

  87. 									<td class="description last">
    88. 

  88. 										<p>The current node builder.</p>
    89. 

  89. 									</td>
    90. 

  90. 								</tr>
    91. 

  91. 							</tbody>
    92. 

  92. 						</table>
    93. 

  93. 						<dl class="details">
    94. 

  94. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the node builder's material uses node properties or not.</dt>
    95. 

  95. 						</dl>
    96. 

  96. 					</div>
    97. 

  97. 					<h3 class="name name-method" id="equals" translate="no">.<a href="#equals">equals</a><span class="signature">( renderObject : <span class="param-type"><a href="RenderObject.html">RenderObject</a></span>, lightsData : <span class="param-type">Array.&lt;<a href="Light.html">Light</a>></span>, renderId : <span class="param-type">number</span> )</span><span class="type-signature"> : boolean</span> </h3>
    98. 

  98. 					<div class="method">
    99. 

  99. 						<div class="description">
    100. 

  100. 							<p>Returns <code>true</code> if the given render object has not changed its state.</p>
    101. 

  101. 						</div>
    102. 

  102. 						<table class="params">
    103. 

  103. 							<tbody>
    104. 

  104. 								<tr>
    105. 

  105. 									<td class="name">
    106. 

  106. 										<strong translate="no">renderObject</strong>
    107. 

  107. 									</td>
    108. 

  108. 									<td class="description last">
    109. 

  109. 										<p>The render object.</p>
    110. 

  110. 									</td>
    111. 

  111. 								</tr>
    112. 

  112. 								<tr>
    113. 

  113. 									<td class="name">
    114. 

  114. 										<strong translate="no">lightsData</strong>
    115. 

  115. 									</td>
    116. 

  116. 									<td class="description last">
    117. 

  117. 										<p>The current material lights.</p>
    118. 

  118. 									</td>
    119. 

  119. 								</tr>
    120. 

  120. 								<tr>
    121. 

  121. 									<td class="name">
    122. 

  122. 										<strong translate="no">renderId</strong>
    123. 

  123. 									</td>
    124. 

  124. 									<td class="description last">
    125. 

  125. 										<p>The current render ID.</p>
    126. 

  126. 									</td>
    127. 

  127. 								</tr>
    128. 

  128. 							</tbody>
    129. 

  129. 						</table>
    130. 

  130. 						<dl class="details">
    131. 

  131. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the given render object has changed its state or not.</dt>
    132. 

  132. 						</dl>
    133. 

  133. 					</div>
    134. 

  134. 					<h3 class="name name-method" id="firstInitialization" translate="no">.<a href="#firstInitialization">firstInitialization</a><span class="signature">( renderObject : <span class="param-type"><a href="RenderObject.html">RenderObject</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
    135. 

  135. 					<div class="method">
    136. 

  136. 						<div class="description">
    137. 

  137. 							<p>Returns <code>true</code> if the given render object is verified for the first time of this observer.</p>
    138. 

  138. 						</div>
    139. 

  139. 						<table class="params">
    140. 

  140. 							<tbody>
    141. 

  141. 								<tr>
    142. 

  142. 									<td class="name">
    143. 

  143. 										<strong translate="no">renderObject</strong>
    144. 

  144. 									</td>
    145. 

  145. 									<td class="description last">
    146. 

  146. 										<p>The render object.</p>
    147. 

  147. 									</td>
    148. 

  148. 								</tr>
    149. 

  149. 							</tbody>
    150. 

  150. 						</table>
    151. 

  151. 						<dl class="details">
    152. 

  152. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the given render object is verified for the first time of this observer.</dt>
    153. 

  153. 						</dl>
    154. 

  154. 					</div>
    155. 

  155. 					<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>
    156. 

  156. 					<div class="method">
    157. 

  157. 						<div class="description">
    158. 

  158. 							<p>Returns an attribute data structure holding the attributes versions for
    159. 

  159. monitoring.</p>
    160. 

  160. 						</div>
    161. 

  161. 						<table class="params">
    162. 

  162. 							<tbody>
    163. 

  163. 								<tr>
    164. 

  164. 									<td class="name">
    165. 

  165. 										<strong translate="no">attributes</strong>
    166. 

  166. 									</td>
    167. 

  167. 									<td class="description last">
    168. 

  168. 										<p>The geometry attributes.</p>
    169. 

  169. 									</td>
    170. 

  170. 								</tr>
    171. 

  171. 							</tbody>
    172. 

  172. 						</table>
    173. 

  173. 						<dl class="details">
    174. 

  174. 							<dt class="tag-returns"><strong>Returns:</strong> An object for monitoring the versions of attributes.</dt>
    175. 

  175. 						</dl>
    176. 

  176. 					</div>
    177. 

  177. 					<h3 class="name name-method" id="getGeometryData" translate="no">.<a href="#getGeometryData">getGeometryData</a><span class="signature">( geometry : <span class="param-type"><a href="BufferGeometry.html">BufferGeometry</a></span> )</span><span class="type-signature"> : Object</span> </h3>
    178. 

  178. 					<div class="method">
    179. 

  179. 						<div class="description">
    180. 

  180. 							<p>Returns a geometry data structure holding the geometry property values for
    181. 

  181. monitoring.</p>
    182. 

  182. 						</div>
    183. 

  183. 						<table class="params">
    184. 

  184. 							<tbody>
    185. 

  185. 								<tr>
    186. 

  186. 									<td class="name">
    187. 

  187. 										<strong translate="no">geometry</strong>
    188. 

  188. 									</td>
    189. 

  189. 									<td class="description last">
    190. 

  190. 										<p>The geometry.</p>
    191. 

  191. 									</td>
    192. 

  192. 								</tr>
    193. 

  193. 							</tbody>
    194. 

  194. 						</table>
    195. 

  195. 						<dl class="details">
    196. 

  196. 							<dt class="tag-returns"><strong>Returns:</strong> An object for monitoring geometry properties.</dt>
    197. 

  197. 						</dl>
    198. 

  198. 					</div>
    199. 

  199. 					<h3 class="name name-method" id="getLights" translate="no">.<a href="#getLights">getLights</a><span class="signature">( lightsNode : <span class="param-type"><a href="LightsNode.html">LightsNode</a></span>, renderId : <span class="param-type">number</span> )</span><span class="type-signature"> : Array.&lt;Object></span> </h3>
    200. 

  200. 					<div class="method">
    201. 

  201. 						<div class="description">
    202. 

  202. 							<p>Returns the lights for the given lights node and render ID.</p>
    203. 

  203. 						</div>
    204. 

  204. 						<table class="params">
    205. 

  205. 							<tbody>
    206. 

  206. 								<tr>
    207. 

  207. 									<td class="name">
    208. 

  208. 										<strong translate="no">lightsNode</strong>
    209. 

  209. 									</td>
    210. 

  210. 									<td class="description last">
    211. 

  211. 										<p>The lights node.</p>
    212. 

  212. 									</td>
    213. 

  213. 								</tr>
    214. 

  214. 								<tr>
    215. 

  215. 									<td class="name">
    216. 

  216. 										<strong translate="no">renderId</strong>
    217. 

  217. 									</td>
    218. 

  218. 									<td class="description last">
    219. 

  219. 										<p>The render ID.</p>
    220. 

  220. 									</td>
    221. 

  221. 								</tr>
    222. 

  222. 							</tbody>
    223. 

  223. 						</table>
    224. 

  224. 						<dl class="details">
    225. 

  225. 							<dt class="tag-returns"><strong>Returns:</strong> The lights for the given lights node and render ID.</dt>
    226. 

  226. 						</dl>
    227. 

  227. 					</div>
    228. 

  228. 					<h3 class="name name-method" id="getLightsData" translate="no">.<a href="#getLightsData">getLightsData</a><span class="signature">( materialLights : <span class="param-type">Array.&lt;<a href="Light.html">Light</a>></span> )</span><span class="type-signature"> : Array.&lt;Object></span> </h3>
    229. 

  229. 					<div class="method">
    230. 

  230. 						<div class="description">
    231. 

  231. 							<p>Returns the lights data for the given material lights.</p>
    232. 

  232. 						</div>
    233. 

  233. 						<table class="params">
    234. 

  234. 							<tbody>
    235. 

  235. 								<tr>
    236. 

  236. 									<td class="name">
    237. 

  237. 										<strong translate="no">materialLights</strong>
    238. 

  238. 									</td>
    239. 

  239. 									<td class="description last">
    240. 

  240. 										<p>The material lights.</p>
    241. 

  241. 									</td>
    242. 

  242. 								</tr>
    243. 

  243. 							</tbody>
    244. 

  244. 						</table>
    245. 

  245. 						<dl class="details">
    246. 

  246. 							<dt class="tag-returns"><strong>Returns:</strong> The lights data for the given material lights.</dt>
    247. 

  247. 						</dl>
    248. 

  248. 					</div>
    249. 

  249. 					<h3 class="name name-method" id="getMaterialData" translate="no">.<a href="#getMaterialData">getMaterialData</a><span class="signature">( material : <span class="param-type"><a href="Material.html">Material</a></span> )</span><span class="type-signature"> : Object</span> </h3>
    250. 

  250. 					<div class="method">
    251. 

  251. 						<div class="description">
    252. 

  252. 							<p>Returns a material data structure holding the material property values for
    253. 

  253. monitoring.</p>
    254. 

  254. 						</div>
    255. 

  255. 						<table class="params">
    256. 

  256. 							<tbody>
    257. 

  257. 								<tr>
    258. 

  258. 									<td class="name">
    259. 

  259. 										<strong translate="no">material</strong>
    260. 

  260. 									</td>
    261. 

  261. 									<td class="description last">
    262. 

  262. 										<p>The material.</p>
    263. 

  263. 									</td>
    264. 

  264. 								</tr>
    265. 

  265. 							</tbody>
    266. 

  266. 						</table>
    267. 

  267. 						<dl class="details">
    268. 

  268. 							<dt class="tag-returns"><strong>Returns:</strong> An object for monitoring material properties.</dt>
    269. 

  269. 						</dl>
    270. 

  270. 					</div>
    271. 

  271. 					<h3 class="name name-method" id="getRenderObjectData" translate="no">.<a href="#getRenderObjectData">getRenderObjectData</a><span class="signature">( renderObject : <span class="param-type"><a href="RenderObject.html">RenderObject</a></span> )</span><span class="type-signature"> : Object</span> </h3>
    272. 

  272. 					<div class="method">
    273. 

  273. 						<div class="description">
    274. 

  274. 							<p>Returns monitoring data for the given render object.</p>
    275. 

  275. 						</div>
    276. 

  276. 						<table class="params">
    277. 

  277. 							<tbody>
    278. 

  278. 								<tr>
    279. 

  279. 									<td class="name">
    280. 

  280. 										<strong translate="no">renderObject</strong>
    281. 

  281. 									</td>
    282. 

  282. 									<td class="description last">
    283. 

  283. 										<p>The render object.</p>
    284. 

  284. 									</td>
    285. 

  285. 								</tr>
    286. 

  286. 							</tbody>
    287. 

  287. 						</table>
    288. 

  288. 						<dl class="details">
    289. 

  289. 							<dt class="tag-returns"><strong>Returns:</strong> The monitoring data.</dt>
    290. 

  290. 						</dl>
    291. 

  291. 					</div>
    292. 

  292. 					<h3 class="name name-method" id="needsRefresh" translate="no">.<a href="#needsRefresh">needsRefresh</a><span class="signature">( renderObject : <span class="param-type"><a href="RenderObject.html">RenderObject</a></span>, nodeFrame : <span class="param-type"><a href="NodeFrame.html">NodeFrame</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
    293. 

  293. 					<div class="method">
    294. 

  294. 						<div class="description">
    295. 

  295. 							<p>Checks if the given render object requires a refresh.</p>
    296. 

  296. 						</div>
    297. 

  297. 						<table class="params">
    298. 

  298. 							<tbody>
    299. 

  299. 								<tr>
    300. 

  300. 									<td class="name">
    301. 

  301. 										<strong translate="no">renderObject</strong>
    302. 

  302. 									</td>
    303. 

  303. 									<td class="description last">
    304. 

  304. 										<p>The render object.</p>
    305. 

  305. 									</td>
    306. 

  306. 								</tr>
    307. 

  307. 								<tr>
    308. 

  308. 									<td class="name">
    309. 

  309. 										<strong translate="no">nodeFrame</strong>
    310. 

  310. 									</td>
    311. 

  311. 									<td class="description last">
    312. 

  312. 										<p>The current node frame.</p>
    313. 

  313. 									</td>
    314. 

  314. 								</tr>
    315. 

  315. 							</tbody>
    316. 

  316. 						</table>
    317. 

  317. 						<dl class="details">
    318. 

  318. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the given render object requires a refresh or not.</dt>
    319. 

  319. 						</dl>
    320. 

  320. 					</div>
    321. 

  321. 					<h3 class="name name-method" id="needsVelocity" translate="no">.<a href="#needsVelocity">needsVelocity</a><span class="signature">( renderer : <span class="param-type"><a href="Renderer.html">Renderer</a></span> )</span><span class="type-signature"> : boolean</span> </h3>
    322. 

  322. 					<div class="method">
    323. 

  323. 						<div class="description">
    324. 

  324. 							<p>Returns <code>true</code> if the current rendering produces motion vectors.</p>
    325. 

  325. 						</div>
    326. 

  326. 						<table class="params">
    327. 

  327. 							<tbody>
    328. 

  328. 								<tr>
    329. 

  329. 									<td class="name">
    330. 

  330. 										<strong translate="no">renderer</strong>
    331. 

  331. 									</td>
    332. 

  332. 									<td class="description last">
    333. 

  333. 										<p>The renderer.</p>
    334. 

  334. 									</td>
    335. 

  335. 								</tr>
    336. 

  336. 							</tbody>
    337. 

  337. 						</table>
    338. 

  338. 						<dl class="details">
    339. 

  339. 							<dt class="tag-returns"><strong>Returns:</strong> Whether the current rendering produces motion vectors or not.</dt>
    340. 

  340. 						</dl>
    341. 

  341. 					</div>
    342. 

  342. 				<h2 class="subsection-title">Source</h2>
    343. 

  343. 				<p>
    344. 

  344. 					<a href="https://github.com/mrdoob/three.js/blob/master/src/materials/nodes/manager/NodeMaterialObserver.js" translate="no" target="_blank" rel="noopener">src/materials/nodes/manager/NodeMaterialObserver.js</a>
    345. 

  345. 				</p>
    346. 

  346. 			</article>
    347. 

  347. 		</section>
    348. 

  348. <script src="../scripts/linenumber.js"></script>
    349. 

  349. <script src="../scripts/page.js"></script>
    350. 

  350. </body>
    351. 

  351. </html>
    352.
粤ICP备19079148号