layout.h

Go to the documentation of this file.

/**
 * \file gre/layout.h
 * \brief GRE::LAYOUT definitions
 *
 * \if NODOC
 * $Id: layout.h_v 1.16 2004/06/28 17:53:24 mju Exp $
 *
 * $Log: layout.h_v $
 * Revision 1.16  2004/06/28 17:53:24  mju
 * Convert to spatref system.
 *
 * Revision 1.15  2004/03/26 16:47:19  mju
 * Add optional parm for addGroupLayer to return pointer to layer.
 *
 * Revision 1.14  2004/03/26 15:25:31  mju
 * Add addGroupLayer variant with no control dialog.
 *
 * Revision 1.13  2004/03/05 22:36:58  mju
 * Make activegroup, prevlayout, nextlayout private.
 *
 * Revision 1.12  2004/03/05 21:49:35  mju
 * Add getNext().
 *
 * Revision 1.11  2004/02/06 16:01:41  mju
 * Use GRE_FIND_FLAGS.
 *
 * Revision 1.10  2003/11/12 22:41:52  mju
 * Use serializer to log errors instead of group.
 *
 * Revision 1.9  2003/11/10 18:43:48  mju
 * REmove savefilename/inode as need in base.
 *
 * Revision 1.8  2003/11/04 18:43:28  mju
 * Add DlgObjMgr overrides.
 *
 * Revision 1.7  2003/10/10 13:04:02  mju
 * *** empty log message ***
 *
 * Revision 1.6  2003/10/01 22:21:04  dwilliss
 * doxygen
 *
 * Revision 1.5  2003/09/15 15:48:00  dwilliss
 * No!  I wanted to check out mgui\layout.h
 *
 * Revision 1.4  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.3  2003/08/29 20:14:18  mju
 * Add v_GetExtents.
 *
 * Revision 1.2  2003/07/30 15:20:34  mju
 * Ignore private section.
 *
 * Revision 1.1  2003/06/16 19:39:47  mju
 * Initial revision
 * \endif
**/

#ifndef  INC_GRE_LAYOUT_H
#define  INC_GRE_LAYOUT_H

#ifndef  INC_GRE_VIEWABLE_H
   #include <gre/viewable.h>
#endif

#ifndef  INC_GRE_LAYER_H
   #include <gre/layer.h>
#endif

#ifndef INC_MI32_MPLAYOUT_H
   #include <mi32/mplayout.h>
#endif

#ifndef  INC_MI32_MATTE_H
   #include <mi32/matte.h>
#endif


#define  POSNMODE_Tiled          0
#define  POSNMODE_Overlapped     1
#define  POSNMODE_MapLayout      2

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

class GRE_LAYOUT : public GRE_VIEWABLE, public SERIALIZABLE {

   public:

      //! Flags used in creation
      enum CREATEFLAGS {
         CREATEFLAG_None =       0x00,
         CREATEFLAG_Hardcopy =   0x10     //!< Create layout in "hardcopy" mode
         };

      GRE_GROUP* firstgroup;              //!< First group in layout
      GRE_GROUP* lastgroup;               //!< Last group in layout
      UINT8 PosnMode;                     //!< Positioning mode, POSNMODE_...
      UINT8 ElemSelectMode;               //!< Element selection mode
      LAYOUTPARMS HardcopyLayout;         //!< Used in map/poster layout mode
      double PosnScale;                   //!< Scale used for attachment offsets in group positioning (eg. 24000)
      DRECT2D FullExtents;                //!< Extents of entire layout in layout coordinates

      //! Get first layout in GRE system.
      static GRE_LAYOUT* GetFirst (
         ) { return (s_FirstLayout); }

   #ifdef X_NATIVE
      //! Get layout from object attached to Widget userData
      static GRE_LAYOUT* GetFromWidget (
         Widget w
         );
   #endif

      //! Install SML class, called by internal SML function.
      static void SMLClassInstall (
         SMLCONTEXT *context                    //!< SML context
         );

      //! Constructor.
      explicit GRE_LAYOUT (
         CREATEFLAGS flags = CREATEFLAG_None
         );

