Class AnimEnum
See Also: Class Animatable.
class AnimEnum
Description:
This class is the callback object for Animatable::EnumAnimTree(). This keeps track of the depth of the enumeration.
Methods:
Prototype:
virtual int proc(Animatable *anim, Animatable *client, int subNum)=0;
Remarks:
Implemented by the Plug-In.
This is the method called by EnumAnimTree().
Parameters:
Animatable *anim
The sub anim.
Animatable *client
The client anim. This is the parent with a sub-anim of anim.
int subNum
The index of the sub-anim that anim is to client. For example, if you were to call client->SubAnim(subNum) it would return anim.
Return Value:
One of the following values:
ANIM_ENUM_PROCEED
Continue the enumeration process.
ANIM_ENUM_STOP
Stop the enumeration process at this level.
ANIM_ENUM_ABORT
Abort the enumeration processing.
Prototype:
AnimEnum(int s = SCOPE_OPEN, int deep = 0)
Remarks:
Constructor. Sets default scope and depth if specified.
Return Value:
A new AnimEnum object.
Prototype:
void SetScope(int s)
Remarks:
Implemented by the System.
Sets the scope. See below for possible values.
Parameters:
int s
Specifies the scope to set. See below.
Prototype:
int Scope()
Remarks:
Implemented by the System.
Returns the scope.
Return Value:
One or more of the following scope values:
SCOPE_DOCLOSED
Do closed animatables.
SCOPE_SUBANIM
Do the sub anims
SCOPE_CHILDREN
Do the node children
SCOPE_OPEN
Do all open animatables
Equal to (SCOPE_SUBANIM|SCOPE_CHILDREN)
SCOPE_ALL
Do all animatables.
Equal to (SCOPE_OPEN|SCOPE_DOCLOSED)
Prototype:
void IncDepth()
Remarks:
Implemented by the System.
Increments the depth count.
Prototype:
void DecDepth()
Remarks:
Implemented by the System.
Decrements the depth count.
Prototype:
int Depth()
Remarks:
Implemented by the System.
Returns the depth count.