AnimationObjectGroup.html 2.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <base href="../../../" />
  6. <script src="page.js"></script>
  7. <link type="text/css" rel="stylesheet" href="page.css" />
  8. </head>
  9. <body>
  10. <h1>[name]</h1>
  11. <p class="desc">A group of objects that receives a shared animation state.<br /><br />
  12. For an overview of the different elements of the three.js animation system see the
  13. "Animation System" article in the "Next Steps" section of the manual.
  14. </p>
  15. <h2>Usage:</h2>
  16. <p class="desc">
  17. Add objects you would otherwise pass as 'root' to the constructor or the [page:AnimationMixer.clipAction clipAction]
  18. method of [page:AnimationMixer AnimationMixer] and instead pass this object as 'root'.<br /><br />
  19. Note that objects of this class appear as one object to the mixer,
  20. so cache control of the individual objects must be done on the group.
  21. </p>
  22. <h2>Limitations</h2>
  23. <p class="desc">
  24. The animated properties must be compatible among all objects in the group.<br /><br />
  25. A single property can either be controlled through a target group or directly, but not both.
  26. </p>
  27. <h2>Constructor</h2>
  28. <h3>[name]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
  29. <p>
  30. [page:Object obj] - an abitrary number of meshes that share the same animation state.
  31. </p>
  32. <h2>Properties</h2>
  33. <h3>[property:Object stats]</h3>
  34. <p>
  35. An object that contains some informations of this *AnimationObjectGroup* (total number, number
  36. in use, number of bindings per object)
  37. </p>
  38. <h3>[property:String uuid]</h3>
  39. <p>
  40. The [link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of this
  41. *AnimationObjectGroup*. It gets automatically assigned and shouldn't be edited.
  42. </p>
  43. <h2>Methods</h2>
  44. <h3>[method:null add]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
  45. <p>
  46. Adds an arbitrary number of objects to this *AnimationObjectGroup*.
  47. </p>
  48. <h3>[method:null remove]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
  49. <p>
  50. Removes an arbitrary number of objects from this *AnimationObjectGroup*.
  51. </p>
  52. <h3>[method:null uncache]( [param:Object obj1], [param:Object obj2], [param:Object obj3], ... )</h3>
  53. <p>
  54. Deallocates all memory resources for the passed objects of this *AnimationObjectGroup*.
  55. </p>
  56. <h2>Source</h2>
  57. <p>
  58. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  59. </p>
  60. </body>
  61. </html>