lrregion.h

Go to the documentation of this file.

/**
 * gre/lrregion - GRE_LAYER_REGION class definition.
 *
 * \if NODOC
 * $Id: lrregion.h_v 1.11 2005/02/25 23:31:25 scowan Exp $
 *
 * $Log: lrregion.h_v $
 * Revision 1.11  2005/02/25 23:31:25  scowan
 * Added copy virtual method implementation.
 *
 * Revision 1.10  2005/02/14 21:39:56  mju
 * Use device in usesTransparency.
 *
 * Revision 1.9  2005/01/20 16:57:13  mju
 * Redesign layer type registration.
 *
 * Revision 1.8  2004/10/01 17:20:09  mju
 * Add dlgparent to assignObject.
 *
 * Revision 1.7  2004/06/28 17:53:56  mju
 * Convert to spatref system.
 *
 * Revision 1.6  2004/03/05 15:13:00  mju
 * Use virtual dtor for dispparm.
 *
 * Revision 1.5  2004/02/13 15:46:24  scowan
 * Fixed deprecated mgd items.
 *
 * Revision 1.4  2003/09/23 13:16:53  mju
 * Explicit init base in dispparm copy ctor.
 *
 * Revision 1.3  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.2  2003/07/30 15:25:59  mju
 * Ignore private sections.
 *
 * Revision 1.1  2003/06/13 22:09:27  scowan
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_LRREGION_H
#define  INC_GRE_LRREGION_H

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

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

class GRE_LAYER_REGION : public GRE_LAYER {
   public:

      // GRE_LAYER_REGION::DISPPARM
      class DISPPARM : public GRE_LAYER::DISPPARM {
         public:

            class DLG;

            RVC::OBJITEM m_ObjItem;
            RVC::OBJITEM m_ObjItemStyle;
            POLYSTYLE m_Style;

            DISPPARM ();
            DISPPARM (
               const DISPPARM& rhs
               ): GRE_LAYER::DISPPARM(rhs) { Copy(rhs); }
            virtual ~DISPPARM (
               ) { Free(); }

            DISPPARM& operator= (const DISPPARM& rhs) {
               if (this != &rhs) {
                  Free();
                  Copy(rhs);
                  }
               return (*this);
               }

            //! Set to use specified object.
            ERRVALUE SetObject (
               const RVCOBJITEM& objitem,    //!< Object to set
               GRE_LAYER_REGION* layer,
               bool keepsettings = false     //!< Retain current display settings
               );
               
         protected:
            virtual const SERIALIZER::ITEMDEF* SerialGetItemDef (SERIALIZER& serializer) const;

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            void Copy (const DISPPARM&);
            void Free ();
            static ERRVALUE SerializerCB_StyleFileName (SERIALIZER&, const SERIALIZER::ITEMDEF *, void *, SERIALIZER::ITEMDEF::ACTION);

            virtual ERRVALUE v_SetObjItem (const RVC::OBJITEM& objitem, bool replace);
            virtual ERRVALUE v_Validate ();
            friend class GRE_LAYER_REGION;
            #endif //!< GENERATING_DOXYGEN_OUTPUT
         }; // End of GRE_LAYER_REGION::DISPPARM

      //! Register this layer type
      static void RegisterType (
         );

      //! Construct layer and insert into list
      explicit GRE_LAYER_REGION (
         GRE_GROUP *group,                            //!< Group to contain layer
         CREATEFLAGS createflags = CREATEFLAG_None,   //!< Creation flags
         GRE::LISTPOS listpos = GRE::LISTPOS_Last,    //!< Position in list
         GRE_LAYER *reflayer = 0                      //!< Reference layer for insertion
         );

      //! Destructor.
      virtual ~GRE_LAYER_REGION ();

      //! Clear region.
      void ClearRegion (
         );

      //! Retrieve layer-specific display parameters.
      const DISPPARM& GetDispParm (
         ) const { return (m_dispparm); }

      //! Set layer-specific display parameters.
      //! This is the recommended method for changing how an existing layer is to be
      //! rendered.  Validation will be performed on the specified parameters and
      //! adjustments made to the layer's copy if necessary.  Use of this method
      //! usually result in a ChangeBegin / ChangeEnd message pair, and will also
      //! generate a ChangeObject message if the spatial object used in the layer
      //! is changed.
      ERRVALUE SetDispParm (
         const DISPPARM& dispparm               //!< Parameters to set
         );

      void SetRegion (
         const REGION2D& region
         );

   protected:

      DISPPARM m_dispparm;                      //!< Layer-specific display parameters

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      static void LegendMsgHandler (GRAPHICTREEITEM_MSG *msg);

      GRE_LEGEND_POLY m_Legend;

      int DrawSetup (void*, GRE_LAYERDC&);

      //! Overrides from GRE_LAYER.
   #ifdef WIN32_MFC
      virtual void v_AddTreeViewLegend (GRE_MFC_TREEVIEW& TreeView, HTREEITEM hParent, HTREEITEM hInsertAfter);
   #endif
      virtual ERRVALUE v_AssignObject (const RVC::OBJITEM& objitem, MDLGPARENT dlgparent);
   #if defined(X_NATIVE) || defined(WIN32_MFC)
      virtual int v_ControlPanel (MDLGPARENT dlgparent,UINT32 flags = 0);
   #endif
      virtual GRE_LAYER* v_Copy (GRE_GROUP *group) const;
      virtual ERRVALUE v_Draw (GRE_LAYERDC& layerdc);
      virtual const GRE_LEGEND* v_GetLegend (ELEMTYPE ElemType);
      virtual const RVC::OBJITEM& v_GetObjItem (int component) const;
   #ifdef WIN32_MFC
      virtual bool v_HasTreeViewLegend () const;
   #endif
   #if defined(X_NATIVE) || defined(WIN32_MFC)
      virtual ERRVALUE v_PromptObject (bool OpenCtrlPanel, MDLGPARENT dlgparent);
   #endif
      virtual const char* v_SerialGetTagName () const;
      virtual void v_SetDftName (bool ReplaceExisting);
      virtual void v_SetLegendSampleFlags (MGD::STYLESAMPLEFLAGS SampleFlags);
      virtual ERRVALUE v_SetStyleObjItem (const RVC::OBJITEM& ObjItem);
      virtual int v_UpdateExtents (bool forceupdate);
      virtual bool v_UsesTransparency (const MGD::DEVICE *pDevice = 0) const;

      GRE_LAYER_REGION (const GRE_LAYER_REGION&);
      GRE_LAYER_REGION& operator= (const GRE_LAYER_REGION&);
      
      class PRIVDRAWDATA;
      friend class PRIVDRAWDATA;
      friend class DISPPARM;

      #endif //!< GENERATING_DOXYGEN_OUTPUT     
   };


#endif   //!< INC_GRE_LRREGION_H

---