AnimationObjectGroup.html 2.5 KB

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