AnimEnum Class Reference

A callback class for Animatable::EnumAnimTree(). More...

#include <AnimEnum.h>

Inheritance diagram for AnimEnum:

Public Member Functions
	AnimEnum (int s=SCOPE_OPEN, int deep=0, DWORD tv=0xffffffff)
	Constructor. More...
virtual	~AnimEnum ()
	Destructor. More...
void	SetScope (int s)
	Implemented by the System. More...
int	Scope ()
	Implemented by the System. More...
void	IncDepth ()
	Implemented by the System. More...
void	DecDepth ()
	Implemented by the System. More...
int	Depth ()
	Implemented by the System. More...
DWORD	TVBits ()
virtual int	proc (Animatable *anim, Animatable *client, int subNum)=0
	This is the method called by EnumAnimTree(). More...

Protected Attributes
int	depth
int	scope
DWORD	tv

Additional Inherited Members
Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...
static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...
static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, int block_type, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, const char *filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...
static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...
static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...
static UtilExport void	operator delete (void *ptr, void *placement_ptr)
	Placement delete operator. More...
static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...
static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...
static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Detailed Description

A callback class for Animatable::EnumAnimTree().

This class automatically keeps track of the depth of the enumeration.

See also

class Animatable

Constructor & Destructor Documentation

AnimEnum()

AnimEnum ( int  s = SCOPE_OPEN, int  deep = 0, DWORD  tv = 0xffffffff  )

inline

Constructor.

Sets default scope and depth if specified.

Returns

A new AnimEnum object.

            {scope = s; depth = deep; this->tv = tv;}

~AnimEnum()

virtual ~AnimEnum ( )

inlinevirtual

Destructor.

{;}

Member Function Documentation

SetScope()

void SetScope ( int  s )

inline

Implemented by the System.

Sets the scope. See below for possible values.

Parameters

s	Specifies the scope to set. See below.

{ scope = s; }

Scope()

int Scope ( )

inline

Implemented by the System.

Returns the scope.

Returns

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)

{ return scope; }

IncDepth()

void IncDepth ( )

inline

Implemented by the System.

Increments the depth count.

{ depth++; }

DecDepth()

void DecDepth ( )

inline

Implemented by the System.

Decrements the depth count.

{ depth--; }

Depth()

int Depth ( )

inline

Implemented by the System.

Returns the depth count.

{ return depth; }

TVBits()

DWORD TVBits ( )

inline

{return tv;}

proc()

virtual int proc ( Animatable *  anim, Animatable *  client, int  subNum  )

pure virtual

This is the method called by EnumAnimTree().

Parameters

anim	The sub anim.
client	The client anim. This is the parent with a sub-anim of anim.
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.

Returns

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.

Implemented in ClearAnimFlagEnumProc.

Member Data Documentation

depth

int depth

protected

scope

int scope

protected

tv

DWORD tv

protected