CigiBaseCollDetVolDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_COLL_DET_VOL_DEF_INCLUDED_)
#define _CIGI_BASE_COLL_DET_VOL_DEF_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_COLL_DET_VOL_DEF_PACKET_ID_V2 25
#define CIGI_COLL_DET_VOL_DEF_PACKET_SIZE_V2 20

#define CIGI_COLL_DET_VOL_DEF_PACKET_ID_V3 23
#define CIGI_COLL_DET_VOL_DEF_PACKET_SIZE_V3 48


class CigiCollDetVolDefV2;
class CigiCollDetVolDefV3;


class CIGI_SPEC CigiBaseCollDetVolDef : public CigiBasePacket
{

friend class CigiCollDetVolDefV2;
friend class CigiCollDetVolDefV3;

public:

   //=========================================================
   enum VolTypeGrp
   {
      Sphere=0,
      Cuboid=1
   };




   //==> Management

   //=========================================================
   CigiBaseCollDetVolDef();

   //=========================================================
   virtual ~CigiBaseCollDetVolDef();


   //==> 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); }


   //+> VolID

   //=========================================================
   int SetVolID(const Cigi_uint8 VolIDIn, bool bndchk=true)
   {
      VolID = VolIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetVolID(void) const { return(VolID); }


   //+> VolEn

   //=========================================================
   int SetVolEn(const bool VolEnIn, bool bndchk=true)
   {
      VolEn = VolEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetVolEn(void) const { return(VolEn); }


   //+> 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); }


   //+> HeightOrRadius

   //=========================================================
   int SetHeightOrRadius(const float HeightOrRadiusIn, bool bndchk=true)
   {
      HeightOrRadius = HeightOrRadiusIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetHeightOrRadius(void) const { return(HeightOrRadius); }


   //+> Width

   //=========================================================
   int SetWidth(const float WidthIn, bool bndchk=true)
   {
      Width = WidthIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetWidth(void) const { return(Width); }


   //+> Depth

   //=========================================================
   int SetDepth(const float DepthIn, bool bndchk=true)
   {
      Depth = DepthIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetDepth(void) const { return(Depth); }



protected:

   //==> Member variables

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

   //=========================================================
   Cigi_uint8 VolID;

   //=========================================================
   bool VolEn;

   //=========================================================
   VolTypeGrp VolType;

   //=========================================================
   float Xoff;

   //=========================================================
   float Yoff;

   //=========================================================
   float Zoff;

   //=========================================================
   float HeightOrRadius;

   //=========================================================
   float Width;

   //=========================================================
   float Depth;

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

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

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


};

#endif // #if !defined(_CIGI_BASE_COLL_DET_VOL_DEF_INCLUDED_)

---