Animatable.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 "CoreExport.h"
// for base classes
#include "Noncopyable.h"
#include "baseinterface.h"
// for members
#include "autoptr.h"
#include "strclass.h"
#include "AnimPropertyList.h"
#include "interval.h"
#include "TrackHitRecord.h"
// cannot forward declare a Rect, because it gets confused with the windows Rect.
#include "box2.h"
#include "svcore.h"
#include "FileEnumConstants.h"
#include "ParamDimension.h"
// Includes for constants used with the Animatable Class
#include "TrackFlags.h"
#include "SysNodeContext.h"
#include "EditParamFlags.h"
#include "AnimatableFlags.h"
#include "AnimatableInterfaceIDs.h"

// forward declarations
class IObjParam;
class AnimEnum;
class BitArray;
class TimeMap;
class TrackClipObject;
class NoteTrack;
class AssetEnumCallback;
class INodeTab;
class AppDataChunk;
class IParamBlock2;
class ISave;
class ILoad;
class ICustAttribContainer;
class ParamBlockDesc2;

typedef UINT_PTR AnimHandle;

//
// This solves an incompatibility between projects compiled with /clr and without.  
// Under /clr, _M_CEE is defined and the windows header files define GetClassName 
// as an inline function.  Without /clr, the windows headers define GetClassName 
// as a macro, expanding to either GetClassNameA or GetClassNameW.  The macro 
// affects Animatable's interface by replacing its GetClassName function, which 
// then causes symbol mismatches at link time.  For compilations without /clr, the 
// following code eliminates the macro and replaces it with the inline function 
// defined by the window headers for /clr builds.  The code is copied from 
// winuser.h.
//
#ifdef GetClassName
#undef GetClassName
#endif
#ifndef _M_CEE
__inline
int
GetClassName(
             HWND hWnd,
             LPTSTR lpClassName,
             int nMaxCount
             )
{
#ifdef UNICODE
    return GetClassNameW(
#else
    return GetClassNameA(
#endif
        hWnd,
        lpClassName,
        nMaxCount
        );
}
#endif

#pragma warning(push)
#pragma warning(disable:4100)
class Animatable : public InterfaceServer, public MaxSDK::Util::Noncopyable
{
        friend class ISaveImp;
        friend class ILoadImp;

    public: 

        class EnumAnimList: public MaxHeapOperators {
        public:
            virtual ~EnumAnimList() {;}

            virtual bool proc(Animatable *theAnim)=0;
        };

    private:
        class AnimatableImplData;
        const MaxSDK::Util::AutoPtr<AnimatableImplData> mAnimatableImplData;
        DWORD tvflags1, tvflags2;
        DWORD aflag_ex;

    protected:
        DWORD aflag;
        AnimPropertyList aprops;




        CoreExport virtual ~Animatable() = 0;

    public: 
        CoreExport Animatable();


        CoreExport virtual void DeleteThis();




        virtual void GetClassName(MSTR& s) { s = _M("Animatable"); }  


        CoreExport virtual SClass_ID SuperClassID() = 0;


        CoreExport virtual Class_ID ClassID();


        CoreExport static AnimHandle GetHandleByAnim( Animatable* anim );


        CoreExport static Animatable* GetAnimByHandle( AnimHandle handle );


        void SetAFlag(DWORD mask) { 
            aflag |= mask; 
        }

        void ClearAFlag(DWORD mask) { 
            aflag &= ~mask; 
        }


        BOOL TestAFlag(DWORD mask) { 
            return (aflag & mask ? TRUE : FALSE); 
        }


        void SetAFlagEx(DWORD mask) { 
            aflag_ex |= mask; 
        }


        void ClearAFlagEx(DWORD mask) { 
            aflag_ex &= ~mask; 
        }


        BOOL TestAFlagEx(DWORD mask) { 
            return (aflag_ex & mask ? TRUE : FALSE); 
        }


        CoreExport static int RequestFlagBit();
        

        CoreExport static void ReleaseFlagBit(int index);
        

        CoreExport bool TestFlagBit(int index);