XMLAnimTreeEntry.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.
//**************************************************************************/
// FILE:        XMLAnimTreeEntry.h
// DESCRIPTION: Interface to Load Save Animation Interfaces
// AUTHOR:      Michael Zyracki 
// HISTORY:     created 2005
//***************************************************************************/
#pragma once

#include "export.h"
#include "ifnpub.h"
#include "ref.h"




#define EXPOSE_WORLD_TRANSFORM_SCLASS_ID 0x7f765e27


#define EXPOSE_WORLD_TRANSFORM_CLASS_ID Class_ID(0x7f765e27, 0x13e613a0) 


 

class XMLAnimTreeEntryList;
class XMLAnimLabelWindow;
class XMLAnimMapDlg;
class AnimFileLoader;
class XMLAnim;
class AnimFileCreator;

#define XMLANIMTREEENTRY_INTERFACE  Interface_ID(0x5d25abd, 0x36934bff)


class XMLAnimTreeEntry : public FPMixinInterface
{
    friend class XMLAnimTreeEntryList;
    friend class XMLAnimLabelWindow;
    friend class XMLAnimMapDlg;
    friend class AnimFileLoader;
    friend class AnimFileCreator;
    friend class XMLAnim;
    friend class XMLTreeListEnum;
    friend class XMLAnimTreeEntryImp;

public:
    
    enum Type {eNone = 0x0, eTransform = 0x1, eBaseObject = 0x2, eModObject = 0x4, eNoteTracks = 0x8, 
    eVisTracks = 0x10, eMatMaps = 0x20, eMatParams = 0x40, eCustomAttributes = 0x80, 
    eIK = 0x100, ePos = 0x200,eRot =0x400, eScale = 0x800, ePosX = 0x1000,
    ePosY = 0x2000, ePosZ = 0x4000,eList = 0x8000,eKeyable = 0x10000,eRotX = 0x20000,eRotY = 0x40000,eRotZ = 0x80000,
    eScaleX = 0x100000,eScaleY = 0x200000,eScaleZ = 0x400000,eExposeWorldTransform = 0x800000,eLayer = 0x1000000};

    DllExport Animatable *GetAnim()const {return anim;}
    
    DllExport Animatable *GetClient() const{return client;}
    
    DllExport int GetSubNum()const{return subNum;}
    
    DllExport const MCHAR *GetName()const {return name.data();}
    
    DllExport int GetUnique()const {return unique;}
    
    DllExport const MCHAR *GetMapName()const{return  mapName.data();}
    
    DllExport int GetMapUnique()const {return mapUnique;}

    DllExport bool IsType(int type) const;
    
    
    DllExport unsigned int GetType()const{return type;}

    enum { getAnim,getClient,getSubNum,getName,getUnique,getMapName,getMapUnique,isType};
    // Function Map
    BEGIN_FUNCTION_MAP
        RO_PROP_FN(getAnim, GetAnimRef, TYPE_REFTARG);
        RO_PROP_FN(getClient, GetClientRef, TYPE_REFTARG);
        RO_PROP_FN(getSubNum, GetSubNum, TYPE_INT);
        RO_PROP_FN(getName, GetName, TYPE_STRING);
        RO_PROP_FN(getUnique, GetUnique, TYPE_INT);
        RO_PROP_FN(getMapName, GetMapName, TYPE_STRING);
        RO_PROP_FN(getMapUnique, GetMapUnique, TYPE_INT);
        FN_1(isType, TYPE_bool, IsType,TYPE_ENUM);  
    
    END_FUNCTION_MAP

    //for FP 
    DllExport FPInterfaceDesc* GetDesc();
    LifetimeType LifetimeControl() { return wantsRelease; }
    BaseInterface* AcquireInterface() { return this; }
    DllExport void ReleaseInterface();

private:
    
    DllExport   XMLAnimTreeEntry(Animatable *a, Animatable *c,int s, int d);
    DllExport   XMLAnimTreeEntry(const XMLAnimTreeEntry &entry);

