CigiBaseViewDef.h

Go to the documentation of this file.

#if !defined(_CIGI_BASE_VIEWDEF_INCLUDED_)
#define _CIGI_BASE_VIEWDEF_INCLUDED_

#include "CigiBasePacket.h"

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

#define CIGI_VIEW_DEF_PACKET_ID_V1 23
#define CIGI_VIEW_DEF_PACKET_SIZE_V1 32

#define CIGI_VIEW_DEF_PACKET_ID_V2 23
#define CIGI_VIEW_DEF_PACKET_SIZE_V2 32

#define CIGI_VIEW_DEF_PACKET_ID_V3 21
#define CIGI_VIEW_DEF_PACKET_SIZE_V3 32


class CigiViewDefV1;
class CigiViewDefV2;
class CigiViewDefV3;


class CIGI_SPEC CigiBaseViewDef : public CigiBasePacket
{

friend class CigiViewDefV1;
friend class CigiViewDefV2;
friend class CigiViewDefV3;

public:

   //=========================================================
   enum MirrorModeGrp
   {
      MirrorNone=0,
      Horizontal=1,
      Vertical=2,
      Horiz_Vert=3
   };

   //=========================================================
   enum PixelReplicateModeGrp
   {
      ReplicateNone=0,
      Replicate1x2=1,
      Replicate2x1=2,
      Replicate2x2=3,
      ReplicateDefA=4,
      ReplicateDefB=5,
      ReplicateDefC=6,
      ReplicateDefD=7
   };

   //=========================================================
   enum ProjectionTypeGrp
   {
      Perspective=0,
      Orthographic=1
   };




   //==> Management

   //=========================================================
   CigiBaseViewDef();

   //=========================================================
   virtual ~CigiBaseViewDef();


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

   //+> MirrorMode

   //=========================================================
   int SetMirrorMode(const MirrorModeGrp MirrorModeIn, bool bndchk=true);

   //=========================================================
   MirrorModeGrp GetMirrorMode(void) const { return(MirrorMode); }


   //+> PixelReplicateMode

   //=========================================================
   int SetPixelReplicateMode(const PixelReplicateModeGrp PixelReplicateModeIn, bool bndchk=true);

   //=========================================================
   PixelReplicateModeGrp GetPixelReplicateMode(void) const { return(PixelReplicateMode); }


   //+> ViewType

   //=========================================================
   int SetViewType(const Cigi_uint8 ViewTypeIn, bool bndchk=true);

   //=========================================================
   Cigi_uint8 GetViewType(void) const { return(ViewType); }


   //+> FOVNear

   //=========================================================
   int SetFOVNear(const float FOVNearIn, bool bndchk=true)
   {
      FOVNear = FOVNearIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVNear(void) const { return(FOVNear); }


   //+> FOVFar

   //=========================================================
   int SetFOVFar(const float FOVFarIn, bool bndchk=true)
   {
      FOVFar = FOVFarIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVFar(void) const { return(FOVFar); }


   //+> FOVLeft

   //=========================================================
   int SetFOVLeft(const float FOVLeftIn, bool bndchk=true)
   {
      FOVLeft = FOVLeftIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVLeft(void) const { return(FOVLeft); }


   //+> FOVRight

   //=========================================================
   int SetFOVRight(const float FOVRightIn, bool bndchk=true)
   {
      FOVRight = FOVRightIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVRight(void) const { return(FOVRight); }


   //+> FOVTop

   //=========================================================
   int SetFOVTop(const float FOVTopIn, bool bndchk=true)
   {
      FOVTop = FOVTopIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVTop(void) const { return(FOVTop); }


   //+> FOVBottom

   //=========================================================
   int SetFOVBottom(const float FOVBottomIn, bool bndchk=true)
   {
      FOVBottom = FOVBottomIn;
      return(CIGI_SUCCESS);
   }

   //=========================================================
   float GetFOVBottom(void) const { return(FOVBottom); }



protected:

   //==> Member variables

   //=========================================================
   Cigi_uint16 ViewID;

   //=========================================================
   Cigi_uint8 GroupID;

   //=========================================================
   bool FOVNearEn;

   //=========================================================
   bool FOVFarEn;

   //=========================================================
   bool FOVLeftEn;

   //=========================================================
   bool FOVRightEn;

   //=========================================================
   bool FOVTopEn;

   //=========================================================
   bool FOVBottomEn;

   //=========================================================
   MirrorModeGrp MirrorMode;

   //=========================================================
   PixelReplicateModeGrp PixelReplicateMode;

   //=========================================================
   ProjectionTypeGrp ProjectionType;

   //=========================================================
   bool Reorder;

   //=========================================================
   Cigi_uint8 ViewType;

   //=========================================================
   bool TrackerAssigned;

   //=========================================================
   float FOVNear;

   //=========================================================
   float FOVFar;

   //=========================================================
   float FOVLeft;

   //=========================================================
   float FOVRight;

   //=========================================================
   float FOVTop;

   //=========================================================
   float FOVBottom;

};

#endif // #if !defined(_CIGI_BASE_VIEWDEF_INCLUDED_)

---