CigiBaseSymbolLineDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_SYMBOL_LINE_DEF_INCLUDED_)
#define _CIGI_BASE_SYMBOL_LINE_DEF_INCLUDED_


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


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

#define CIGI_SYMBOL_LINE_DEFINITION_PACKET_ID_V3_3 32
#define CIGI_SYMBOL_LINE_DEFINITION_PACKET_SIZE_V3_3 16


class CigiSymbolLineDefV3_3;


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

   friend class CigiSymbolLineDefV3_3;

public:


   //=========================================================
   enum PrimitiveGrp
   {
      Points=0,
      Lines=1,
      LineStrip=2,
      LineLoop=3,
      Triangles=4,
      TriangleStrip=5,
      TriangleFan=6
   };


   //==> Management

   //=========================================================
   CigiBaseSymbolLineDef(void);

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

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

   //=========================================================
   CigiBaseSymbolLineDef & operator=(const CigiBaseSymbolLineDef &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); }
   

   //+> Primitive

   //=========================================================
   int SetPrimitive(const PrimitiveGrp PrimitiveIn, bool bndchk=true);

   //=========================================================
   PrimitiveGrp GetPrimitive(void) const { return(Primitive); }


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


   //+> Vertices

   //=========================================================
   int GetVertexCount(void);

   //=========================================================
   virtual CigiBaseVertexSymbolData * AddVertex(void) =0;

   //=========================================================
   virtual int RemoveVertex(int VertexIndex, bool bndchk=true) =0;

   //=========================================================
   CigiBaseVertexSymbolData * GetVertex(int VertexIndex, bool bndchk=true);

   //=========================================================
   void ClearVertices(void);



protected:

   //==> Member variables

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

   //=========================================================
   PrimitiveGrp Primitive;

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

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

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

   //=========================================================
   std::vector<CigiBaseVertexSymbolData *> Vertices;


};



#endif   //  #if !defined(_CIGI_BASE_SYMBOL_LINE_DEF_INCLUDED_)

---