ReferenceElementNode.html 10 KB

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