NodeObjectLoader.html 7.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>NodeObjectLoader - 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="Loader.html">Loader</a> → <a href="ObjectLoader.html">ObjectLoader</a> → </p>
  13. <h1 translate="no">NodeObjectLoader</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>A special type of object loader for loading 3D objects using
  17. node materials.</p></div>
  18. </header>
  19. <article>
  20. <div class="container-overview">
  21. <h2>Constructor</h2>
  22. <h3 class="name name-method" id="NodeObjectLoader" translate="no">new <a href="#NodeObjectLoader">NodeObjectLoader</a><span class="signature">( manager : <span class="param-type"><a href="LoadingManager.html">LoadingManager</a></span> )</span> </h3>
  23. <div class="method">
  24. <div class="description">
  25. <p>Constructs a new node object loader.</p>
  26. </div>
  27. <table class="params">
  28. <tbody>
  29. <tr>
  30. <td class="name">
  31. <strong>manager</strong>
  32. </td>
  33. <td class="description last">
  34. <p>A reference to a loading manager.</p>
  35. </td>
  36. </tr>
  37. </tbody>
  38. </table>
  39. </div>
  40. </div>
  41. <h2 class="subsection-title">Properties</h2>
  42. <div class="member">
  43. <h3 class="name" id="nodeMaterials" translate="no">.<a href="#nodeMaterials">nodeMaterials</a><span class="type-signature"> : Object.&lt;string, NodeMaterial.constructor></span> </h3>
  44. <div class="description">
  45. <p>Represents a dictionary of node material types.</p>
  46. </div>
  47. </div>
  48. <div class="member">
  49. <h3 class="name" id="nodes" translate="no">.<a href="#nodes">nodes</a><span class="type-signature"> : Object.&lt;string, Node.constructor></span> </h3>
  50. <div class="description">
  51. <p>Represents a dictionary of node types.</p>
  52. </div>
  53. </div>
  54. <h2 class="subsection-title">Methods</h2>
  55. <h3 class="name name-method" id="parse" translate="no">.<a href="#parse">parse</a><span class="signature">( json : <span class="param-type">Object</span>, onLoad : <span class="param-type">function</span> )</span><span class="type-signature"> : <a href="Object3D.html">Object3D</a></span> </h3>
  56. <div class="method">
  57. <div class="description">
  58. <p>Parses the node objects from the given JSON.</p>
  59. </div>
  60. <table class="params">
  61. <tbody>
  62. <tr>
  63. <td class="name">
  64. <strong>json</strong>
  65. </td>
  66. <td class="description last">
  67. <p>The JSON definition</p>
  68. </td>
  69. </tr>
  70. <tr>
  71. <td class="name">
  72. <strong>onLoad</strong>
  73. </td>
  74. <td class="description last">
  75. <p>The onLoad callback function.</p>
  76. </td>
  77. </tr>
  78. </tbody>
  79. </table>
  80. <dl class="details">
  81. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ObjectLoader.html#parse">ObjectLoader#parse</a></dt>
  82. </dl>
  83. <dl class="details">
  84. <dt class="tag-returns"><strong>Returns:</strong> . The parsed 3D object.</dt>
  85. </dl>
  86. </div>
  87. <h3 class="name name-method" id="parseMaterials" translate="no">.<a href="#parseMaterials">parseMaterials</a><span class="signature">( json : <span class="param-type">Object</span>, textures : <span class="param-type">Object.&lt;string, <a href="Texture.html">Texture</a>></span> )</span><span class="type-signature"> : Object.&lt;string, <a href="NodeMaterial.html">NodeMaterial</a>></span> </h3>
  88. <div class="method">
  89. <div class="description">
  90. <p>Parses the node objects from the given JSON and textures.</p>
  91. </div>
  92. <table class="params">
  93. <tbody>
  94. <tr>
  95. <td class="name">
  96. <strong>json</strong>
  97. </td>
  98. <td class="description last">
  99. <p>The JSON definition</p>
  100. </td>
  101. </tr>
  102. <tr>
  103. <td class="name">
  104. <strong>textures</strong>
  105. </td>
  106. <td class="description last">
  107. <p>The texture library.</p>
  108. </td>
  109. </tr>
  110. </tbody>
  111. </table>
  112. <dl class="details">
  113. <dt class="tag-returns"><strong>Returns:</strong> . The parsed materials.</dt>
  114. </dl>
  115. </div>
  116. <h3 class="name name-method" id="parseNodes" translate="no">.<a href="#parseNodes">parseNodes</a><span class="signature">( json : <span class="param-type">Array.&lt;Object></span>, textures : <span class="param-type">Object.&lt;string, <a href="Texture.html">Texture</a>></span> )</span><span class="type-signature"> : Object.&lt;string, <a href="Node.html">Node</a>></span> </h3>
  117. <div class="method">
  118. <div class="description">
  119. <p>Parses the node objects from the given JSON and textures.</p>
  120. </div>
  121. <table class="params">
  122. <tbody>
  123. <tr>
  124. <td class="name">
  125. <strong>json</strong>
  126. </td>
  127. <td class="description last">
  128. <p>The JSON definition</p>
  129. </td>
  130. </tr>
  131. <tr>
  132. <td class="name">
  133. <strong>textures</strong>
  134. </td>
  135. <td class="description last">
  136. <p>The texture library.</p>
  137. </td>
  138. </tr>
  139. </tbody>
  140. </table>
  141. <dl class="details">
  142. <dt class="tag-returns"><strong>Returns:</strong> . The parsed nodes.</dt>
  143. </dl>
  144. </div>
  145. <h3 class="name name-method" id="setNodeMaterials" translate="no">.<a href="#setNodeMaterials">setNodeMaterials</a><span class="signature">( value : <span class="param-type">Object.&lt;string, NodeMaterial.constructor></span> )</span><span class="type-signature"> : <a href="NodeObjectLoader.html">NodeObjectLoader</a></span> </h3>
  146. <div class="method">
  147. <div class="description">
  148. <p>Defines the dictionary of node material types.</p>
  149. </div>
  150. <table class="params">
  151. <tbody>
  152. <tr>
  153. <td class="name">
  154. <strong>value</strong>
  155. </td>
  156. <td class="description last">
  157. <p>The node material library defined as <code>&lt;classname,class&gt;</code>.</p>
  158. </td>
  159. </tr>
  160. </tbody>
  161. </table>
  162. <dl class="details">
  163. <dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
  164. </dl>
  165. </div>
  166. <h3 class="name name-method" id="setNodes" translate="no">.<a href="#setNodes">setNodes</a><span class="signature">( value : <span class="param-type">Object.&lt;string, Node.constructor></span> )</span><span class="type-signature"> : <a href="NodeObjectLoader.html">NodeObjectLoader</a></span> </h3>
  167. <div class="method">
  168. <div class="description">
  169. <p>Defines the dictionary of node types.</p>
  170. </div>
  171. <table class="params">
  172. <tbody>
  173. <tr>
  174. <td class="name">
  175. <strong>value</strong>
  176. </td>
  177. <td class="description last">
  178. <p>The node library defined as <code>&lt;classname,class&gt;</code>.</p>
  179. </td>
  180. </tr>
  181. </tbody>
  182. </table>
  183. <dl class="details">
  184. <dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
  185. </dl>
  186. </div>
  187. <h2 class="subsection-title">Source</h2>
  188. <p>
  189. <a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/nodes/NodeObjectLoader.js" translate="no" target="_blank" rel="noopener">src/loaders/nodes/NodeObjectLoader.js</a>
  190. </p>
  191. </article>
  192. </section>
  193. <script src="../scripts/linenumber.js"></script>
  194. <script src="../scripts/page.js"></script>
  195. </body>
  196. </html>
粤ICP备19079148号