CigiBaseAnimationStop.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_ANIMATION_STOP_INCLUDED_)
#define _CIGI_BASE_ANIMATION_STOP_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_ANIMATION_STOP_PACKET_ID_V3 115
#define CIGI_ANIMATION_STOP_PACKET_SIZE_V3 8


class CigiAnimationStopV3;


class CIGI_SPEC CigiBaseAnimationStop : public CigiBasePacket
{

friend class CigiAnimationStopV3;

public:

   //==> Management

   //=========================================================
   CigiBaseAnimationStop() { };

   //=========================================================
   virtual ~CigiBaseAnimationStop() { };


   //==> 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)
   {
      if(CnvtVersion.CigiMajorVersion < 3)
      {
         CnvtInfo.ProcID = CigiProcessType::ProcNone;
         CnvtInfo.CnvtPacketID = 0;
      }
      else
      {
         CnvtInfo.ProcID = CigiProcessType::ProcStd;
         CnvtInfo.CnvtPacketID = CIGI_ANIMATION_STOP_PACKET_ID_V3;
      }

      return(CIGI_SUCCESS);
   }



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



protected:

   //==> Member variables

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


};

#endif // #if !defined(_CIGI_BASE_ANIMATION_STOP_INCLUDED_)

---