HHashObj.h

Go to the documentation of this file.

// BC  1/12/2005  \BobL120\Include\SDK\HHashObj.h

#define __HHASHOBJ_H

#ifndef _SMALLPDB

#ifndef __HASHTIME_H
#include "HashTime.h"
#endif

#ifndef __QUATERNI_H
#include "Quaterni.h"
#endif

#ifndef __ROTATE_H
#include "Rotate.h"
#endif

#ifndef __PATCHID_H
#include "PatchID.h"
#endif

#ifndef __RGBFLOAT_H
#include "RGBFloat.h"
#endif

#ifndef __OBJTYPE_H
#include "ObjType.h"
#endif

#ifndef __IEMODEL_H
#include "IEModel.h"
#endif

#ifndef __TIMERANG_H
#include "TimeRang.h"
#endif

#ifndef __FILECONS_H
enum { SMPTE, FRAMES, CELS };
#endif

/**********************************************************
HTreeObject
   HAnimObject
      HCP   - HPC.h
         HHookCP - HCP.h
      HHashObject
         HPropertyDriver - HPropDri.h
            HAttrDriver -
            HBiasDriver
            HConstDriver
            HPropertyShortcut
            HFloatDriver
               HChannelDriver
            HRelationMDShortcut
            HRotateDriver
               HEulerRotateDriver
               HQuaternionRotateDriver
               HVectorRotateDriver
            HTransformDriver
            HVectorDriverNoSubs
            HVector2Driver
         HProperty - HPropert.h
            HBiasProperty
            HBoolProperty
            HContainerProperty
               HAttrProperty
               HFileInfoProperty
               HCategoryProperty
                  HBoolCategoryProperty
                  HTypeCategoryProperty
            HFloatProperty
               HPercentProperty
            HIntProperty
            HRotateProperty
            HStringProperty
               HFilenameProperty
            HTimeProperty
            HTransformProperty
            HTypeProperty
            HVectorProperty
               HColorProperty
               HScaleProperty
               HTranslateProperty
            HVectorPropertyNoSubs
            HVector2Property
            HPointerProperty
               HBitmapProperty
         HGroupCP - HCP.cpp
         HGroup   - HCP.cpp
         HGroupContainer - HCP.CPP
         HBoneCacheContainer
         HBoneCache - HModel.cpp
            HObjectCache
               HSegmentCache
                  HModelCache
               HCamerCache
               HPropCache
               HFXCache
                  HForceCache
                  HMatFXCache
                  HVolFXCache
                     HLightCache
         HLightCacheContainer                     
         HBoneContainer
         HBone
            HObject
               HSegment
                  HModel
               HCamera
               HProp
               HFX
                  HForce
                  HMatFX
                  HVolFX
                     HLight
         HLightContainer
         HClip
            HBitmap
               HDecal
         HDecalClip
         HDecalClipContainer
         HDecalStamp
         HDecalStampContainer
         HDecalContainer
         HRelationContainer
         HRelation
         HActionCache
            HRelationKey
         HAction
         HObjectCacheContainer
         HActionCacheContainer
         HChor
         HProject
         HAnimObjectShortcut
         HSplineContainer
      HSPline
HPatch
   HPatch5
HChannelCP
HProgressBar
HPropertyInfo
   HBiasPropertyInfo
   HBoolPropertyInfo
   HAttrPropertyInfo
   HFileInfoPropertyInfo
   HFloatPropertyInfo
      HPercentPropertyInfo
   HIntPropertyInfo
   HRotatePropertyInfo
   HStringPropertyInfo
      HFilenamePropertyInfo
   HTimePropertyInfo
   HTransformPropertyInfo
   HTypePropertyInfo
   HVectorPropertyInfo
      HColorPropertyInfo
      HScalePropertyInfoInfo
      HTranslatPropertyInfo
   HVectorPropertyNoSubsInfo
   HVector2PropertyInfo
   HPointerPropertyInfo
HTypeInfo   
**********************************************************/

class HProperty;
class HAnimObject;
class HBone;
class HCategoryProperty;
class HUserCategoryProperty;
class HHashObject;
class HashStream;
class HAnimObjectShortcut;
class HPropertyDriver;

//*********************************************************
//** HTreeObject
//*********************************************************
class PLUGINEXPORT HTreeObject 
{
public:
// Retrieval   
   HProperty *GetPropertyAt( int i );
   ObjectType GetObjectType();
   int GetType();
   
   void  operator delete( void *ptr ) { DeleteHandle( (HTreeObject *)ptr ); }
   static void DeleteHandle(HTreeObject *handle);
   
   BOOL IsModified();
   void OnModified();
   HTreeObject *FindChildByName( char *matchname );
   HTreeObject *FindChildByTreeName( char *treename );
   void ExpandInProjectBar(BOOL expand);
   void RefreshInProjectBar( BOOL updatenow=FALSE );
   void HilightInProjectBar();
      
