HCP.h

Go to the documentation of this file.

// BC  12/1/2004  \BobL120\Include\SDK\HCP.h

#define __HCP_H

#ifndef __HHASHOBJ_H
#include "HHashObj.h"
#endif

#ifndef __CPINTERP_H
#include "CPInterp.h"
#endif

#ifndef _SMALLPDB

class HTranslatePropertyNoSubs;
class HBiasProperty;
class HCPInstance;
class HSpline;
class HGroupCP;
class HDecalClip;
class HSegmentCache;
class HCPWeight;

//*********************************************************
//** HCP
//*********************************************************
class PLUGINEXPORT HCP : public HAnimObject
{
public:
   const Vector *GetPosition(); // Position of the CP, includes Muscle, and pose motion, but no Skeletal
   const Vector *GetModelPosition(); // Position of the CP with no motion, raw model data
   const Vector *GetWorldPosition(); // Position of the CP completely transformed
   const Vector *GetScreenPosition(); // Position of the CP completely transformed in world style coordinated, but facing the camera
   
   HCPInstance *GetCPInstance();
   HCPInstance *CreateCPInstance();// will return the instance if it already exists
   
   HSpline *GetSpline();
   HCP *GetNext();
   HCP *GetPrev();
   float GetInGamma();
   float GetInAlpha();
   float GetInMagnitude();
   float GetOutGamma() ;
   float GetOutAlpha() ;
   float GetOutMagnitude();
   Vector GetInTangent();
   Vector GetOutTangent();
   Vector GetModelInTangent();
   Vector GetModelOutTangent();
   Vector GetWorldInTangent();
   Vector GetWorldOutTangent();
   Vector GetScreenInTangent();
   Vector GetScreenOutTangent();
   HCP *GetNextAttached();
   HCP *GetPrevAttached();
   HCP *GetHead();
   HCPWeight *GetCPWeightHead(); //if walking through all cps should only be called when hcp == hcp->GetHead()
   BOOL AddToGroup( HGroupCP **gh);
   BOOL AddStackToGroup( HGroupCP **gh);
   void SetPosition( Vector *p ); // Sets the model position
   void SetInGamma(float fValue);
   void SetInAlpha(float fValue);
   void SetInMagnitude(float fValue);
   void SetOutGamma(float fValue);
   void SetOutAlpha(float fValue);
   void SetOutMagnitude(float fValue);
   void SetPeaked();
   void SetSmooth();
   void SetHide(BOOL bHide);
   void ComputeInBias(const Vector &goalit, float &alpha, float &gamma, float &magnitude);
   void ComputeOutBias(const Vector &goalot, float &alpha, float &gamma, float &magnitude);
   UINT GetID();
   HCPWeight *AddCPWeight(); //adds a new cpweight to the head cp
   void RemoveCPWeight(HCPWeight *hcpweight ); //frees handle
// flags  
   BOOL IsLoop();
   BOOL IsPeaked();
   BOOL IsSmooth();
   BOOL IsHook();
   BOOL IsFlip();
   BOOL IsHide();
   BOOL IsGroup();
   BOOL IsLocked();
   BOOL IsEndHook();
   BOOL IsHookBase();
   HSegmentCache *GetSegmentCache();  // returns the primary owner of this control point
};

//*********************************************************
//** HHookCP
//*********************************************************
class PLUGINEXPORT HHookCP : public HCP
{
public:
   float GetS();
};

//*********************************************************
//** HCPShortcut
//*********************************************************
class PLUGINEXPORT HCPShortcut : public HAnimObjectShortcut
{
public:
   ULONG GetCPID();
   BOOL CanCompactForSaving();
};

//*********************************************************
//** HCPInstance
//*********************************************************
class PLUGINEXPORT HCPInstance : public HAnimObject
{
public:
   HBiasProperty *GetInBias();
   HBiasProperty *GetOutBias();
   HTranslatePropertyNoSubs *GetPosition();
   
   HCP *GetCP();
};

//*********************************************************
//** HGroupCP
//*********************************************************
class HCP;
class PLUGINEXPORT HGroupCP : public HHashObject
{
public:
   HGroupCP *GetNext();
   HCP      *GetCP();
// creation
   static HGroupCP *New();   
   void             Delete();
};

class HDecalClipContainer;
class HAttrProperty;
class HClip;
class HPolyModifierShortcut;
//*********************************************************
//** HGroup
//*********************************************************
class PLUGINEXPORT HGroup : public HHashObject
{
public:
// Properties
   HAttrProperty  *GetAttr();

   HGroupCP *GetGroupCP();
   Matrix34 *GetMatrix();
   BOOL      IsTempGroup();
   void      SetTempGroup(BOOL istemp);
   
   BOOL AddCP(HCP *cp);
   BOOL RemoveCP(HCP *cp);
   
   HDecalClipContainer *GetChildDecalClipContainer();
   BOOL IsPatchInGroup(HPatch *patch);
   BOOL IsCPInGroup(HCP *hcp);
   
   HDecalClip *CreateGroupDecal(HClip *clipcache=NULL);// Will prompt if NULL
   void RotateGroupImages();
   HPolyModifierShortcut *GetPolyModifierHead();
};

//*********************************************************
//** HGroupContainer
//*********************************************************
class PLUGINEXPORT HGroupContainer : public HHashObject
{
public:
   HGroup *GetChildGroup();
};

//*********************************************************
//** HChannelCP
//*********************************************************
class PLUGINEXPORT HChannelCP
{
public:
   void  operator delete( void *ptr ) { DeleteHandle( (HChannelCP *)ptr ); }
   static void DeleteHandle(HChannelCP *handle);

   CPInterpolationMethod GetInterpolationMethod();
   void SetInterpolationMethod(CPInterpolationMethod method);
   
// Traversal
   HChannelCP *GetNext();
   
// Operations
   float   GetInGamma();
   float   GetInMagnitude();
   float   GetOutGamma();
   float   GetOutMagnitude();
   void    SetInGamma(float fValue);
   void    SetInMagnitude(float fValue);
   void    SetOutGamma(float fValue);
   void    SetOutMagnitude(float fValue);
   void    SetBias(const Vector2 &goalit, const Vector2 &goalot);
   BOOL    IsPeaked();
   BOOL    IsSmooth();
   Time    GetTime();
   float   GetValue();
   Vector2 GetInTangent();
   Vector2 GetOutTangent();
   BOOL    IsLoop();
};

#endif

---