layerdc.h

Go to the documentation of this file.

/**
 * \file layerdc.h <gre/layerdc.h>
 * \brief GRE_LAYERDC class definition
 *
 * \if NODOC
 * $Id: layerdc.h_v 1.11 2004/03/12 16:07:19 mju Exp $
 *
 * $Log: layerdc.h_v $
 * Revision 1.11  2004/03/12 16:07:19  mju
 * Add isHidden fn.
 *
 * Revision 1.10  2004/03/05 17:01:57  mju
 * Make dtor virtual since has virtual fns.
 *
 * Revision 1.9  2003/10/06 20:47:23  mju
 * Add NotifyDrawElementBegin/End.
 *
 * Revision 1.8  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.7  2003/09/10 17:03:44  scowan
 * Create no trans draw line clipped function.
 *
 * Revision 1.6  2003/07/31 22:09:43  mju
 * Ignore private section.
 *
 * Revision 1.5  2003/06/14 02:11:02  scowan
 * Removed dregion and changed to region2d.
 *
 * Revision 1.4  2003/06/04 23:13:54  scowan
 * Added methods and removed simple array.
 *
 * Revision 1.3  2003/03/20 23:14:49  vdronov
 * new trans
 *
 * Revision 1.2  2003/03/05 20:41:32  mju
 * Add GetTransLayerToDevice
 *
 * Revision 1.1  2002/09/19 17:08:41  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_LAYERDC_H
#define  INC_GRE_LAYERDC_H

#ifndef  INC_MI32_GRE_H
   #include <mi32/gre.h>
#endif

#ifndef  INC_MI32_REGION2D_H
   #include <mi32/region2d.h>
#endif

//===================================================================================================================
//! Layer drawing context.
//! Contains information needed to actually draw layer on a particular view.
class GRE_LAYERDC : public POLYLINE::CLIP {
   public:

      GRE_LAYER *layer;                      //!< Layer being drawn
      GRE_VIEW *view;                        //!< View being drawn in
      MGD::CONTEXT* ggc;                     //!< Generic graphic context
      GRE_VIEWPOINT3D *ViewPoint;            //!< 3D viewpoint
      GRE_LAYER_SURFACE *surflayer;          //!< Surface layer in 3D
      const GRE_LAYER_SURFACE::DISPPARM *surfdp;   //!< Surface layer display parameters for 3D
      DRECT2D ObjClipRect;                   //!< Clipping rectangle in object coordinates
      double LayoutScale;                    //!< Map scale of layout for relative size
      double MapScale;                       //!< Current map scale for relative size
      double RotAngle;                       //!< Rotation angle
      double cosrot, sinrot;                 //!< sin/cos of rotation angle
      double xpixelsize, ypixelsize;         //!< Pixel size in millimeters
      double surfinc;                        //!< Increment in layer corresponding to one cell in surface raster
      double MapScaleZ;                      //!< Map scale factor for 3D (multiply by depth to get actual scale)
      COLOR BackgroundColor;                 //!< Background color for AllBackground
      UINT32 drawflags;                      //!< MDISPDRAW_... flags
      UINT32 Clip3DFlags;                    //!< 3D clipping flags
      bool Is3D;                             //!< Set if drawing in 3D
      bool UseSurface;                       //!< Use surface layer for Z value
      bool SurfHasNull;                      //!< Surface layer has NULL values
      bool NoDrawActive;                     //!< Don't draw "active" element
      UINT8 ViewIndex;                       //!< Stereo view index
      bool ScaleToMap3D;                     //!< Set if 3D scaling to map

      //! Constructor.
      explicit GRE_LAYERDC (
         GRE_LAYER *layer,
         GRE_VIEW *view = 0,
         MGD::CONTEXT* ggc = 0,
         UINT32 drawflags = 0
         );

      //! Constructor.
      //! Does not need a layer, but you need to calculate the transformation and pass it in.
      //! Do not call Setup2D() if you use this ctor.
      GRE_LAYERDC (
         GRE_VIEW *view,
         MGD::CONTEXT* ggc,
         const TRANS2D_MAPGEN& ObjectToDevice,
         UINT32 drawflags = 0
         );

      //! Destructor.
      virtual ~GRE_LAYERDC ();

      //! Draw line in 2D, does not translate or clip
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      ERRVALUE DrawLine2D (
         POLYLINE& PolyLine
         ) { return (OnClip(PolyLine)); }

      //! Translate, clip and draw line in 2D
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      int DrawLineClipped2D (
         POLYLINE& PolyLine
         ) const;

      //! Clip and draw line in 2D
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      int DrawLineClipped2DNoTrans (
         POLYLINE& PolyLine
         ) const;

      //! Translate, clip and draw line in 3D
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      int DrawLineClipped3D (
         POLYLINE& PolyLine
         ) const;

      //! Translate, clip and draw line in 3D
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      int DrawLineClipped3D (
         DPOINT3D* points,                   //!< Array of points with X/Y coordinates in layer associated with context
         INT32 NumPoints                     //!< Number of points
         ) const;

      //! Clip and draw segment in 3D.
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      int DrawSegment3D (
         const DPOINT3D& point1,             //!< First point in map coordinates
         const DPOINT3D& point2              //!< Second point in map coordinates
         ) const;

      //! Get clipping region.
      const REGION2D& GetClipRegion (
         ) const { return (m_ClipRegion); }

      //! Get layer.
      GRE_LAYER* GetLayer (
         ) const { return (layer); }

      //! Get the clip rectangle in object coordinates
      const DRECT2D& GetObjectClipRect (
         ) const { return (this->ObjClipRect); }

      //! Get surface Z coordinates for array of points.
      ERRVALUE GetSurfaceZ (
         DPOINT3D* points,                   //!< Array of points with X/Y coordinates in layer associated with context
         INT32 NumPoints                     //!< Number of points
         ) const;

      //! Get surface Z coordinates for POLYLINE.
      ERRVALUE GetSurfaceZ (
         POLYLINE& polyline                  //!< 3D polyline
         ) const;

      //! Get transformation from 'layer' to 'device' coordinates.
      const TRANS2D_MAPGEN& GetTransLayerDevice (
         ) const { return (m_Trans); }

      //! Get transformation from 'layer' to 'surface' coordinates.
      const TRANS2D_MAPGEN& GetTransLayerSurface (
         ) const { return (m_ObjToSurf); }

      //! Determine if layer is 'hidden' due to scale or other visibility setting.
      bool IsHidden (
         ) const { return (m_IsHidden); }

      //! Send notification before drawing element.
      void NotifyDrawElementBegin (
         const RVC::ELEMENT& element
         ) const { view->NotifyDrawElementBegin(layer,element); }

      //! Send notification before drawing element.
      void NotifyDrawElementBegin (
         ELEMTYPE ElemType,
         INT32 ElemNum
         ) const { view->NotifyDrawElementBegin(layer,RVC::ELEMENT(ElemNum,ElemType)); }

      //! Send notification after drawing element.
      void NotifyDrawElementEnd (
         const RVC::ELEMENT& element
         ) const { view->NotifyDrawElementEnd(layer,element); }

      //! Send notification after drawing element.
      void NotifyDrawElementEnd (
         ELEMTYPE ElemType,
         INT32 ElemNum
         ) const { view->NotifyDrawElementEnd(layer,RVC::ELEMENT(ElemNum,ElemType)); }

      //! Set transformation from 'layer' to 'device' coordinates.
      void SetTransLayerDevice (
         const TRANS2D_MAPGEN& tmg
         ) { m_Trans = tmg; }

      //! Setup for drawing in 2D.
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      ERRVALUE Setup2D (
         );

      //! Setup for drawing in 3D.
      //! @return TRUE if visible, FALSE if not, < 0 if error.
      ERRVALUE Setup3D (
         const GRE_VIEWPOINT3D& ViewPoint,
         int ViewIndex = 0
         );

      //! Translate 3D point to display coordinates.
      //! @return TRUE if point visible, FALSE if not, < 0 if error.
      int TransPoint3D (
         DPOINT3D& ipoint,                   //!< Point in layer coordinates, Z value may be altered if surface reference used
         DPOINT3D& opoint                    //!< Point in display coordinates with canonical depth returned
         ) const;

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      TRANS2D_MAPGEN m_Trans;
      TRANS2D_MAPGEN m_ObjToSurf;                     //!< Transformation from object to surface for 3D
      REGION2D m_ClipRegion;
      bool m_CheckVisible;
      bool m_IsHidden;

      GRE_LAYERDC (const GRE_LAYERDC&);
      GRE_LAYERDC& operator= (const GRE_LAYERDC&);
      
      virtual ERRVALUE OnClip (const POLYLINE& PolyLine);

      #endif //!< GENERATING_DOXYGEN_OUTPUT
   };

//===================================================================================================================

#endif   //!< INC_GRE_LAYERDC_H

---