CigiBaseShortSymbolCtrl.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SHORT_SYMBOL_CTRL_INCLUDED_)
#define _CIGI_BASE_SHORT_SYMBOL_CTRL_INCLUDED_


#include "CigiBaseSymbolCtrl.h"

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

#define CIGI_SHORT_SYMBOL_CONTROL_PACKET_ID_V3_3 35
#define CIGI_SHORT_SYMBOL_CONTROL_PACKET_SIZE_V3_3 16


class CigiShortSymbolCtrlV3_3;


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

   friend class CigiShortSymbolCtrlV3_3;

public:


   //=========================================================
   enum DatumTypeGrp
   {
      None=0,
      SurfaceIdDatumType=1,
      ParentIdDatumType=2,
      LayerDatumType=3,
      FlashDutyCycleDatumType=4,
      FlashPeriodDatumType=5,
      UPositionDatumType=6,
      VPositionDatumType=7,
      RotationDatumType=8,
      ColorDatumType=9,
      ScaleUDatumType=10,
      ScaleVDatumType=11
   };

   //=========================================================
   typedef union DatumUnion {
      Cigi_uint32 UIntValue;
      float FloatValue;
   } DatumUnionType;



   //==> Management

   //=========================================================
   CigiBaseShortSymbolCtrl(void);

   //=========================================================
   virtual ~CigiBaseShortSymbolCtrl(void);


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

   //+> SymbolID

   //=========================================================
   int SetSymbolID(const Cigi_uint16 SymbolIDIn, bool bndchk=true)
   {
      SymbolID = SymbolIDIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetSymbolID(void) const { return(SymbolID); }
   

   //+> SymbolState

   //=========================================================
   int SetSymbolState(const CigiBaseSymbolCtrl::SymbolStateGrp SymbolStateIn, bool bndchk=true);

   //=========================================================
   CigiBaseSymbolCtrl::SymbolStateGrp GetSymbolState(void) const { return(SymbolState); }
   

   //+> AttachState

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

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

   //+> FlashCtrl

   //=========================================================
   int SetFlashCtrl(const CigiBaseSymbolCtrl::FlashCtrlGrp FlashCtrlIn, bool bndchk=true);

   //=========================================================
   CigiBaseSymbolCtrl::FlashCtrlGrp GetFlashCtrl(void) const { return(FlashCtrl); }
   

   //+> InheritColor

   //=========================================================
   int SetInheritColor(const CigiBaseSymbolCtrl::InheritColorGrp InheritColorIn, bool bndchk=true);

   //=========================================================
   CigiBaseSymbolCtrl::InheritColorGrp GetInheritColor(void) const { return(InheritColor); }


   //+> Getting Datum Type

   //=========================================================
   DatumTypeGrp GetDatumType(int DatumId) const;


   //+> Getting Datum

   //=========================================================
   Cigi_uint32 GetUIntDatum(int DatumId) const;

   //=========================================================
   int GetColorDatum(int DatumId,
                     Cigi_uint8 &RedValue,
                     Cigi_uint8 &GreenValue,
                     Cigi_uint8 &BlueValue,
                     Cigi_uint8 &AlphaValue,
                     bool bndchk=true);

   //=========================================================
   float GetFloatDatum(int DatumId) const;


   //+> Datum Entries

   //=========================================================
   int SetDatumNone(int DatumId, bool bndchk=true);

   //=========================================================
   int SetSurfaceID(int DatumId, const Cigi_uint16 SurfaceIDIn, bool bndchk=true);

   //=========================================================
   int SetParentSymbolID(int DatumId, const Cigi_uint16 ParentSymbolIDIn, bool bndchk=true);

   //=========================================================
   int SetLayer(int DatumId, const Cigi_uint8 LayerIn, bool bndchk=true);

   //=========================================================
   int SetFlashDutyCycle(int DatumId, const Cigi_uint8 FlashDutyCycleIn, bool bndchk=true);

   //=========================================================
   int SetFlashPeriod(int DatumId, const float FlashPeriodIn, bool bndchk=true);

   //=========================================================
   int SetUPosition(int DatumId, const float UPositionIn, bool bndchk=true);

   //=========================================================
   int SetVPosition(int DatumId, const float VPositionIn, bool bndchk=true);

   //=========================================================
   int SetRotation(int DatumId, const float RotationIn, bool bndchk=true);

   //=========================================================
   int SetScaleU(int DatumId, const float ScaleUIn, bool bndchk=true);

   //=========================================================
   int SetScaleV(int DatumId, const float ScaleVIn, bool bndchk=true);



   //+> Color

   //=========================================================
   int SetColor(int DatumId,
                const Cigi_uint8 RedIn,
                const Cigi_uint8 GreenIn,
                const Cigi_uint8 BlueIn,
                const Cigi_uint8 AlphaIn,
                bool bndchk=true);



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 SymbolID;

   //=========================================================
   CigiBaseSymbolCtrl::SymbolStateGrp SymbolState;

   //=========================================================
   CigiBaseSymbolCtrl::AttachStateGrp AttachState;

   //=========================================================
   CigiBaseSymbolCtrl::FlashCtrlGrp FlashCtrl;

   //=========================================================
   CigiBaseSymbolCtrl::InheritColorGrp InheritColor;

   //=========================================================
   DatumTypeGrp DatumType[2];

   //=========================================================
   DatumUnionType Datum[2];

};



#endif   //  #if !defined(_CIGI_BASE_SHORT_SYMBOL_CTRL_INCLUDED_)

---