CigiBaseArtPartCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_ART_PART_CTRL_INCLUDED_)
#define _CIGI_BASE_ART_PART_CTRL_INCLUDED_

#include "CigiBasePacket.h"


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

#define CIGI_ART_PART_CTRL_PACKET_ID_V1 4
#define CIGI_ART_PART_CTRL_PACKET_SIZE_V1 20

#define CIGI_ART_PART_CTRL_PACKET_ID_V2 4
#define CIGI_ART_PART_CTRL_PACKET_SIZE_V2 32

#define CIGI_ART_PART_CTRL_PACKET_ID_V3 6
#define CIGI_ART_PART_CTRL_PACKET_SIZE_V3 32


class CigiArtPartCtrlV1;
class CigiArtPartCtrlV2;
class CigiArtPartCtrlV3;


class CIGI_SPEC CigiBaseArtPartCtrl : public CigiBasePacket
{

friend class CigiArtPartCtrlV1;
friend class CigiArtPartCtrlV2;
friend class CigiArtPartCtrlV3;

public:

   //==> Management

   //=========================================================
   CigiBaseArtPartCtrl();

   //=========================================================
   virtual ~CigiBaseArtPartCtrl();


   //==> 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

   //+> EntityID

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

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


   //+> ArtPartEn

   //=========================================================
   int SetArtPartEn(const bool ArtPartEnIn, bool bndchk=true)
   {
      ArtPartEn = ArtPartEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetArtPartEn(void) const { return(ArtPartEn); }


   //+> XOffEn

   //=========================================================
   int SetXOffEn(const bool XOffEnIn, bool bndchk=true)
   {
      XOffEn = XOffEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetXOffEn(void) const { return(XOffEn); }


   //+> YOffEn

   //=========================================================
   int SetYOffEn(const bool YOffEnIn, bool bndchk=true)
   {
      YOffEn = YOffEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetYOffEn(void) const { return(YOffEn); }


   //+> ZOffEn

   //=========================================================
   int SetZOffEn(const bool ZOffEnIn, bool bndchk=true)
   {
      ZOffEn = ZOffEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetZOffEn(void) const { return(ZOffEn); }


   //+> RollEn

   //=========================================================
   int SetRollEn(const bool RollEnIn, bool bndchk=true)
   {
      RollEn = RollEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetRollEn(void) const { return(RollEn); }


   //+> PitchEn

   //=========================================================
   int SetPitchEn(const bool PitchEnIn, bool bndchk=true)
   {
      PitchEn = PitchEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetPitchEn(void) const { return(PitchEn); }


   //+> YawEn

   //=========================================================
   int SetYawEn(const bool YawEnIn, bool bndchk=true)
   {
      YawEn = YawEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetYawEn(void) const { return(YawEn); }


   //+> XOff

   //=========================================================
   int SetXOff(const float XOffIn, bool bndchk=true)
   {
      XOff = XOffIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetXOff(void) const { return(XOff); }


   //+> YOff

   //=========================================================
   int SetYOff(const float YOffIn, bool bndchk=true)
   {
      YOff = YOffIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetYOff(void) const { return(YOff); }


   //+> ZOff

   //=========================================================
   int SetZOff(const float ZOffIn, bool bndchk=true)
   {
      ZOff = ZOffIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetZOff(void) const { return(ZOff); }


   //+> Roll

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

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


   //+> Pitch

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

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


   //+> Yaw

   //=========================================================
   int SetYaw(const float YawIn, bool bndchk=true);

   //=========================================================
   float GetYaw(void) const { return(Yaw); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_int8 ArtPartIDV1;

   //=========================================================
   Cigi_uint8 ArtPartIDV3;

   //=========================================================
   bool ArtPartEn;

   //=========================================================
   bool XOffEn;

   //=========================================================
   bool YOffEn;

   //=========================================================
   bool ZOffEn;

   //=========================================================
   bool RollEn;

   //=========================================================
   bool PitchEn;

   //=========================================================
   bool YawEn;

   //=========================================================
   float XOff;

   //=========================================================
   float YOff;

   //=========================================================
   float ZOff;

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

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

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


};

#endif // #if !defined(_CIGI_BASE_ART_PART_CTRL_INCLUDED_)

---