CigiBaseSymbolCircleDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SYMBOL_CIRCLE_DEF_INCLUDED_)
#define _CIGI_BASE_SYMBOL_CIRCLE_DEF_INCLUDED_


#include "CigiBaseVariableSizePckt.h"
#include "CigiBaseCircleSymbolData.h"
#include <vector>


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

#define CIGI_SYMBOL_CIRCLE_DEFINITION_PACKET_ID_V3_3 31
#define CIGI_SYMBOL_CIRCLE_DEFINITION_PACKET_SIZE_V3_3 16


class CigiSymbolCircleDefV3_3;


//=========================================================
class CIGI_SPEC CigiBaseSymbolCircleDef :
   public CigiBaseVariableSizePckt
{

   friend class CigiSymbolCircleDefV3_3;

public:


   //=========================================================
   enum DrawingStyleGrp
   {
      Line=0,
      Fill=1
   };


   //==> Management

   //=========================================================
   CigiBaseSymbolCircleDef(void);

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

   //=========================================================
   CigiBaseSymbolCircleDef(const CigiBaseSymbolCircleDef &BaseIn);

   //=========================================================
   CigiBaseSymbolCircleDef & operator=(const CigiBaseSymbolCircleDef &BaseIn);


   //==> 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 GetTruePacketSize(CigiBaseVariableSizePckt &refPacket)
   { return(PacketSize + refPacket.GetVariableDataSize()); }

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

   //+> DrawingStyle

   //=========================================================
   int SetDrawingStyle(const DrawingStyleGrp DrawingStyleIn, bool bndchk=true);

   //=========================================================
   DrawingStyleGrp GetDrawingStyle(void) const { return(DrawingStyle); }


   //+> StipplePattern

   //=========================================================
   int SetStipplePattern(const Cigi_uint16 StipplePatternIn, bool bndchk=true)
   {
      StipplePattern = StipplePatternIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   Cigi_uint16 GetStipplePattern(void) const { return(StipplePattern); }


   //+> LineWidth

   //=========================================================
   int SetLineWidth(const float LineWidthIn, bool bndchk=true);

   //=========================================================
   float GetLineWidth(void) const { return(LineWidth); }


   //+> StipplePatternLen

   //=========================================================
   int SetStipplePatternLen(const float StipplePatternLenIn, bool bndchk=true);

   //=========================================================
   float GetStipplePatternLen(void) const { return(StipplePatternLen); }


   //+> Circles

   //=========================================================
   int GetCircleCount(void);

   //=========================================================
   virtual CigiBaseCircleSymbolData * AddCircle(void) =0;

   //=========================================================
   virtual int RemoveCircle(int CircleIndex, bool bndchk=true) =0;

   //=========================================================
   CigiBaseCircleSymbolData * GetCircle(int CircleIndex, bool bndchk=true);

   //=========================================================
   void ClearCircles(void);



protected:

   //==> Member variables

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

   //=========================================================
   DrawingStyleGrp DrawingStyle;

   //=========================================================
   Cigi_uint16 StipplePattern;

   //=========================================================
   float LineWidth;

   //=========================================================
   float StipplePatternLen;

   //=========================================================
   std::vector<CigiBaseCircleSymbolData *> Circles;


};



#endif   //  #if !defined(_CIGI_BASE_SYMBOL_CIRCLE_DEF_INCLUDED_)

---