      //! Destructor.
      virtual ~GRE_LAYOUT ();

      //! Dialog to add single-layer group and layer of specified type.
      //! Should only be used for single-layer-group types (eg scalebar, text, legend).
      ERRVALUE AddGroupLayer (
         MDLGPARENT dlgparent,
         GRE_LAYER::TYPE layertype
         );

      //! Add single-layer group and layer of specified type.
      //! Should only be used for single-layer-group types (eg scalebar, text, legend).
      ERRVALUE AddGroupLayer (
         GRE_LAYER::TYPE layertype,             //! Type of layer to create
         GRE_LAYER **player = 0                 //! Pointer to layer returned
         );

      //! Dialog to prompt user for objects and add as multiple groups.
      ERRVALUE AddGroupMulti (
         MDLGPARENT dlgparent
         );

      //! Dialog to prompt user for saved group and add to layout.
      int AddGroupSaved (
         MDLGPARENT dlgparent,
         bool fromtext
         );

      //! Create new group in this layout
      ERRVALUE CreateGroup (
         GRE_GROUP **retgroup,                  //!< New group returned
         UINT32 flags = 0,
         GRE_GROUP *refgroup = 0                //!< Reference group for InsertBefore/InsertAfter
         );

      //! Destroy all groups in this layout
      //! This method must not be used if any groups exist which have been created on the stack.
      void DestroyAllGroups (
         );

      //! Draw all views of this layout
      virtual ERRVALUE DrawAllViews (
         UINT32 drawflags = 0
         );

      //! Find layer using unique ID.
      virtual GRE_LAYER *FindLayerByID (
         UINT32 LayerID
         ) const;

      //! Find group containing specified point
      GRE_GROUP* FindPointGroup (
         const DPOINT2D& point,
         GRE_FIND_FLAGS findflags,
         const SPATREF::COORDREFSYS *pPointCRS = NULL
         ) const;

      //! Get active group for this layout
      GRE_GROUP* GetActiveGroup (
         ) const { return (m_ActiveGroup); }

      //! Get first group in layout.
      GRE_GROUP* GetFirstGroup (
         ) const { return (firstgroup); }

      //! Get full layout name
      virtual void GetFullName (
         MISTRING& name                         //!< Name returned
         ) const;

      //! Get "margin" rectangle in layout (page) coordinates
      DRECT2D GetHardcopyMarginRect (
         ) const {
         DRECT2D MarginRect;
         MarginRect.xinit = HardcopyLayout.LeftMargin;
         MarginRect.xlast = MarginRect.xinit + HardcopyLayout.FullPrintableWidth;
         MarginRect.ylast = HardcopyLayout.FullHeight - HardcopyLayout.TopMargin;
         MarginRect.yinit = MarginRect.ylast - HardcopyLayout.FullPrintableHeight;
         return (MarginRect);
         }

      //! Get "page" rectangle in layout (page) coordinates
      DRECT2D GetHardcopyPageRect (
         ) const {
         DRECT2D PageRect;
         PageRect.xinit = PageRect.yinit = 0.0;
         PageRect.xlast = HardcopyLayout.FullWidth;
         PageRect.ylast = HardcopyLayout.FullHeight;
         return (PageRect);
         }

      //! Get "printable" rectangle in layout (page) coordinates
      DRECT2D GetHardcopyPrintableRect (
         ) const {
         DRECT2D PrintableRect;
         PrintableRect.xinit = PrintableRect.yinit = 0.0;
         PrintableRect.xlast = HardcopyLayout.FullPrintableWidth;
         PrintableRect.ylast = HardcopyLayout.FullPrintableHeight;
         return (PrintableRect);
         }

      //! Get hardcopy layout scale.
      double GetHardcopyScale (
         ) const { return (HardcopyLayout.Scale); }

      //! Get hardcopy zoom factor.
      double GetHardcopyZoom (
         ) const { return (HardcopyLayout.Zoom); }

      //! Get last group in layout.
      GRE_GROUP* GetLastGroup (
         ) const { return (lastgroup); }