   // These 3 functions allow to walk the complete tree hierarchy and skip possible objects based on paramatwers passed in
   enum Skip { SKIPNONE=0x00, SKIPINVISIBLE=0x01, SKIPFILTERED=0x02, SKIPADVANCED=0x04, SKIPFOLDERS=0x08 };
   HTreeObject *GetTreeParent( UINT skip=SKIPINVISIBLE|SKIPFILTERED );
   HTreeObject *GetTreeProgeny( UINT skip=SKIPINVISIBLE|SKIPFILTERED );
   HTreeObject *GetTreeSibling( UINT skip=SKIPINVISIBLE|SKIPFILTERED );
   
   HTreeObject *GetParent(); // Skips user containers, and doesn't include classes not derived off HashObject (CPs)//
   void SetParent(HTreeObject *parent);
   void ReassignPtr( void *ptruplink, HTreeObject *newvalue );
   HAnimObject *GetAnimObject();
   HAnimObject *GetAnimObjectNotProperty();
   
   String GetMatchName();
   String GetFileName();
   String GetFullName();

   HBone *IsBone(); //returns this as an HBone if it is one, or NULL;
   BOOL IsActionObjectChild();
   
   void InterpolateObjects( Time time, BOOL notify=TRUE );
   void Interpolate( Time time, BOOL notify=TRUE );
   void OffInterpolate( HProperty *dueto );
   
   HHashObject *IsHashObject();
   HAnimObjectShortcut *IsAnimObjectShortcut();
   HPropertyDriver *IsPropertyDriver();
   
   BOOL Save( HashStream &hs );
   void SetVisible(BOOL visible);

   void SetTempBit( BOOL state );
   BOOL GetTempBit();
   
   HProperty *IsProperty();
};

class HObject;
//*********************************************************
//** HAnimObject
//*********************************************************
class PLUGINEXPORT HAnimObject : public HTreeObject
{  
public:
   
   BOOL IsCache();
   HAnimObject *GetCache();// will return it self if it is the cache
   Time GetFirstKey( BOOL *isselected=NULL );
   Time GetLastKey();
   Time GetNextKey( Time time, BOOL *isselected=NULL );
   Time GetPrevKey( Time time );
   BOOL IsKey( Time time );
   int  CountKeys();
   BOOL DeleteKey( Time time, BOOL storeundo = TRUE );
   BOOL Reduce( float error );
   void DeleteKeys( TimeRange range );
   void TransformKeys( TimeRange range, float scale, Time offset, BOOL issnaptoint );
   void RemoveDrivers();
   
   HObject *GetObject();
   HObject *GetActionObject();
};

//*********************************************************
//** HHashObject
//*********************************************************
class PLUGINEXPORT HHashObject : public HAnimObject
{
public:
// Retrieval
   char *GetName();
   void SetName(const char *name);
   ObjectType GetObjectType(); // Only here for backward compatibility (It is now in HTreeObject)
   BOOL IsKindOfBoneCache();
   
// Hierachy
   HHashObject *GetChild(); // Skips user containers, and doesn't include classes not derived off HashObject (CPs)//
   void SetChild(HHashObject *child);
   HHashObject *GetSibling(); // Skips user containers, and doesn't include classes not derived off HashObject (CPs)//
   void SetSibling(HHashObject *sibling);
   HHashObject *GetSiblingSame(); // Skips user containers, and doesn't include classes not derived off HashObject (CPs)//
   HHashObject *GetParentOfType(ObjectType ot); // Skips user containers, and doesn't include classes not derived off HashObject (CPs)//
   HHashObject *GetHeadInstance();
   HHashObject *GetNextInstance(HHashObject *instance);
   HCategoryProperty *GetPluginProperties();
   HUserCategoryProperty *CreateUserCategoryProperty(); // will return the User Properrties if it already exists
   HUserCategoryProperty *GetUserCategoryProperty();
   
   void InsertChildAtTail( HHashObject *child, BOOL modify = TRUE );
   void InsertChildAtHead( HHashObject *child );
   void InsertChildAtTailOfType( HHashObject *child );
   void InsertChildAtHeadOfType( HHashObject *child );
   void InsertChildAfterObject( HHashObject *child, HHashObject *after );
   void InsertChildAlpha( HHashObject *child, BOOL modify=TRUE );
   void InsertChildOfTypeAlpha( HHashObject *child );
   void InsertSibling( HHashObject *child );
   
   void Unstitch();
   void UnstitchWithChildren(BOOL markparentmodified = TRUE);
   void Move( HHashObject *parent, HHashObject *oldersibling, BOOL select=TRUE, BOOL markparentmodified=TRUE );
   void MoveWithChildren( HHashObject *parent, HHashObject *oldersibling, BOOL select=TRUE, BOOL markparentmodified=TRUE );
   void MarkViewsNeedDrawn();
};

//*********************************************************
//** HAnimObjectShortcut
//*********************************************************
class PLUGINEXPORT HAnimObjectShortcut : public HHashObject
{
public:
   static HAnimObjectShortcut *New(const char *name, BOOL isforrelation);
   HAnimObject *GetAnimObject();
   
   HAnimObjectShortcut *MakeCopy();
   void Copy(HAnimObjectShortcut *other);
};

#endif

---