Chapter 288: AnimationObjectGroup

Core Idea

A group of objects that receives a shared animation state.

Usage:

• Add objects you would otherwise pass as 'root' to the constructor or the .clipAction method of AnimationMixer.
• Instead pass this object as 'root'.
• You can also add and remove objects later when the mixer is running.

Note:

• Objects of this class appear as one object to the mixer, so cache control of the individual objects must be done on the group.

Limitation:

• The animated properties must be compatible among the all objects in the group.
• A single property can either be controlled through a target group or directly, but not both.

Key Concepts

• isAnimationObjectGroup : boolean (readonly): This flag can be used for type testing.
• uuid : string (readonly): The UUID of the 3D object.

Reference Tables

Constructor

Signature
new AnimationObjectGroup( …arguments : Object3D )

Properties

Property	Description
.isAnimationObjectGroup : boolean (readonly)	This flag can be used for type testing.
.uuid : string (readonly)	The UUID of the 3D object.

Methods

Method	Description
.add( …arguments : Object3D )	Adds an arbitrary number of objects to this animation group.
.remove( …arguments : Object3D )	Removes an arbitrary number of objects to this animation group
.uncache( …arguments : Object3D )	Deallocates all memory resources for the passed 3D objects of this animation group.

Key Takeaways

1. Most relevant properties: isAnimationObjectGroup, uuid.
2. Key methods: add, remove, uncache.

Connects To

• Source: src/animation/AnimationObjectGroup.js