      //! Get matte reference for layout.
      MATTE& GetMatte (
         ) { return (m_Matte); }

      //! Get next layout.
      GRE_LAYOUT* GetNext (
         ) const { return (m_NextLayout); }

      //! Get next available unique ID.
      virtual UINT32 GetNextLayerID (
         ) const;

      //! Get group positioning mode.
      UINT8 GetPosnMode (
         ) const { return (PosnMode); }

      //! Compute dimensions of object based on scale and georeference
      virtual ERRVALUE GetSizeMeters (
         DPOINT2D& sizemeters                   //!< Size returned in meters
         );

      //! Return true if Auto-Redraw toggle is set on the Group Controls dialog.
      bool GroupControlsGetAutoRedraw (
         ) const;

      //! Return the units for measurements in the Layout tab of the Group Controls dialog.
      int GroupControlsGetLayoutUnits (
         ) const;

      //! Determine if the Group Controls dialog is open.
      bool GroupControlsIsOpen (
         ) const;

      //! Open the Group Controls dialog.
      //! If already open, it is brought to the front.
      //! If group passed in is NULL (default) use the Active group.
      void GroupControlsOpen (
         MDLGPARENT dlgparent = 0,     //!< Parent (0 to use default)
         GRE_GROUP* group = 0,         //!< Group to show initially,
         UINT32 flags = 0              //!<  MDISP_GCP_Xxxx
         );

      //! Set the values of the size, spacing and relative zoom prompts in the Group Controls dialog.
      //!
      //! This is used to temporarly change the values being reported in
      //! several of the prompts while a group is being moved or resized by
      //! an external tool.  It is assumed that when the user releases the mouse,
      //! the tool will actually modify the group and the prompts will be
      //! restored to new "real" values.
      //!
      //! This function should only be called by GRE_TOOL_PLACEMENT
      void GroupControlsSetPrompts (
         double hoffset,      //!< value for "Spacing" (horizontal)
         double hsize,        //!< value for "Width"
         double voffset,      //!< value for "Spacing" (vertical)
         double vsize,        //!< value for "Height"
         double relscale      //!< value for "Relative Zoom"
         );
      
      //! Set the group controls dialog (if open) to the "layout" tab
      void GroupControlsSetTabLayout (
         );

      //! Determine if layout has any layers
      virtual bool HasLayers (
         ) const;

      //! Determine if layout has any "temporary" layers.
      bool HasTempLayers (
         ) const;

      //! Determine if layout is currently being loaded.
      bool IsBeingLoaded (
         ) const { return (m_pSerializer != 0); }

      //! Determine if layout is in "hardcopy" mode.
      bool IsHardcopy (
         ) const { return (PosnMode == POSNMODE_MapLayout); }

      //! Determine if layout is an existing GRE object.
      bool IsValid (
         ) const;

      //! Determine if layout should be kept in TNTserver cache.
      bool KeepInTNTserverCache (
         ) const { return (m_KeepInTNTserverCache); }

      //! Read from serialization
      virtual ERRVALUE SerialRead (
         SERIALIZER& serializer
         );

      //! Write values to serialization
      virtual ERRVALUE SerialWrite (
         SERIALIZER& serializer,
         const char *tagname = 0
         ) const;

      //! Set active group for layout.
      void SetActiveGroup (
         GRE_GROUP *group
         );

      //! Set whether layout should be retained in TNTserver cache.
      void SetKeepInTNTserverCache (
         bool keepInTNTserverCache
         ) {
         if (m_KeepInTNTserverCache != keepInTNTserverCache) m_IsModified = true;
         m_KeepInTNTserverCache = keepInTNTserverCache;
         }

      //! Set that layout has been modified.
      void SetModified (
         bool notify = true,                 //!< Set to invoke callbacks with "Changed" message
         bool ViewsNeedRedraw = true         //!< Set all views of layout as needing redraw
         );

      //! Set new layout name.
      int SetName (
         const UNICODE *newname
         );

      //! Set that group positions need to be recomputed.
      void SetNeedUpdatePositions (
         ) { m_NeedUpdatePositions = 1; }

