FunctionCallNode.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>FunctionCallNode - 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="TempNode.html">TempNode</a> → </p>
  13. <h1 translate="no">FunctionCallNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This module represents the call of a <a href="FunctionNode.html">FunctionNode</a>. Developers are usually not confronted
  17. with this module since they use the predefined TSL syntax <code>wgslFn</code> and <code>glslFn</code> which encapsulate
  18. this logic.</p></div>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <h2>Constructor</h2>
  23. <h3 class="name name-method" id="FunctionCallNode" translate="no">new <a href="#FunctionCallNode">FunctionCallNode</a><span class="signature">( functionNode : <span class="param-type"><a href="FunctionNode.html">FunctionNode</a></span>, parameters : <span class="param-type">Object.&lt;string, <a href="Node.html">Node</a>></span> )</span> </h3>
  24. <div class="method">
  25. <div class="description">
  26. <p>Constructs a new function call node.</p>
  27. </div>
  28. <table class="params">
  29. <tbody>
  30. <tr>
  31. <td class="name">
  32. <strong>functionNode</strong>
  33. </td>
  34. <td class="description last">
  35. <p>The function node.</p>
  36. <p>Default is <code>null</code>.</p>
  37. </td>
  38. </tr>
  39. <tr>
  40. <td class="name">
  41. <strong>parameters</strong>
  42. </td>
  43. <td class="description last">
  44. <p>The parameters for the function call.</p>
  45. <p>Default is <code>{}</code>.</p>
  46. </td>
  47. </tr>
  48. </tbody>
  49. </table>
  50. </div>
  51. </div>
  52. <h2 class="subsection-title">Properties</h2>
  53. <div class="member">
  54. <h3 class="name" id="functionNode" translate="no">.<a href="#functionNode">functionNode</a><span class="type-signature"> : <a href="FunctionNode.html">FunctionNode</a></span> </h3>
  55. <div class="description">
  56. <p>The function node.</p>
  57. <p>Default is <code>null</code>.</p>
  58. </div>
  59. </div>
  60. <div class="member">
  61. <h3 class="name" id="parameters" translate="no">.<a href="#parameters">parameters</a><span class="type-signature"> : Object.&lt;string, <a href="Node.html">Node</a>></span> </h3>
  62. <div class="description">
  63. <p>The parameters of the function call.</p>
  64. <p>Default is <code>{}</code>.</p>
  65. </div>
  66. </div>
  67. <h2 class="subsection-title">Methods</h2>
  68. <h3 class="name name-method" id="getMemberType" translate="no">.<a href="#getMemberType">getMemberType</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span>, name : <span class="param-type">string</span> )</span><span class="type-signature"> : string</span> </h3>
  69. <div class="method">
  70. <div class="description">
  71. <p>Returns the function node of this function call node.</p>
  72. </div>
  73. <table class="params">
  74. <tbody>
  75. <tr>
  76. <td class="name">
  77. <strong>builder</strong>
  78. </td>
  79. <td class="description last">
  80. <p>The current node builder.</p>
  81. </td>
  82. </tr>
  83. <tr>
  84. <td class="name">
  85. <strong>name</strong>
  86. </td>
  87. <td class="description last">
  88. <p>The name of the member.</p>
  89. </td>
  90. </tr>
  91. </tbody>
  92. </table>
  93. <dl class="details">
  94. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#getMemberType">TempNode#getMemberType</a></dt>
  95. </dl>
  96. <dl class="details">
  97. <dt class="tag-returns"><strong>Returns:</strong> The type of the member.</dt>
  98. </dl>
  99. </div>
  100. <h3 class="name name-method" id="getNodeType" translate="no">.<a href="#getNodeType">getNodeType</a><span class="signature">( builder : <span class="param-type"><a href="NodeBuilder.html">NodeBuilder</a></span> )</span><span class="type-signature"> : string</span> </h3>
  101. <div class="method">
  102. <div class="description">
  103. <p>Returns the type of this function call node.</p>
  104. </div>
  105. <table class="params">
  106. <tbody>
  107. <tr>
  108. <td class="name">
  109. <strong>builder</strong>
  110. </td>
  111. <td class="description last">
  112. <p>The current node builder.</p>
  113. </td>
  114. </tr>
  115. </tbody>
  116. </table>
  117. <dl class="details">
  118. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="TempNode.html#getNodeType">TempNode#getNodeType</a></dt>
  119. </dl>
  120. <dl class="details">
  121. <dt class="tag-returns"><strong>Returns:</strong> The type of this node.</dt>
  122. </dl>
  123. </div>
  124. <h3 class="name name-method" id="getParameters" translate="no">.<a href="#getParameters">getParameters</a><span class="signature">()</span><span class="type-signature"> : Object.&lt;string, <a href="Node.html">Node</a>></span> </h3>
  125. <div class="method">
  126. <div class="description">
  127. <p>Returns the parameters of the function call node.</p>
  128. </div>
  129. <dl class="details">
  130. <dt class="tag-returns"><strong>Returns:</strong> The parameters of this node.</dt>
  131. </dl>
  132. </div>
  133. <h3 class="name name-method" id="setParameters" translate="no">.<a href="#setParameters">setParameters</a><span class="signature">( parameters : <span class="param-type">Object.&lt;string, <a href="Node.html">Node</a>></span> )</span><span class="type-signature"> : <a href="FunctionCallNode.html">FunctionCallNode</a></span> </h3>
  134. <div class="method">
  135. <div class="description">
  136. <p>Sets the parameters of the function call node.</p>
  137. </div>
  138. <table class="params">
  139. <tbody>
  140. <tr>
  141. <td class="name">
  142. <strong>parameters</strong>
  143. </td>
  144. <td class="description last">
  145. <p>The parameters to set.</p>
  146. </td>
  147. </tr>
  148. </tbody>
  149. </table>
  150. <dl class="details">
  151. <dt class="tag-returns"><strong>Returns:</strong> A reference to this node.</dt>
  152. </dl>
  153. </div>
  154. <h2 class="subsection-title">Source</h2>
  155. <p>
  156. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/code/FunctionCallNode.js" translate="no" target="_blank" rel="noopener">src/nodes/code/FunctionCallNode.js</a>
  157. </p>
  158. </article>
  159. </section>
  160. <script src="../scripts/linenumber.js"></script>
  161. <script src="../scripts/page.js"></script>
  162. </body>
  163. </html>
粤ICP备19079148号