AnimationObjectGroup.html 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687
  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. <p>
  31. [page:object obj] - an abitrary number of meshes that share the same animation state.
  32. </p>
  33. <h2>Properties</h2>
  34. <h3>[property:object stats]</h3>
  35. <p>
  36. An object that contains some informations of this *AnimationObjectGroup* (total number, number
  37. in use, number of bindings per object)
  38. </p>
  39. <h3>[property:String uuid]</h3>
  40. <p>
  41. The [link:http://en.wikipedia.org/wiki/Universally_unique_identifier UUID] of this
  42. *AnimationObjectGroup*. It gets automatically assigned and shouldn't be edited.
  43. </p>
  44. <h2>Methods</h2>
  45. <h3>[method:null add]( [param:object obj1], [param:object obj2], [param:object obj3], ... )</h3>
  46. <p>
  47. Adds an arbitrary number of objects to this *AnimationObjectGroup*.
  48. </p>
  49. <h3>[method:null remove]( [param:object obj1], [param:object obj2], [param:object obj3], ... )</h3>
  50. <p>
  51. Removes an arbitrary number of objects from this *AnimationObjectGroup*.
  52. </p>
  53. <h3>[method:null uncache]( [param:object obj1], [param:object obj2], [param:object obj3], ... )</h3>
  54. <p>
  55. Deallocates all memory resources for the passed objects of this *AnimationObjectGroup*.
  56. </p>
  57. <h2>Source</h2>
  58. <p>
  59. [link:https://github.com/mrdoob/three.js/blob/master/src/[path].js src/[path].js]
  60. </p>
  61. </body>
  62. </html>