      //! Set group positioning mode
      void SetPosnMode (
         UINT8 posnmode
         );

      //! Set hardcopy zoom to fit to page size.
      int SetZoomToFitPage (
         );

      //! Read from template (serialization)
      ERRVALUE TemplateRead (
         SERIALIZER& serializer
         );

      //! Write template to serialization
      ERRVALUE TemplateWrite (
         SERIALIZER& serializer
         );

      //! Recompute group positions.
      int UpdatePositions (
         bool ForceUpdate = true
         );

      //! Validate and correct group attachments.
      void ValidateGroupAttachments (
         );

   protected:

   #ifdef X_NATIVE
      //! Create initial set of items in object manager.
      virtual void ObjMgrInitItems (
         );
   #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      static GRE_LAYOUT *s_FirstLayout;
      static GRE_LAYOUT *s_LastLayout;

      static const SERIALIZER::ITEMDEF* SerialGetItemDef (
         SERIALIZER& serializer
         );

      static const SERIALIZER::ITEMDEF* TemplateGetItemDef (
         );

      GRE_GROUP* m_ActiveGroup;           // Currently active group for layout
      GRE_LAYOUT *m_PrevLayout;           // Pointer to "previous" layout if multiple layouts are in use
      GRE_LAYOUT *m_NextLayout;           // Pointer to "next" layout if multiple layouts are in use
      bool m_NeedUpdatePositions;         // Need to update positions of layout children
      bool m_KeepInTNTserverCache;        // Keep layout in TNTserver cache
      SERIALIZER *m_pSerializer;          // Serializer used while loading
      INT32 m_tilecols;
      INT32 m_tilerows;
      UNICODE m_name[16];                 // Layout name
      mutable UNICODE m_activegroupname[GRE_GROUP_NAMELEN];    // Name of active group used when saving/loading layout
      MATTE m_Matte;
   #ifdef X_NATIVE
      MXDHANDLE m_pDlgObjMgr;
   #endif

   #ifdef X_NATIVE
      virtual void OnNotifyGreObjMgr (const GRE_CALLBACK_MSG& msg);
   #endif

      //! GRE_OBJECT overrides.
   #ifdef X_NATIVE
      virtual void v_DlgObjMgrClose ();
      virtual ERRVALUE v_DlgObjMgrCreate (MDLGPARENT dlgparent, const MISTRING& title);
      virtual void v_DlgObjMgrDestroy ();
      virtual bool v_DlgObjMgrIsOpen () const;
      virtual void v_DlgObjMgrOpen ();
   #endif
      virtual bool v_Destroy (bool NotifyParent);
      virtual MICON v_GetIcon () const;
      virtual const char* v_GetTypeName () const;

      //! GRE_VIEWABLE overrides.
      virtual double v_GetDesignScale () const;
      virtual const DRECT2D& v_GetExtents () const;
      virtual void v_SetDesignScale (double DesignScale, bool notify);

      GRE_LAYOUT (const GRE_LAYOUT&);
      GRE_LAYOUT& operator= (const GRE_LAYOUT&);

      #endif // GENERATING_DOXYGEN_OUTPUT
   }; //! End of GRE_LAYOUT

DEFINE_ENUM_OPERATORS(GRE_LAYOUT::CREATEFLAGS);


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

#ifdef WIN32_MFC

class GRE_MFC_LAYOUT : public GRE_MFC_VIEWABLE {
   protected: //! create from serialization only
      GRE_MFC_LAYOUT();
      DECLARE_DYNCREATE(GRE_MFC_LAYOUT)

   public:

      GRE_LAYOUT* GetLayout (
         ) const {
         return (m_layout);
         }

   public:
      virtual ~GRE_MFC_LAYOUT();

   protected:
      GRE_LAYOUT *m_layout;

   protected:
      //! Generated message map functions
      //!{{AFX_MSG(GRE_MFC_LAYOUT)
      //!}}AFX_MSG
      DECLARE_MESSAGE_MAP()
   };

#endif

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

#endif   // INC_GRE_LAYOUT_H

---