gre/layersection.h

Go to the documentation of this file.

#ifndef  INC_GRE_LAYERSECTION_H
#define  INC_GRE_LAYERSECTION_H

#ifndef  INC_GRE_BASE_H
   #include <gre/base.h>
#endif

#ifndef  INC_GRE_LABELPLACEMENT_H
   #include <gre/labelplacement.h>
#endif

#ifndef  INC_MI32_RENDERBUFFER_H
   #include <mi32/renderbuffer.h>
#endif

#ifndef  INC_MI32_TRANS2DMAPGEN_H
   #include <mi32/trans2dmapgen.h>
#endif


#ifndef GENERATING_DOXYGEN_OUTPUT
class UNSIGNEDSET;
class ZVIEW;
namespace MITHREAD {
   class QUEUE;
   }
#endif


namespace GRE {

//===================================================================================================================
class LAYERSECTION {
   public:

      explicit LAYERSECTION (
         GRE::LAYER *layer,
         GRE::VIEW *view
         );

      void ClearLabelPlacement ();

      void CloseZView ();

      void ComputeClipRegion (
         REGION2D& ClipRegion                            
         );

      const UNSIGNEDSET* GetElemDrawnSet (
         ELEMTYPE ElemType,                              
         bool UseHighlighted                             
         ) const { return (const_cast<LAYERSECTION*>(this)->v_GetElemDrawnSet(ElemType,UseHighlighted)); }

      UNSIGNEDSET* GetElemDrawnSet (
         ELEMTYPE ElemType,                              
         bool UseHighlighted                             
         ) { return (v_GetElemDrawnSet(ElemType,UseHighlighted)); }

      LABELPLACEMENT* GetLabelPlacement (
         bool ReturnNullIfEmpty = true                   
         );

      GRE::LAYER* GetLayer (
         ) const { return (m_layer); }

      const RENDERBUFFER& GetRenderBuffer (
         GRE::RENDERTARGET content                       
         ) const;

      RENDERBUFFER& GetRenderBuffer (
         GRE::RENDERTARGET content                       
         );

      const TRANS2D_MAPGEN& GetTransLayerBuffer (
         ) const { return (m_TransLayerBuffer); }

      GRE::VIEW* GetView (
         ) const { return (m_view); }

      const ZVIEW* GetZView (bool DoSetup = true)
         { return (v_GetZView(DoSetup)); }

      bool HasRendered (
         GRE::RENDERTARGET content                       
         ) const;

      bool OverlayBufferIfRendered (
         GRE::RENDERTARGET content,                      
         MGD::DEVICE *pDevTarget,                        
         const LRECT2D *pClipRect = 0                    
         ) const;

      ERRVALUE QueueJobRender (
         MITHREAD::QUEUE& Queue                          
         );

      void Release (
         );

      void ResetAllDrawnSets (
         );

      void ResetRendered (
         GRE::RENDERTARGET content = GRE::RENDERTARGET_LayerAll
         );

      void SetTransLayerBuffer (
         const TRANS2D_MAPGEN& TransLayerBuffer
         ) { m_TransLayerBuffer = TransLayerBuffer; }

      ERRVALUE SetupRenderBuffer (
         RENDERBUFFER& RenderBuffer,
         bool EraseExisting = false
         ) const;

   protected:

      virtual ~LAYERSECTION ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class JOB_RENDER;

      LAYER *m_layer;
      VIEW *m_view;
      JOB_RENDER *m_pJob;
      RENDERBUFFER m_RenderBufferNormal;
      RENDERBUFFER m_RenderBufferHighlight;
      RENDERBUFFER m_RenderBufferLabels;
      TRANS2D_MAPGEN m_TransLayerBuffer;

      // Unimplemented
      LAYERSECTION (const LAYERSECTION&);
      LAYERSECTION& operator= (const LAYERSECTION&);

      #endif // GENERATING_DOXYGEN_OUTPUT

      // LAYERSECTION Overridables.

      virtual UNSIGNEDSET* v_GetElemDrawnSet (
         ELEMTYPE ElemType,
         bool UseHighlighted
         );

      virtual LABELPLACEMENT* v_GetLabelPlacement ();

      virtual ZVIEW* v_GetZView (bool DoSetup);

   };


//===================================================================================================================
class LAYERSECTION_GEOMETRIC : public LAYERSECTION {
   public:

      LAYERSECTION_GEOMETRIC (
         GRE::LAYER *layer,
         GRE::VIEW *view
         );

   protected:

      virtual ~LAYERSECTION_GEOMETRIC ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      unsigned m_NumComponents;
      UNSIGNEDSET *m_ElemDrawnSetsNormal;
      UNSIGNEDSET *m_ElemDrawnSetsHighlighted;

      virtual UNSIGNEDSET* v_GetElemDrawnSet (ELEMTYPE ElemType, bool UseHighlighted);

      // Unimplemented
      LAYERSECTION_GEOMETRIC (const LAYERSECTION_GEOMETRIC&);
      LAYERSECTION_GEOMETRIC& operator= (const LAYERSECTION_GEOMETRIC&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };


//===================================================================================================================
class LAYERSECTION_LABELED : public LAYERSECTION_GEOMETRIC {
   public:

      LAYERSECTION_LABELED (
         GRE::LAYER *layer,
         GRE::VIEW *view
         );

   protected:

      virtual ~LAYERSECTION_LABELED ();

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      LABELPLACEMENT m_LabelPlacement;

      virtual LABELPLACEMENT* v_GetLabelPlacement ();

      // Unimplemented
      LAYERSECTION_LABELED (const LAYERSECTION_LABELED&);
      LAYERSECTION_LABELED& operator= (const LAYERSECTION_LABELED&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================
}  // End namespace GRE

#endif   // INC_GRE_LAYERSECTION_H

---