CigiBaseSpecEffDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SPEC_EFF_DEF_INCLUDED_)
#define _CIGI_BASE_SPEC_EFF_DEF_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_SPEC_EFF_DEF_PACKET_ID_V1 22
#define CIGI_SPEC_EFF_DEF_PACKET_SIZE_V1 32

#define CIGI_SPEC_EFF_DEF_PACKET_ID_V2 22
#define CIGI_SPEC_EFF_DEF_PACKET_SIZE_V2 32


class CigiSpecEffDefV1;
class CigiSpecEffDefV2;


class CIGI_SPEC CigiBaseSpecEffDef : public CigiBasePacket
{

friend class CigiSpecEffDefV1;
friend class CigiSpecEffDefV2;

public:

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




   //==> Management

   //=========================================================
   CigiBaseSpecEffDef();

   //=========================================================
   virtual ~CigiBaseSpecEffDef();


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


   //+> SeqDir

   //=========================================================
   int SetSeqDir(const SeqDirGrp SeqDirIn, bool bndchk=true);

   //=========================================================
   SeqDirGrp GetSeqDir(void) const { return(SeqDir); }


   //+> ColorEn

   //=========================================================
   int SetColorEn(const bool ColorEnIn, bool bndchk=true)
   {
      ColorEn = ColorEnIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   bool GetColorEn(void) const { return(ColorEn); }


   //+> Red

   //=========================================================
   int SetRed(const Cigi_uint8 RedIn, bool bndchk=true)
   {
      Red = RedIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetRed(void) const { return(Red); }


   //+> Green

   //=========================================================
   int SetGreen(const Cigi_uint8 GreenIn, bool bndchk=true)
   {
      Green = GreenIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetGreen(void) const { return(Green); }


   //+> Blue

   //=========================================================
   int SetBlue(const Cigi_uint8 BlueIn, bool bndchk=true)
   {
      Blue = BlueIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint8 GetBlue(void) const { return(Blue); }


   //+> XScale

   //=========================================================
   int SetXScale(const float XScaleIn, bool bndchk=true);

   //=========================================================
   float GetXScale(void) const { return(XScale); }


   //+> YScale

   //=========================================================
   int SetYScale(const float YScaleIn, bool bndchk=true);

   //=========================================================
   float GetYScale(void) const { return(YScale); }


   //+> ZScale

   //=========================================================
   int SetZScale(const float ZScaleIn, bool bndchk=true);

   //=========================================================
   float GetZScale(void) const { return(ZScale); }


   //+> TimeScale

   //=========================================================
   int SetTimeScale(const float TimeScaleIn, bool bndchk=true);

   //=========================================================
   float GetTimeScale(void) const { return(TimeScale); }


   //+> EffectCnt

   //=========================================================
   int SetEffectCnt(const Cigi_uint16 EffectCntIn, bool bndchk=true)
   {
      EffectCnt = EffectCntIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetEffectCnt(void) const { return(EffectCnt); }


   //+> Separation

   //=========================================================
   int SetSeparation(const float SeparationIn, bool bndchk=true)
   {
      Separation = SeparationIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetSeparation(void) const { return(Separation); }


   //+> BurstRate

   //=========================================================
   int SetBurstRate(const float BurstRateIn, bool bndchk=true)
   {
      BurstRate = BurstRateIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetBurstRate(void) const { return(BurstRate); }


   //+> Duration

   //=========================================================
   int SetDuration(const float DurationIn, bool bndchk=true)
   {
      Duration = DurationIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetDuration(void) const { return(Duration); }



protected:

   //==> Member variables

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

   //=========================================================
   SeqDirGrp SeqDir;

   //=========================================================
   bool ColorEn;

   //=========================================================
   Cigi_uint8 Red;

   //=========================================================
   Cigi_uint8 Green;

   //=========================================================
   Cigi_uint8 Blue;

   //=========================================================
   float XScale;

   //=========================================================
   float YScale;

   //=========================================================
   float ZScale;

   //=========================================================
   float TimeScale;

   //=========================================================
   Cigi_uint16 EffectCnt;

   //=========================================================
   float Separation;

   //=========================================================
   float BurstRate;

   //=========================================================
   float Duration;


};

#endif // #if !defined(_CIGI_BASE_SPEC_EFF_DEF_INCLUDED_)

---