ReferenceElementNode.html 9.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>ReferenceElementNode - 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="ArrayElementNode.html">ArrayElementNode</a> → </p>
  13. <h1 translate="no">ReferenceElementNode</h1>
  14. <section>
  15. <header>
  16. <div class="class-description"><p>This class is only relevant if the referenced property is array-like.
  17. In this case, <code>ReferenceElementNode</code> allows to refer to a specific
  18. element inside the data structure via an index.</p></div>
  19. </header>
  20. <article>
  21. <div class="container-overview">
  22. <h2>Constructor</h2>
  23. <h3 class="name name-method" id="ReferenceElementNode" translate="no">new <a href="#ReferenceElementNode">ReferenceElementNode</a><span class="signature">( referenceNode : <span class="param-type">ReferenceBaseNode</span>, indexNode : <span class="param-type">Node</span> )</span> </h3>
  24. <div class="method">
  25. <div class="description">
  26. <p>Constructs a new reference element node.</p>
  27. </div>
  28. <table class="params">
  29. <tbody>
  30. <tr>
  31. <td class="name"><code>referenceNode</code></td>
  32. <td class="description last"><p>The reference node.</p></td>
  33. </tr>
  34. <tr>
  35. <td class="name"><code>indexNode</code></td>
  36. <td class="description last"><p>The index node that defines the element access.</p></td>
  37. </tr>
  38. </tbody>
  39. </table>
  40. </div>
  41. </div>
  42. <h2 class="subsection-title">Properties</h2>
  43. <div class="member">
  44. <h3 class="name" id="isReferenceElementNode" translate="no">.<a href="#isReferenceElementNode">isReferenceElementNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  45. <div class="description">
  46. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  47. </div>
  48. </div>
  49. <div class="member">
  50. <h3 class="name" id="isReferenceElementNode" translate="no">.<a href="#isReferenceElementNode">isReferenceElementNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  51. <div class="description">
  52. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  53. </div>
  54. </div>
  55. <div class="member">
  56. <h3 class="name" id="referenceNode" translate="no">.<a href="#referenceNode">referenceNode</a><span class="type-signature"> : <a href="ReferenceBaseNode.html">ReferenceBaseNode</a></span> </h3>
  57. <div class="description">
  58. <p>Similar to <a href="ReferenceBaseNode.html#reference">ReferenceBaseNode#reference</a>, an additional
  59. property references to the current node.<br/>Default is <code>null</code>.</p>
  60. </div>
  61. </div>
  62. <div class="member">
  63. <h3 class="name" id="referenceNode" translate="no">.<a href="#referenceNode">referenceNode</a><span class="type-signature"> : <a href="ReferenceNode.html">ReferenceNode</a></span> </h3>
  64. <div class="description">
  65. <p>Similar to <a href="ReferenceNode.html#reference">ReferenceNode#reference</a>, an additional
  66. property references to the current node.<br/>Default is <code>null</code>.</p>
  67. </div>
  68. </div>
  69. <h2 class="subsection-title">Methods</h2>
  70. <h3 class="name name-method" id="getNodeType" translate="no">.<a href="#getNodeType">getNodeType</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  71. <div class="method">
  72. <div class="description">
  73. <p>This method is overwritten since the node type is inferred from
  74. the uniform type of the reference node.</p>
  75. </div>
  76. <dl class="details">
  77. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ArrayElementNode.html#getNodeType">ArrayElementNode#getNodeType</a></dt>
  78. </dl>
  79. <dl class="details">
  80. <dt class="tag-returns"><strong>Returns:</strong> The node type.</dt>
  81. </dl>
  82. </div>
  83. <h3 class="name name-method" id="getNodeType" translate="no">.<a href="#getNodeType">getNodeType</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  84. <div class="method">
  85. <div class="description">
  86. <p>This method is overwritten since the node type is inferred from
  87. the uniform type of the reference node.</p>
  88. </div>
  89. <dl class="details">
  90. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ArrayElementNode.html#getNodeType">ArrayElementNode#getNodeType</a></dt>
  91. </dl>
  92. <dl class="details">
  93. <dt class="tag-returns"><strong>Returns:</strong> The node type.</dt>
  94. </dl>
  95. </div>
  96. <h2 class="subsection-title">Source</h2>
  97. <p>
  98. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/accessors/ReferenceBaseNode.js" target="_blank" rel="noopener" translate="no">src/nodes/accessors/ReferenceBaseNode.js</a>
  99. </p>
  100. </article>
  101. </section>
  102. <section>
  103. <header>
  104. <div class="class-description"><p>This class is only relevant if the referenced property is array-like.
  105. In this case, <code>ReferenceElementNode</code> allows to refer to a specific
  106. element inside the data structure via an index.</p></div>
  107. </header>
  108. <article>
  109. <div class="container-overview">
  110. <h2>Constructor</h2>
  111. <h3 class="name name-method" id="ReferenceElementNode" translate="no">new <a href="#ReferenceElementNode">ReferenceElementNode</a><span class="signature">( referenceNode : <span class="param-type">ReferenceNode</span>, indexNode : <span class="param-type">Node</span> )</span> </h3>
  112. <div class="method">
  113. <div class="description">
  114. <p>Constructs a new reference element node.</p>
  115. </div>
  116. <table class="params">
  117. <tbody>
  118. <tr>
  119. <td class="name"><code>referenceNode</code></td>
  120. <td class="description last"><p>The reference node.</p></td>
  121. </tr>
  122. <tr>
  123. <td class="name"><code>indexNode</code></td>
  124. <td class="description last"><p>The index node that defines the element access.</p></td>
  125. </tr>
  126. </tbody>
  127. </table>
  128. </div>
  129. </div>
  130. <h2 class="subsection-title">Properties</h2>
  131. <div class="member">
  132. <h3 class="name" id="isReferenceElementNode" translate="no">.<a href="#isReferenceElementNode">isReferenceElementNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  133. <div class="description">
  134. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  135. </div>
  136. </div>
  137. <div class="member">
  138. <h3 class="name" id="isReferenceElementNode" translate="no">.<a href="#isReferenceElementNode">isReferenceElementNode</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  139. <div class="description">
  140. <p>This flag can be used for type testing.<br/>Default is <code>true</code>.</p>
  141. </div>
  142. </div>
  143. <div class="member">
  144. <h3 class="name" id="referenceNode" translate="no">.<a href="#referenceNode">referenceNode</a><span class="type-signature"> : <a href="ReferenceBaseNode.html">ReferenceBaseNode</a></span> </h3>
  145. <div class="description">
  146. <p>Similar to <a href="ReferenceBaseNode.html#reference">ReferenceBaseNode#reference</a>, an additional
  147. property references to the current node.<br/>Default is <code>null</code>.</p>
  148. </div>
  149. </div>
  150. <div class="member">
  151. <h3 class="name" id="referenceNode" translate="no">.<a href="#referenceNode">referenceNode</a><span class="type-signature"> : <a href="ReferenceNode.html">ReferenceNode</a></span> </h3>
  152. <div class="description">
  153. <p>Similar to <a href="ReferenceNode.html#reference">ReferenceNode#reference</a>, an additional
  154. property references to the current node.<br/>Default is <code>null</code>.</p>
  155. </div>
  156. </div>
  157. <h2 class="subsection-title">Methods</h2>
  158. <h3 class="name name-method" id="getNodeType" translate="no">.<a href="#getNodeType">getNodeType</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  159. <div class="method">
  160. <div class="description">
  161. <p>This method is overwritten since the node type is inferred from
  162. the uniform type of the reference node.</p>
  163. </div>
  164. <dl class="details">
  165. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ArrayElementNode.html#getNodeType">ArrayElementNode#getNodeType</a></dt>
  166. </dl>
  167. <dl class="details">
  168. <dt class="tag-returns"><strong>Returns:</strong> The node type.</dt>
  169. </dl>
  170. </div>
  171. <h3 class="name name-method" id="getNodeType" translate="no">.<a href="#getNodeType">getNodeType</a><span class="signature">()</span><span class="type-signature"> : string</span> </h3>
  172. <div class="method">
  173. <div class="description">
  174. <p>This method is overwritten since the node type is inferred from
  175. the uniform type of the reference node.</p>
  176. </div>
  177. <dl class="details">
  178. <dt class="tag-overrides"><strong>Overrides:</strong> <a href="ArrayElementNode.html#getNodeType">ArrayElementNode#getNodeType</a></dt>
  179. </dl>
  180. <dl class="details">
  181. <dt class="tag-returns"><strong>Returns:</strong> The node type.</dt>
  182. </dl>
  183. </div>
  184. <h2 class="subsection-title">Source</h2>
  185. <p>
  186. <a href="https://github.com/mrdoob/three.js/blob/master/src/nodes/accessors/ReferenceNode.js" target="_blank" rel="noopener" translate="no">src/nodes/accessors/ReferenceNode.js</a>
  187. </p>
  188. </article>
  189. </section>
  190. <script src="../scripts/linenumber.js"></script>
  191. <script src="../scripts/page.js"></script>
  192. </body>
  193. </html>
粤ICP备19079148号