CigiBaseEntityCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_ENTITY_CTRL_INCLUDED_)
#define _CIGI_BASE_ENTITY_CTRL_INCLUDED_

#include "CigiBasePacket.h"

#include "CigiAnimationTable.h"

// ====================================================================
// preprocessor definitions
// ====================================================================

#define CIGI_ENTITY_CTRL_PACKET_ID_V1 2
#define CIGI_ENTITY_CTRL_PACKET_SIZE_V1 48

#define CIGI_ENTITY_CTRL_PACKET_ID_V2 2
#define CIGI_ENTITY_CTRL_PACKET_SIZE_V2 56

#define CIGI_ENTITY_CTRL_PACKET_ID_V3 2
#define CIGI_ENTITY_CTRL_PACKET_SIZE_V3 48

#define CIGI_ENTITY_CTRL_PACKET_ID_V3_3 2
#define CIGI_ENTITY_CTRL_PACKET_SIZE_V3_3 48


class CigiEntityCtrlV1;
class CigiEntityCtrlV2;
class CigiEntityCtrlV3;
class CigiEntityCtrlV3_3;


//=========================================================
class CIGI_SPEC CigiBaseEntityCtrl : public CigiBasePacket  
{

friend class CigiEntityCtrlV1;
friend class CigiEntityCtrlV2;
friend class CigiEntityCtrlV3;
friend class CigiEntityCtrlV3_3;

public:

   //=========================================================
   enum EntityStateGrp
   {
      Standby=0,
      Active=1,
      Remove=2
   };

   //=========================================================
   enum AttachStateGrp
   {
      Detach=0,
      Attach=1
   };

   //=========================================================
   enum CollisionDetectGrp
   {
      Disable=0,
      Enable=1
   };

   //=========================================================
   enum InheritAlphaGrp
   {
      NoInherit=0,
      Inherit=1
   };

   //=========================================================
   enum GrndClampGrp
   {
      NoClamp=0,
      AltClamp=1,
      AltAttClamp=2
   };

   //=========================================================
   enum AnimationDirGrp
   {
      Forward=0,
      Backward=1
   };

   //=========================================================
   enum AnimationLoopModeGrp
   {
      OneShot=0,
      Continuous=1
   };

   //=========================================================
   enum AnimationStateGrp
   {
      Stop=0,
      Pause=1,
      Play=2,
      Continue=3,
      NoAction=4,
      Load=5,
      LoadActivate=6,
      Activate=7,
      Deactivate=8,
      DeactivateUnload=9
   };



   //==> Management

   //=========================================================
        CigiBaseEntityCtrl();

   //=========================================================
        virtual ~CigiBaseEntityCtrl();



   //==> Buffer Packing/Unpacking

   //=========================================================
        virtual int Pack(CigiBasePacket * Base, Cigi_uint8 * Buff, void *Spec) const=0;

   //=========================================================
   virtual int Unpack(Cigi_uint8 * Buff, bool Swap, void *Spec) =0;

   //=========================================================
        virtual int GetCnvt(CigiVersionID &CnvtVersion,
                       CigiCnvtInfoType::Type &CnvtInfo);




   //==> Accessing Member Variable Values functions

   //+> Entity ID

   //=========================================================
        int SetEntityID(const Cigi_uint16 EntityIDIn, bool bndchk=true)
   {
      EntityID = EntityIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityID(void) const { return(EntityID); }


   //+> Entity Type

   //=========================================================
        int SetEntityType(const Cigi_uint16 EntityTypeIn, bool bndchk=true)
   {
      EntityType = EntityTypeIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEntityType(void) const { return(EntityType); }


   //+> Attach State Flag

   //=========================================================
        int SetAttachState(const AttachStateGrp AttachStateIn, bool bndchk=true);

   //=========================================================
   AttachStateGrp GetAttachState(void) const { return(AttachState); }


   //+> Collision Detection Enable Flag

   //=========================================================
        int SetCollisionDetectEn(const CollisionDetectGrp CollisionDetectEnIn,
                            bool bndchk=true);

   //=========================================================
   CollisionDetectGrp GetCollisionDetectEn(void) const { return(CollisionDetectEn); }


   //+> Parent ID

   //=========================================================
        int SetParentID(const Cigi_uint16 ParentIDIn, bool bndchk=true)
   {
      ParentID = ParentIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetParentID(void) const { return(ParentID); }


   //+> Pitch

   //=========================================================
        int SetPitch(const float PitchIn, bool bndchk=true);

   //=========================================================
   float GetPitch(void) const { return(Pitch); }


   //+> Roll

   //=========================================================
        int SetRoll(const float RollIn, bool bndchk=true);

   //=========================================================
   float GetRoll(void) const { return(Roll); }


   //+> Latitude

   //=========================================================
        int SetLat(const double Lat, bool bndchk=true);

   //=========================================================
   double GetLat(void) const { return(LatOrXoff); }


   //+> X Offset

   //=========================================================
        int SetXoff(const double Xoff,bool bndchk=true)
   {
      LatOrXoff = Xoff;
      return(CIGI_SUCCESS);
   }

   //=========================================================
        double GetXoff(void) const { return(LatOrXoff); }


   //+> Longitude

   //=========================================================
        int SetLon(const double Lon, bool bndchk=true);

   //=========================================================
   double GetLon(void) const { return(LonOrYoff); }


   //+> Y Offset

   //=========================================================
        int SetYoff(const double Yoff, bool bndchk=true)
   {
      LonOrYoff = Yoff;
      return(CIGI_SUCCESS);
   }

   //=========================================================
        double GetYoff(void) const { return(LonOrYoff); }




protected:

   //==> Member variables

   //=========================================================
        Cigi_uint16 EntityID;

   //=========================================================
        Cigi_uint16 EntityType;

   //=========================================================
        Cigi_uint16 ParentID;

   //=========================================================
   Cigi_uint8 Alpha;

   //=========================================================
        float Opacity;

   //=========================================================
        float Temperature;

   //=========================================================
        float Roll;

   //=========================================================
        float Pitch;

   //=========================================================
        float Yaw;

   //=========================================================
        double LatOrXoff;

   //=========================================================
        double LonOrYoff;

   //=========================================================
        double AltOrZoff;


   //==> Conversion Tables
   
   static const AnimationStateGrp ToV1[10];
   static const AnimationStateGrp ToV3[10];


   //==> Member flags

   //=========================================================
        EntityStateGrp EntityState;

   //=========================================================
   AttachStateGrp AttachState;

   //=========================================================
   CollisionDetectGrp CollisionDetectEn;

   //=========================================================
        InheritAlphaGrp InheritAlpha;

   //=========================================================
        GrndClampGrp GrndClamp;

   //=========================================================
        AnimationDirGrp AnimationDir;

   //=========================================================
        AnimationLoopModeGrp AnimationLoopMode;

   //=========================================================
        AnimationStateGrp AnimationState;

   //=========================================================
   AnimationStateGrp PastAnimationState;

   //=========================================================
   bool SmoothingEn;

};

#endif  //#if !defined(_CIGI_BASE_ENTITY_CTRL_INCLUDED_)

---