NodeObjectLoader.html 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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">LoadingManager</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"><code>manager</code></td>
  31. <td class="description last"><p>A reference to a loading manager.</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="nodeMaterials" translate="no">.<a href="#nodeMaterials">nodeMaterials</a><span class="type-signature"> : Object.&lt;string, NodeMaterial.constructor></span> </h3>
  40. <div class="description">
  41. <p>Represents a dictionary of node material types.</p>
  42. </div>
  43. </div>
  44. <div class="member">
  45. <h3 class="name" id="nodes" translate="no">.<a href="#nodes">nodes</a><span class="type-signature"> : Object.&lt;string, Node.constructor></span> </h3>
  46. <div class="description">
  47. <p>Represents a dictionary of node types.</p>
  48. </div>
  49. </div>
  50. <h2 class="subsection-title">Methods</h2>
  51. <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>
  52. <div class="method">
  53. <div class="description">
  54. <p>Parses the node objects from the given JSON.</p>
  55. </div>
  56. <table class="params">
  57. <tbody>
  58. <tr>
  59. <td class="name"><code>json</code></td>
  60. <td class="description last"><p>The JSON definition</p></td>
  61. </tr>
  62. <tr>
  63. <td class="name"><code>onLoad</code></td>
  64. <td class="description last"><p>The onLoad callback function.</p></td>
  65. </tr>
  66. </tbody>
  67. </table>
  68. <dl class="details">
  69. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ObjectLoader.html#parse">ObjectLoader#parse</a></dt>
  70. </dl>
  71. <dl class="details">
  72. <dt class="tag-returns"><strong>Returns:</strong> . The parsed 3D object.</dt>
  73. </dl>
  74. </div>
  75. <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, Texture></span> )</span><span class="type-signature"> : Object.&lt;string, <a href="NodeMaterial.html">NodeMaterial</a>></span> </h3>
  76. <div class="method">
  77. <div class="description">
  78. <p>Parses the node objects from the given JSON and textures.</p>
  79. </div>
  80. <table class="params">
  81. <tbody>
  82. <tr>
  83. <td class="name"><code>json</code></td>
  84. <td class="description last"><p>The JSON definition</p></td>
  85. </tr>
  86. <tr>
  87. <td class="name"><code>textures</code></td>
  88. <td class="description last"><p>The texture library.</p></td>
  89. </tr>
  90. </tbody>
  91. </table>
  92. <dl class="details">
  93. <dt class="tag-returns"><strong>Returns:</strong> . The parsed materials.</dt>
  94. </dl>
  95. </div>
  96. <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, Texture></span> )</span><span class="type-signature"> : Object.&lt;string, <a href="Node.html">Node</a>></span> </h3>
  97. <div class="method">
  98. <div class="description">
  99. <p>Parses the node objects from the given JSON and textures.</p>
  100. </div>
  101. <table class="params">
  102. <tbody>
  103. <tr>
  104. <td class="name"><code>json</code></td>
  105. <td class="description last"><p>The JSON definition</p></td>
  106. </tr>
  107. <tr>
  108. <td class="name"><code>textures</code></td>
  109. <td class="description last"><p>The texture library.</p></td>
  110. </tr>
  111. </tbody>
  112. </table>
  113. <dl class="details">
  114. <dt class="tag-returns"><strong>Returns:</strong> . The parsed nodes.</dt>
  115. </dl>
  116. </div>
  117. <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>
  118. <div class="method">
  119. <div class="description">
  120. <p>Defines the dictionary of node material types.</p>
  121. </div>
  122. <table class="params">
  123. <tbody>
  124. <tr>
  125. <td class="name"><code>value</code></td>
  126. <td class="description last"><p>The node material library defined as <code>&lt;classname,class&gt;</code>.</p></td>
  127. </tr>
  128. </tbody>
  129. </table>
  130. <dl class="details">
  131. <dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
  132. </dl>
  133. </div>
  134. <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>
  135. <div class="method">
  136. <div class="description">
  137. <p>Defines the dictionary of node types.</p>
  138. </div>
  139. <table class="params">
  140. <tbody>
  141. <tr>
  142. <td class="name"><code>value</code></td>
  143. <td class="description last"><p>The node library defined as <code>&lt;classname,class&gt;</code>.</p></td>
  144. </tr>
  145. </tbody>
  146. </table>
  147. <dl class="details">
  148. <dt class="tag-returns"><strong>Returns:</strong> A reference to this loader.</dt>
  149. </dl>
  150. </div>
  151. <h2 class="subsection-title">Source</h2>
  152. <p>
  153. <a href="https://github.com/mrdoob/three.js/blob/master/src/loaders/nodes/NodeObjectLoader.js" target="_blank" rel="noopener" translate="no">src/loaders/nodes/NodeObjectLoader.js</a>
  154. </p>
  155. </article>
  156. </section>
  157. <script src="../scripts/linenumber.js"></script>
  158. <script src="../scripts/page.js"></script>
  159. </body>
  160. </html>
粤ICP备19079148号