    Animatable *anim;
    Animatable *client;
    int subNum;
    int depth;
    MSTR name; 
    int unique;
    MSTR mapName;
    int mapUnique;
    unsigned int type;
    DWORD flags;
    BOOL selected,mapped; //used in XMLAnimWindow
    int location; //used to specify where it came from the original list, in XMLAnimWindow
    BOOL loadable;//used when loaded in and a child is being loaded, we need to set all the parent/anims, as unloadable
    MSTR className; //name of it's class
    SClass_ID superClassID;
    Class_ID classID;
    MSTR mapClassName;
    MSTR nodeParentName; //only used for nodes!!!!
    MSTR IKBeginNode; //only used for IKControlChain Nodes.
    MSTR IKEndNode;
    MSTR IKSplineNode; //only used by nodes that are dummies that control a spline IK. This is the IKChainControl node
    float distanceToParent;//only fo nodes.
    int numChildren; //subanims or node children


    DllExport int GetParentIndex(XMLAnimTreeEntryList *list, int listIndex);
    DllExport unsigned int GetLocalType();
    DllExport unsigned int IsXYZ();
    DllExport BOOL IsList();
    DllExport bool IsParentOpen(XMLAnimTreeEntryList *list, int listIndex);
    DllExport MSTR StripNodeFromName(); //TODO make sure we handle nodeless entries


    //FP functions and info
    DllExport ReferenceTarget* GetAnimRef() {return dynamic_cast<ReferenceTarget*>(anim);} // This needs to be deinlined.
    DllExport ReferenceTarget* GetClientRef() {return dynamic_cast<ReferenceTarget*>(client);} // This needs to be deinlined.

};



#define XMLANIMTREEENTRYLIST_INTERFACE  Interface_ID(0x34d56bf5, 0x1b2a7c80)



class XMLAnimTreeEntryList : private Tab<XMLAnimTreeEntry*>,public FPMixinInterface     
{
    friend class XMLAnimTreeEntry;
    friend class XMLAnimLabelWindow;
    friend class XMLAnimMapDlg;
    friend class AnimFileLoader;
    friend class AnimFileCreator;
    friend class XMLAnim;   
    friend class XMLTreeListEnum;
    friend class XMLAnimTreeEntryListImp;
public: 

    DllExport XMLAnimTreeEntryList();
    DllExport ~XMLAnimTreeEntryList();


    
    DllExport XMLAnimTreeEntry* operator[](const int index);

    DllExport int Count() const;
    
    DllExport void ZeroCount();
    
    DllExport void Shrink();
    

    DllExport int Delete(int start,int num) ;
    
    DllExport void DeleteData();


    DllExport int FindAnim(Animatable *anim,int start=0);

    
    // !\param[in] which XMLAnimTreeEntry you want to find
    // !\return The index where the entry is, -1 if not found
    DllExport int Find(XMLAnimTreeEntry *which);

    // \brief Find this particular XMLAnimTreeEntry based off it's name and unique id.
    
    // !param[in] name The name of the track you want to find
    // !param[in] unique Whether or not the track is unique
    // !\return The index where the entry is, -1 if not found
    DllExport int Find(MSTR &name, int unique);

    // !\brief Find the subAnim parents of the specified item.

    DllExport void FindParents(int index,Tab<int> &parentIndices);


    DllExport void FindChildren(int index,Tab<int> &childIndices);


    //FP stuff
    enum { getEntry,count,zeroCount,shrink,deleteItems,findAnim,findName};
    // Function Map
    BEGIN_FUNCTION_MAP  
        FN_1(getEntry, TYPE_INTERFACE, GetEntry,TYPE_INT);
        FN_0(count,TYPE_INT,Count);
        VFN_0(zeroCount,ZeroCount);
        VFN_0(shrink,Shrink);
        FN_2(deleteItems,TYPE_INT,Delete,TYPE_INT,TYPE_INT);
        FN_2(findAnim,TYPE_INT,FindAnimFP,TYPE_REFTARG,TYPE_INT);
        FN_2(findName,TYPE_INT,FindNameFP,TYPE_STRING,TYPE_INT);
    
    END_FUNCTION_MAP

