AnimationObjectGroup.html 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <title>AnimationObjectGroup - 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. <h1 translate="no">AnimationObjectGroup</h1>
  13. <section>
  14. <header>
  15. <div class="class-description"><p>A group of objects that receives a shared animation state.</p>
  16. <p>Usage:</p>
  17. <ul>
  18. <li>Add objects you would otherwise pass as 'root' to the
  19. constructor or the .clipAction method of AnimationMixer.</li>
  20. <li>Instead pass this object as 'root'.</li>
  21. <li>You can also add and remove objects later when the mixer is running.</li>
  22. </ul>
  23. <p>Note:</p>
  24. <ul>
  25. <li>Objects of this class appear as one object to the mixer,
  26. so cache control of the individual objects must be done on the group.</li>
  27. </ul>
  28. <p>Limitation:</p>
  29. <ul>
  30. <li>The animated properties must be compatible among the all objects in the group.</li>
  31. <li>A single property can either be controlled through a target group or directly, but not both.</li>
  32. </ul></div>
  33. </header>
  34. <article>
  35. <div class="container-overview">
  36. <h2>Constructor</h2>
  37. <h3 class="name name-method" id="AnimationObjectGroup" translate="no">new <a href="#AnimationObjectGroup">AnimationObjectGroup</a><span class="signature">( &hellip;arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  38. <div class="method">
  39. <div class="description">
  40. <p>Constructs a new animation group.</p>
  41. </div>
  42. <table class="params">
  43. <tbody>
  44. <tr>
  45. <td class="name">
  46. <strong>arguments</strong>
  47. </td>
  48. <td class="description last">
  49. <p>An arbitrary number of 3D objects that share the same animation state.</p>
  50. </td>
  51. </tr>
  52. </tbody>
  53. </table>
  54. </div>
  55. </div>
  56. <h2 class="subsection-title">Properties</h2>
  57. <div class="member">
  58. <h3 class="name" id="isAnimationObjectGroup" translate="no">.<a href="#isAnimationObjectGroup">isAnimationObjectGroup</a><span class="type-signature"> : boolean</span> <span class="type-signature">(readonly) </span></h3>
  59. <div class="description">
  60. <p>This flag can be used for type testing.</p>
  61. <p>Default is <code>true</code>.</p>
  62. </div>
  63. </div>
  64. <div class="member">
  65. <h3 class="name" id="uuid" translate="no">.<a href="#uuid">uuid</a><span class="type-signature"> : string</span> <span class="type-signature">(readonly) </span></h3>
  66. <div class="description">
  67. <p>The UUID of the 3D object.</p>
  68. </div>
  69. </div>
  70. <h2 class="subsection-title">Methods</h2>
  71. <h3 class="name name-method" id="add" translate="no">.<a href="#add">add</a><span class="signature">( &hellip;arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  72. <div class="method">
  73. <div class="description">
  74. <p>Adds an arbitrary number of objects to this animation group.</p>
  75. </div>
  76. <table class="params">
  77. <tbody>
  78. <tr>
  79. <td class="name">
  80. <strong>arguments</strong>
  81. </td>
  82. <td class="description last">
  83. <p>The 3D objects to add.</p>
  84. </td>
  85. </tr>
  86. </tbody>
  87. </table>
  88. </div>
  89. <h3 class="name name-method" id="remove" translate="no">.<a href="#remove">remove</a><span class="signature">( &hellip;arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  90. <div class="method">
  91. <div class="description">
  92. <p>Removes an arbitrary number of objects to this animation group</p>
  93. </div>
  94. <table class="params">
  95. <tbody>
  96. <tr>
  97. <td class="name">
  98. <strong>arguments</strong>
  99. </td>
  100. <td class="description last">
  101. <p>The 3D objects to remove.</p>
  102. </td>
  103. </tr>
  104. </tbody>
  105. </table>
  106. </div>
  107. <h3 class="name name-method" id="uncache" translate="no">.<a href="#uncache">uncache</a><span class="signature">( &hellip;arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
  108. <div class="method">
  109. <div class="description">
  110. <p>Deallocates all memory resources for the passed 3D objects of this animation group.</p>
  111. </div>
  112. <table class="params">
  113. <tbody>
  114. <tr>
  115. <td class="name">
  116. <strong>arguments</strong>
  117. </td>
  118. <td class="description last">
  119. <p>The 3D objects to uncache.</p>
  120. </td>
  121. </tr>
  122. </tbody>
  123. </table>
  124. </div>
  125. <h2 class="subsection-title">Source</h2>
  126. <p>
  127. <a href="https://github.com/mrdoob/three.js/blob/master/src/animation/AnimationObjectGroup.js" translate="no" target="_blank" rel="noopener">src/animation/AnimationObjectGroup.js</a>
  128. </p>
  129. </article>
  130. </section>
  131. <script src="../scripts/linenumber.js"></script>
  132. <script src="../scripts/page.js"></script>
  133. </body>
  134. </html>
粤ICP备19079148号