ClearAnimFlagEnumProc Class Reference

Search for all occurrences

---

Detailed Description

An animatable enumerator for clearing flags.

#include <AnimEnum.h>

Inheritance diagram for ClearAnimFlagEnumProc:

List of all members.

Public Member Functions
	ClearAnimFlagEnumProc (DWORD f)
	Constructor.
int	proc (Animatable *anim, Animatable *client, int subNum)
	This is the method called by EnumAnimTree().

---

Constructor & Destructor Documentation

ClearAnimFlagEnumProc

(

DWORD

f

)

[inline]

Constructor.

        : flag(f)
    {
        // empty
    }

---

Member Function Documentation

int proc	(	Animatable *	anim,
		Animatable *	client,
		int	subNum
	)		[inline, virtual]

Search for all occurrences

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.

Implements AnimEnum.

    {
        UNUSED_PARAM(client);
        UNUSED_PARAM(subNum);
        anim->ClearAFlag(flag);
        return ANIM_ENUM_PROCEED;
    }