| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="utf-8">
- <title>AnimationObjectGroup - Three.js Docs</title>
- <meta name="viewport" content="width=device-width, user-scalable=no, minimum-scale=1.0, maximum-scale=1.0">
- <script src="../scripts/highlight.min.js"></script>
- <link type="text/css" rel="stylesheet" href="../styles/highlight-three.css">
- <link type="text/css" rel="stylesheet" href="../styles/page.css">
- </head>
- <body>
- <h1 translate="no">AnimationObjectGroup</h1>
- <section>
- <header>
- <div class="class-description"><p>A group of objects that receives a shared animation state.</p>
- <p>Usage:</p>
- <ul>
- <li>Add objects you would otherwise pass as 'root' to the
- constructor or the .clipAction method of AnimationMixer.</li>
- <li>Instead pass this object as 'root'.</li>
- <li>You can also add and remove objects later when the mixer is running.</li>
- </ul>
- <p>Note:</p>
- <ul>
- <li>Objects of this class appear as one object to the mixer,
- so cache control of the individual objects must be done on the group.</li>
- </ul>
- <p>Limitation:</p>
- <ul>
- <li>The animated properties must be compatible among the all objects in the group.</li>
- <li>A single property can either be controlled through a target group or directly, but not both.</li>
- </ul></div>
- </header>
- <article>
- <div class="container-overview">
- <h2>Constructor</h2>
- <h3 class="name name-method" id="AnimationObjectGroup" translate="no">new <a href="#AnimationObjectGroup">AnimationObjectGroup</a><span class="signature">( …arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Constructs a new animation group.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>arguments</strong>
- </td>
- <td class="description last">
- <p>An arbitrary number of 3D objects that share the same animation state.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- </div>
- <h2 class="subsection-title">Properties</h2>
- <div class="member">
- <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>
- <div class="description">
- <p>This flag can be used for type testing.</p>
- <p>Default is <code>true</code>.</p>
- </div>
- </div>
- <div class="member">
- <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>
- <div class="description">
- <p>The UUID of the 3D object.</p>
- </div>
- </div>
- <h2 class="subsection-title">Methods</h2>
- <h3 class="name name-method" id="add" translate="no">.<a href="#add">add</a><span class="signature">( …arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Adds an arbitrary number of objects to this animation group.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>arguments</strong>
- </td>
- <td class="description last">
- <p>The 3D objects to add.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <h3 class="name name-method" id="remove" translate="no">.<a href="#remove">remove</a><span class="signature">( …arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Removes an arbitrary number of objects to this animation group</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>arguments</strong>
- </td>
- <td class="description last">
- <p>The 3D objects to remove.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <h3 class="name name-method" id="uncache" translate="no">.<a href="#uncache">uncache</a><span class="signature">( …arguments : <span class="param-type"><a href="Object3D.html">Object3D</a></span> )</span> </h3>
- <div class="method">
- <div class="description">
- <p>Deallocates all memory resources for the passed 3D objects of this animation group.</p>
- </div>
- <table class="params">
- <tbody>
- <tr>
- <td class="name">
- <strong>arguments</strong>
- </td>
- <td class="description last">
- <p>The 3D objects to uncache.</p>
- </td>
- </tr>
- </tbody>
- </table>
- </div>
- <h2 class="subsection-title">Source</h2>
- <p>
- <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>
- </p>
- </article>
- </section>
- <script src="../scripts/linenumber.js"></script>
- <script src="../scripts/page.js"></script>
- </body>
- </html>
|