AnimEnum.h

Go to the documentation of this file.

//**************************************************************************/
// Copyright (c) 1998-2006 Autodesk, Inc.
// All rights reserved.
// 
// These coded instructions, statements, and computer programs contain
// unpublished proprietary information written by Autodesk, Inc., and are
// protected by Federal copyright law. They may not be disclosed to third
// parties or copied or duplicated in any form, in whole or in part, without
// the prior written consent of Autodesk, Inc.
//**************************************************************************/
#pragma once

#include <WTypes.h>
#include "maxheap.h"
#include "Animatable.h"

// Callback for EnumAnimTree:
//
// Scope values:

#define SCOPE_DOCLOSED 1        //!< Enumerate "closed" animatables.
#define SCOPE_SUBANIM  2        //!< Enumerate sub-anims 
#define SCOPE_CHILDREN 4        //!< Enumerate node children
#define SCOPE_OPEN  (SCOPE_SUBANIM|SCOPE_CHILDREN) //!< Enumerate all open animatables
#define SCOPE_ALL   (SCOPE_OPEN|SCOPE_DOCLOSED)     //!< do all animatables

// Return values for AnimEnum procs
#define ANIM_ENUM_PROCEED 1     
#define ANIM_ENUM_STOP    2
#define ANIM_ENUM_ABORT   3

// R5 and later only
#define ANIM_ENUM_SKIP    4   //!< Do not include this anim in the hierarchy.
#define ANIM_ENUM_SKIP_NODE 5 //!< Do not include this node and its subAnims, but include its children.

class AnimEnum: public MaxHeapOperators {
    protected:
        int depth;
        int scope;  
        DWORD tv;
    public:
        AnimEnum(int s = SCOPE_OPEN, int deep = 0, DWORD tv=0xffffffff) 
            {scope = s; depth = deep; this->tv = tv;}
        virtual ~AnimEnum() {;}
        void SetScope(int s) { scope = s; }
        int Scope() { return scope; }
        void IncDepth() { depth++; }
        void DecDepth() { depth--; }
        int Depth() { return depth; }
        DWORD TVBits() {return tv;}
        virtual int proc(Animatable *anim, Animatable *client, int subNum)=0;
    };

class ClearAnimFlagEnumProc : public AnimEnum
{
    DWORD flag;
public:
    ClearAnimFlagEnumProc(DWORD f)
        : flag(f)
    {
        // empty
    }
    int proc(Animatable* anim, Animatable* client, int subNum)
    {
        UNUSED_PARAM(client);
        UNUSED_PARAM(subNum);
        anim->ClearAFlag(flag);
        return ANIM_ENUM_PROCEED;
    }
};