    //for 
    DllExport FPInterfaceDesc* GetDesc();
    LifetimeType LifetimeControl() { return wantsRelease; }
    BaseInterface* AcquireInterface() { return this; }
    DllExport void ReleaseInterface();

    
private:
    //fp stuff
    FPInterface* GetEntry(const int index);
    int FindAnimFP(ReferenceTarget *anim,int start);
    int FindNameFP(MCHAR *name,int unique);

    int curSel;
    DllExport void Build(   Animatable *root);
    DllExport MSTR GetName(XMLAnimTreeEntry *entry, int listIndex);
    DllExport void SetNameTypeUnique(XMLAnimTreeEntry* entry,int index);

    DllExport void DeleteSubtree(int index);
    DllExport void RecalcSubtree(int index,DWORD flags=0);

    DllExport void AppendEntry(XMLAnimTreeEntry &entry);
    DllExport void InsertEntry(int where,XMLAnimTreeEntry &entry);

    DllExport BOOL IsTextSelected(int index);
    DllExport void ClearSelectText();

    DllExport void GetSelected(Tab<XMLAnimTreeEntry*> &selected);
    DllExport void GetAll(Tab<XMLAnimTreeEntry*>&all);
    DllExport void SelectByWildCard(MCHAR *buf);
    DllExport void SelectText(int index,BOOL sel,BOOL range=FALSE,BOOL column=FALSE);
    DllExport int FindSelectText();
    DllExport void SelectItemText(int index);
    DllExport void SelectAllText();
    DllExport void SelectInvertText();
    DllExport void SelectChildrenText(int index);

    DllExport void AddWorldTransformEntry(MSTR &nodeName,int where);

    DllExport int LineCount();
    DllExport int MaxDepth();

    DllExport int EntryRealDepth(int i);
    DllExport int RealMaxDepth();
    DllExport void MarkParentsFromListAsUnloadable(int index);
    DllExport void MarkParentsAndChildrenAsMapped(BOOL mapped,int index);
    DllExport void MarkParentsAndParentsChildrenAsMapped(BOOL mapped,int index);
    DllExport bool AreAnyChildrenMapped(int index);

    DllExport void FindAllParentNodes(int index,Tab<int> &nodeParents); //find all of the parent nodes
    DllExport void FindAllChildNodes(int index,Tab<int> &nodeChildren); //find all of the child nodes
    DllExport void FindChildNodes(int index,Tab<int> &nodeChildren); //find just the direct child nodes
    DllExport void SetMapInfo(BOOL mapped,int which, MSTR &mapName, int mapUnique);

};

#define NODEANDANIMS_INTERFACE  Interface_ID(0x4ad13c9b, 0x3ca97bec)



class NodeAndAnims : public FPMixinInterface
{
    friend class XMLAnimLabelWindow;
    friend class XMLAnimMapDlg;
    friend class AnimFileLoader;
    friend class AnimFileCreator;
    friend class XMLAnim;   
    friend class NodeAndAnimsImp;
    friend class ILoadSaveAnimation_Imp;
public:
    NodeAndAnims():node(NULL),IKNodeName(NULL),list(NULL){};

    DllExport NodeAndAnims(const NodeAndAnims &);
    
    DllExport XMLAnimTreeEntryList *GetList()const {return list;}
    
    DllExport INode *GetNode()const {return node;}
    
    DllExport void DeleteThis();

    enum { getList,getNode};
    #pragma warning(push)
    #pragma warning(disable:4100)
    BEGIN_FUNCTION_MAP  
        FN_0(getList, TYPE_INTERFACE,GetListFP);
        FN_0(getNode,TYPE_INODE,GetNode);
    END_FUNCTION_MAP
    #pragma warning(pop)
    // function map use
    DllExport FPInterfaceDesc* GetDesc();
    LifetimeType LifetimeControl() { return wantsRelease; }
    BaseInterface* AcquireInterface() { return this; }
    DllExport void ReleaseInterface();

private:

    INode *node; //node may be NULL!
    MSTR *IKNodeName;//name of the IK Node that this node may implicitly control, e.g a spline IK helper
    //node would have the name of the .. may be NULL!
    XMLAnimTreeEntryList *list;

    DllExport FPInterface *GetListFP();
};