view.h

Go to the documentation of this file.

/**
 * \file view.h <gre/view.h>
 * \brief GRE VIEW classes
 *
 * \if NODOC
 * $Id: view.h_v 1.32 2004/11/29 17:29:06 mju Exp $
 *
 * $Log: view.h_v $
 * Revision 1.32  2004/11/29 17:29:06  mju
 * Add detach method and check for null viewable before deref in inlines.
 *
 * Revision 1.31  2004/09/09 23:11:14  ldyas
 * saves antialiasing
 *
 * Revision 1.30  2004/07/23 18:32:59  mju
 * Return error from updateExtents.
 *
 * Revision 1.29  2004/07/21 21:56:22  mju
 * Add layerview.
 *
 * Revision 1.28  2004/07/12 19:56:34  vdronov
 * added stereo optical and monitor separations
 *
 * Revision 1.27  2004/07/09 17:37:29  mju
 * Remove deprecated methods for trans to/from map coords.
 *
 * Revision 1.26  2004/07/08 13:31:05  mju
 * Update mfc view for spatref.
 *
 * Revision 1.25  2004/06/28 17:54:48  mju
 * Convert to spatref system.
 *
 * Revision 1.24  2004/04/15 15:48:43  mju
 * Add gre_ToolAddZoomSimple.
 *
 * Revision 1.23  2004/04/14 21:47:57  mju
 * Add GetMenuItemHotKeys.
 *
 * Revision 1.22  2004/03/05 20:27:06  mju
 * Allow getDrawingDevice/ContextMemory for non-X.
 *
 * Revision 1.21  2004/03/05 17:02:04  mju
 * Move sdisp/sgc/pdisp/pgc/mdisp/mgc to private section and add methods to access.
 *
 * Revision 1.20  2004/03/05 15:14:02  mju
 * Use virtual dtor if have virtual fn.
 *
 * Revision 1.19  2004/02/24 14:50:18  mju
 * Change updatemessage to use mistring.
 * Deprecate getname version returning unicode*.
 *
 * Revision 1.18  2004/02/13 15:32:16  dwilliss
 * deprecated old mgd
 *
 * Revision 1.17  2004/02/06 16:02:05  mju
 * Use GRE_FIND_FLAGS.
 *
 * Revision 1.16  2004/02/05 22:08:34  mju
 * Integrate datatip support.
 *
 * Revision 1.15  2004/02/02 20:57:39  scowan
 * Deprecated update message method that takes group and key.
 *
 * Revision 1.14  2003/12/22 20:20:26  mju
 * Add pDlgViewZoom.
 *
 * Revision 1.13  2003/11/20 13:27:02  mju
 * Add m_LastLayerDrawSingle.
 *
 * Revision 1.12  2003/10/31 18:26:54  mju
 * Remove updateColorsMem24.
 *
 * Revision 1.11  2003/10/28 23:59:11  ldyas
 * adding thin line hinting controls.
 * ,
 *
 * Revision 1.10  2003/10/24 21:44:16  ldyas
 * antialiasing now optional
 *
 * Revision 1.9  2003/10/06 20:47:11  mju
 * Add v_OnDraw... overridables.
 *
 * Revision 1.8  2003/09/25 21:22:24  dwilliss
 * Don't capitalize enum any more. Genitor needed it, doxygen doesn't like it
 *
 * Revision 1.7  2003/09/16 15:06:15  mju
 * Add updateextents method.
 *
 * Revision 1.6  2003/09/15 13:48:59  fileserver!dwilliss
 * Doxygen
 *
 * Revision 1.5  2003/07/30 15:47:39  mju
 * Ignore private sections.
 *
 * Revision 1.4  2003/07/29 15:34:51  mju
 * Add UpdateScriptUI.
 *
 * Revision 1.3  2003/06/30 20:09:03  mju
 * Add more methods to deal with macroscripts.
 *
 * Revision 1.2  2003/06/25 14:35:19  scowan
 * Added lat lon include file.
 *
 * Revision 1.1  2003/06/24 16:24:54  mju
 * Initial revision
 *
 * \endif
**/

#ifndef  INC_GRE_VIEW_H
#define  INC_GRE_VIEW_H

#if !defined(INC_MI32_STDAFX_H) && defined(WIN32_MFC)
   #include <mi32/stdafx.h>
#endif

#if !defined(_OXTOOLTIPCTRL_H__) && defined(WIN32_MFC)
   #include <mgui/oxttctrl.h>
#endif

#if !defined(INC_MI32_GRTOOL_H) && defined(WIN32_MFC)
   #include <mi32/grtool.h>
#endif

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

#ifndef  INC_GRE_VIEWSCRIPT_H
   #include <gre/viewscript.h>
#endif

#ifndef  INC_GRE_GEOLOCK_H
   #include <gre/geolock.h>
#endif

#if !defined(INC_MI32_XDEFNS_H) && defined(X_NATIVE)
   #include <mi32/xdefns.h>
#endif

#ifndef  INC_MI32_SERIALIZ_H
   #include <mi32/serializ.h>
#endif

#ifndef INC_MI32_TRANS2DC_H
   #include <mi32/trans2dc.h>
#endif

#ifndef INC_MI32_UNITCONV_H
   #include <mi32/unitconv.h>
#endif

#ifndef INC_MI32_MXSTEREO_H
   #include <mi32/mxstereo.h>
#endif

#ifndef INC_MI32_GRTREE_H
   #include <mi32/grtree.h>
#endif

#ifndef INC_MI32_LATLONFM_H
   #include <mi32/latlonfm.h>
#endif

#include <map>


#ifndef GENERATING_DOXYGEN_OUTPUT

namespace RVC {
   class ELEMENT;
   }

namespace GRE {
   class DLG_VIEWZOOM;
   }

namespace MGD {
   class DEVICE;
   class DEVICE_MEM24;
   class DEVICE_X;
   class CONTEXT;
   }

namespace MGUI {
   class CTRL_TOOLTIP;
   }

union SMLARG;

#endif


enum GRE_PROJACCUR {
   GRE_PROJACCUR_Affine =  1,       //!< Always use affine transformation to approximate
   GRE_PROJACCUR_Exact =   2,       //!< Perform exact projection transformation (slowest for all object types)
   GRE_PROJACCUR_Auto =    3,       //!< Do automatic determination between affine and exact
   };

enum VIEWFLAGS {
   VIEWFLAG_None =                  0,
   VIEWFLAG_Locator =               0x00000001, //!< Locator view
   VIEWFLAG_3D =                    0x00000002, //!< View is 3D
   VIEWFLAG_ForceOneToOne =         0x00000004, //!< Force zoom so first raster shown at 1 cell/pixel
   VIEWFLAG_ScaleOneToOne =         0x00000008, //!< Set zoom so first raster shown at 1 cell/pixel
   VIEWFLAG_AllowDiffZoom =         0x00000010, //!< Allow different X/Y zooming
   VIEWFLAG_Hardcopy =              0x00000020, //!< Hardcopy view
   VIEWFLAG_DisableHotKeys =        0x00000040, //!< Disable hot keys for view window
   VIEWFLAG_NoDrawLayers =          0x00000080, //!< Don't draw any layers in view
   VIEWFLAG_NoDestroyShell =        0x00000100, //!< Don't destroy Shell containing view when view destroyed
   VIEWFLAG_DidAttach =             0x00000200, //!< Widget attachment done when view was created
   VIEWFLAG_DialogModal =           0x00000400, //!< View dialog is modal
   VIEWFLAG_AllowGeoLock =          0x00000800, //!< Allow GeoLocking
   VIEWFLAG_NoCloseOption =         0x00001000, //!< Don't include View/Close menu option
   VIEWFLAG_DestroyOnClose =        0x00002000, //!< Destroy view when user selects View/Close
   VIEWFLAG_NoSetPixmapBG =         0x00004000, //!< Don't set backgroundPixmap for DrawingArea
   VIEWFLAG_NoSetPrevViewPos =      0x00008000, //!< Don't set "previous view position" when draw
   VIEWFLAG_DisableDataTips =       0x00010000, //!< Disable datatips for this view
   VIEWFLAG_AutoPanGPS =            0x00040000, //!< Auto-pan view to GPS if available
   VIEWFLAG_NoBlankScreen =         0x00080000, //!< Don't blank screen while drawing view
   VIEWFLAG_NoEditColorHighlight =  0x00100000, //!< Don't allow editing of selected/active colors
   VIEWFLAG_NoFillBackground =      0x00200000, //!< Don't fill background before rendering, used for raster
   VIEWFLAG_NoShowTrackingCursor =  0x00800000, //!< Don't display "tracking" cursor in this view
   VIEWFLAG_NoLegendView =          0x01000000, //!< Don't create LegendView
   VIEWFLAG_AlwaysTestCancel =      0x02000000, //!< Test for cancel from status even if not drawing
   VIEWFLAG_NoDrawOtherViews =      0x04000000, //!< Don't draw other views when this view is drawn
   VIEWFLAG_NoShowInLocator =       0x08000000, //!< Don't show this view in locator tool

   VIEWFLAG_SaveMask =              (VIEWFLAG_AllowDiffZoom)
   };
DEFINE_ENUM_OP_BITWISE(VIEWFLAGS);

#define  GRE_MaxPrevViews  10             //!< Maximum number of "previous views" to retain

//! Flags for VIEW::GetIconItemView() and VIEW::AddDftViewIcons()
#define  MDISPICONVIEW_ViewFull        0x00000001
#define  MDISPICONVIEW_ViewPrevious    0x00000002
#define  MDISPICONVIEW_ViewPrevZoom    0x00000004
#define  MDISPICONVIEW_ViewZoomIn      0x00000008
#define  MDISPICONVIEW_ViewZoomOut     0x00000010
#define  MDISPICONVIEW_ViewZoom1X      0x00000020
#define  MDISPICONVIEW_ViewZoomToGroup 0x00000040
#define  MDISPICONVIEW_ViewZoomToLayer 0x00000080
#define  MDISPICONVIEW_ViewLocator     0x00000100
#define  MDISPICONVIEW_ViewSnapshot    0x00000200
#define  MDISPICONVIEW_ViewZoom2X      0x00000400
#define  MDISPICONVIEW_ViewZoom3X      0x00000800
#define  MDISPICONVIEW_ViewGeoLock     0x00001000
#define  MDISPICONVIEW_ViewZoomToLoc   0x00002000
#define  MDISPICONVIEW_ViewDefault     0x000030FF

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

//! Base class for tools attached to view.
class GRE_TOOL {
   public:

      //! Standard constructor.
      GRE_TOOL (
         GRE_VIEW *view,                        //!< View to associate tool with
   #ifdef WIN32_NATIVE
         const char *toolname                   //!< Tool name string, cannot be NULL
   #else
         const char *toolname,                  //!< Tool name string, cannot be NULL
         const char *iconname,                  //!< Tool icon name
         const char *icongroup=NULL,            //!< Tool icon group
         const char *helpcode=NULL              //!< Help code for context-sensitive help
   #endif
         );

      //! Constructor with interface component IDs.
      GRE_TOOL (
         GRE_VIEW *view,                        //!< View to associate tool with
         ICID icidmenu,                         //!< Interface component ID for menu customization
         ICID icidicon,                         //!< Interface component ID for ToolBar customization
   #ifdef WIN32_NATIVE
         const char *toolname                   //!< Tool name string, cannot be NULL
   #else
         const char *toolname,                  //!< Tool name string, cannot be NULL
         const char *iconname,                  //!< Tool icon name
         const char *icongroup=NULL,            //!< Tool icon group
         const char *helpcode=NULL              //!< Help code for context-sensitive help
   #endif
         );

      virtual ~GRE_TOOL ();

      //! Activate this tool.
      void Activate (
         );

      //! Deactivate this tool.
      void Deactivate (
         );

   #ifdef X_NATIVE
      //! Get "help code" associated with tool.
      const char* GetHelpCode (
         ) const { return (m_HelpCode); }

      //! Get "icon group" for tool.
      const char* GetIconGroup (
         ) const { return (m_IconGroup); }

      //! Get "icon name" for tool.
      const char* GetIconName (
         ) const { return (m_IconName); }
   #endif

      //! Get tool name.
      const char* GetName (
         ) const { return (m_ToolName); }

      //! Get view this tool is attached to.
      GRE_VIEW* GetView (
         ) const { return (m_view); }

   #ifdef X_NATIVE
      //! Get widget for item on view's "Tool" menu.
      Widget GetMenuWidget (
         ) const { return (m_MenuWidget); }

      //! Get widget for button on view's toolbar.
      Widget GetToolbarWidget (
         ) const { return (m_ToolbarWidget); }
   #endif

      //! Determine if tool is currently disabled.
      bool IsDisabled (
         ) const { return (m_IsDisabled); }

      //! Determine if tool is implemented via script.
      //! This should only be overridden by the script tool.
      virtual bool IsScript (
         ) const;

   #ifdef X_NATIVE
      //! Setup BUTTONITEM for use in toolbar.
      void SetupButtonItem (
         BUTTONITEM& item
         );

      //! Setup MENUITEM to use on menu to activate tool.
      void SetupMenuItem (
         MENUITEM& item
         );

      //! Set sensitivity of tool menu item and button.
      void SetSensitive (
         bool sensitive = true
         );
   #endif

      //! Suspend tool (during screen update).
      //! @return true if suspended, false if was already suspended
      bool Suspend (
         );

      //! Resume tool (after screen update)
      void Resume (
         );

   protected:

      GRE_VIEW* m_view;                      //!< View tool is contained in

      void SetName (
         const MISTRING& name
         ) { m_ToolNameStr = name; }

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT

      enum TOOLSTATE {
         STATE_NotInitialized = 0,
         STATE_Inactive,
         STATE_Active,
         STATE_NoLayers,
         STATE_Suspended
         };

      char *m_ToolName;
   #ifdef X_NATIVE
      char *m_IconName;
      char *m_IconGroup;
      char *m_HelpCode;
   #endif
      TOOLSTATE m_state;
      bool m_IsDisabled;
      ICID m_icidmenu;                       //!< ID for tool menu item
      ICID m_icidicon;                       //!< ID for tool icon on ToolBar
   #ifdef X_NATIVE
      Widget m_MenuWidget;
      Widget m_ToolbarWidget;
   #endif
      MISTRING m_ToolNameStr;

      #endif // GENERATING_DOXYGEN_OUTPUT

      // Overridables

      virtual bool DoActivate () = 0;
      virtual void DoDeactivate () = 0;
      virtual bool DoInitialize ();
      virtual void DoSuspend ();
      virtual void DoResume ();
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
//! Implement old-style tools.
class _MDISPTOOL : public GRE_TOOL {
   public:

      void *privptr;
      GRE_VIEW *view;

      _MDISPTOOL (
         GRE_VIEW *view,
         const char *toolname,
         const char *iconname,
         const char *icongroup,
         const char *helpcode,
         int (*Init)(_MDISPTOOL*),
         int (*Stop)(_MDISPTOOL*),
         int (*Activate)(_MDISPTOOL*),
         int (*Deactivate)(_MDISPTOOL*),
         int (*Suspend)(_MDISPTOOL*),
         int (*Resume)(_MDISPTOOL*)
         );

      _MDISPTOOL (
         GRE_VIEW *view,
         const char *toolname,
         const char *iconname,
         const char *icongroup,
         const char *helpcode,
         ICID icidmenu,
         ICID icidicon,
         int (*Init)(_MDISPTOOL*),
         int (*Stop)(_MDISPTOOL*),
         int (*Activate)(_MDISPTOOL*),
         int (*Deactivate)(_MDISPTOOL*),
         int (*Suspend)(_MDISPTOOL*),
         int (*Resume)(_MDISPTOOL*)
         );

      virtual ~_MDISPTOOL ();

   private:

      virtual bool DoActivate ();
      virtual void DoDeactivate ();
      virtual bool DoInitialize ();
      virtual void DoSuspend ();
      virtual void DoResume ();

      int (*OldInit)(_MDISPTOOL*);
      int (*OldStop)(_MDISPTOOL*);
      int (*OldActivate)(_MDISPTOOL*);
      int (*OldDeactivate)(_MDISPTOOL*);
      int (*OldSuspend)(_MDISPTOOL*);
      int (*OldResume)(_MDISPTOOL*);
   };
typedef _MDISPTOOL *MDISPTOOL;
#endif // GENERATING_DOXYGEN_OUTPUT

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

class GRE_VIEW : public GRE_OBJECT {

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class STATUSINFO;
      #endif // GENERATING_DOXYGEN_OUTPUT

   public:

      enum COORDSOURCE {
         COORDSOURCE_None,
         COORDSOURCE_Mouse,
         COORDSOURCE_ViewCenter,
         COORDSOURCE_Entered,
         COORDSOURCE_GPS,
         COORDSOURCE_COUNT
         };

      enum DATATIPSELECTION {
         DATATIPSELECTION_FromView =      0, //!< Use selection set by view
         DATATIPSELECTION_None =          1, //!< No DataTips
         DATATIPSELECTION_ActiveLayer =   2, //!< Select for active layer only
         DATATIPSELECTION_AllLayers =     3, //!< Select for all layers
         DATATIPSELECTION_AllVisible =    4  //!< Select for all 'visible' layers
         };

      // GRE_VIEW::GLOBALOPTIONS --------------------------------------------------------------------------
      //! Options which apply to all views in current process
      class GLOBALOPTIONS {
         public:

            class FORM;                         //!< Global options form, defined in <gre/uivwglob.h>

            GLOBALOPTIONS (                     //! Constructor
               );

            ~GLOBALOPTIONS () {}                //! Destructor
            
         #ifdef X_NATIVE
            Widget CreateEditForm (
               Widget parent,
               const Arg *arglist,
               int argcount
               );
         #endif

            bool GetAutoOpen3dViewCtrl () const { return (m_AutoOpen3dViewCtrl); }
            int GetAutoRedrawDelay () const { return (m_AutoRedrawDelay); }
            bool GetDefaultGeoLocked () const { return (m_DefaultGeoLocked); }
            bool GetDrawLayerOnUnhide () const { return (m_DrawLayerOnUnhide); }
            bool GetRedrawOnAnyChange () const { return (m_RedrawOnAnyChange); }
            bool GetUseAntialiasing() const {return (m_UseAntialiasing); }
            bool GetThinLineWidthHinting() const {return (m_ThinLineWidthHinting); }
            UINT16 GetRefreshInterval () const { return (m_RefreshInterval); }
            bool GetTrackCursor () const { return (m_TrackCursor); }
            const COLOR& GetTrackCursorColor () const { return (m_TrackCursorColor); }
            bool GetUpdateAfterDrawLayer () const { return (m_UpdateAfterDrawLayer); }
            bool GetZoomPanWaitForRMB () const { return (m_ZoomPanWaitForRMB); }

            void IniRead (                      //! Read settings from Ini file
               const char *inigroup = 0
               );

            void IniWrite (                     //! Write settings to Ini file
               const char *inigroup = 0
               ) const;

            void SetAutoOpen3dViewCtrl (bool AutoOpen3dViewCtrl) { m_AutoOpen3dViewCtrl = AutoOpen3dViewCtrl; }
            void SetAutoRedrawDelay (int AutoRedrawDelay) { m_AutoRedrawDelay = AutoRedrawDelay; }
            void SetUseAntialiasing (bool Antialias) { m_UseAntialiasing = Antialias; }
            void SetThinLineWidthHinting (bool hint) { m_ThinLineWidthHinting = hint; }
            void SetDefaultGeoLocked (bool DefaultGeoLocked) { m_DefaultGeoLocked = DefaultGeoLocked; }
            void SetDrawLayerOnUnhide (bool DrawLayerOnUnhide) { m_DrawLayerOnUnhide = DrawLayerOnUnhide; }
            void SetRedrawOnAnyChange (bool RedrawOnAnyChange) { m_RedrawOnAnyChange = RedrawOnAnyChange; }
            void SetRefreshInterval (UINT16 RefreshInterval) { m_RefreshInterval = RefreshInterval; }
            void SetTrackCursor (bool TrackCursor) { m_TrackCursor = TrackCursor; }
            void SetTrackCursorColor (const COLOR& TrackCursorColor) { m_TrackCursorColor = TrackCursorColor; }
            void SetUpdateAfterDrawLayer (bool UpdateAfterDrawLayer) { m_UpdateAfterDrawLayer = UpdateAfterDrawLayer; }
            void SetZoomPanWaitForRMB (bool ZoomPanWaitForRMB) { m_ZoomPanWaitForRMB = ZoomPanWaitForRMB; }

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT
            bool m_RedrawOnAnyChange;              //!< Redraw view when any change made to object in view
            bool m_DrawLayerOnUnhide;              //!< Redraw single layer when unhidden
            bool m_UseAntialiasing;                //!< Render lines as antialiased
            bool m_ThinLineWidthHinting;           //!< Show thin lines as transparent
            bool m_UpdateAfterDrawLayer;           //!< Update display after each layer is drawn
            bool m_EnableTransparency;             //!< Always enable transparency effects
            bool m_TrackCursor;                    //!< Track cursor between views
            bool m_ZoomPanWaitForRMB;              //!< Wait for right mouse button (or <Enter>) to activate zoom/pan tool
            bool m_AutoOpen3dViewCtrl;             //!< Automatically open viewpoint controls for 3D view
            bool m_DefaultGeoLocked;               //!< Default views to be geolocked
            UINT16 m_RefreshInterval;              //!< Refresh interval for updates while layer is being drawn
            COLOR m_TrackCursorColor;              //!< Color of "tracking" cursor
            int m_AutoRedrawDelay;                 //!< Delay for auto-redraw after change (milliseconds)

            friend class GRE_VIEW;
            #endif // GENERATING_DOXYGEN_OUTPUT
         }; // End of GRE_VIEW::GLOBALOPTIONS.

      class SAVESETTINGS : public SERIALIZABLE {
         public:

            SAVESETTINGS ();
            virtual ~SAVESETTINGS ();

            void IniRead (INIHANDLE handle, const char *inigroup);
            void IniWrite (INIHANDLE handle, const char *inigroup);

         private:
            #ifndef GENERATING_DOXYGEN_OUTPUT

            struct STATUSPOS {
               bool m_Show;
               UINT8 m_UnitCode;
               SPATREF::COORDREFSYS m_CoordRefSys;
               DEGTOSTRFLAGS m_LatLonFormat;
               static const SERIALIZER::ITEMDEF* SerialGetItemDef ();
               STATUSPOS ();
               };

            STATUSPOS m_StatusPos1;
            STATUSPOS m_StatusPos2;

            static const SERIALIZER::ITEMDEF* SerialGetItemDef ();

            //! Overrides from SERIALIZABLE.
            virtual ERRVALUE SerialRead (SERIALIZER& serializer);
            virtual ERRVALUE SerialWrite (SERIALIZER& serializer, const char *tagname = 0) const;

            friend class GRE_VIEW;
            friend class STATUSINFO;
            friend struct STATUSPOS;
            #endif // GENERATING_DOXYGEN_OUTPUT
         };

      // GRE_VIEW::VIEWPOSN -------------------------------------------------------------------------------
      //! Position of "view" relative to "display"
      class VIEWPOSN {
         public:
            MAT3X3 ViewToDisp, DispToView;         //!< Transformations between View and "Display"
            DPOINT2D centerpoint;                  //!< Point in "view coordinates" at center of view
            DPOINT2D zoom;                         //!< Zoom factor, full view = 1.0
            DPOINT2D usedzoom;                     //!< Actual zoom factor used after adjustments
            double MapScale;                       //!< Map scale for current view
         
            VIEWPOSN ();
         };

      MGD::DEVICE* gdisp;                    //!< Generic display handle for drawing
      MGD::CONTEXT *ggc;                     //!< Generic graphic context for drawing

      //! Edit global settings via dialog.
      //! @return true if settings changed, false if not.
      static bool EditGlobalSettings (
         MDLGPARENT dlgparent                   //!< Parent for dialog
         );

      //! Determine if layers should be drawn when unhidden
      static bool GetDrawLayerOnUnhide (
         ) { return (s_GlobalOptions.m_DrawLayerOnUnhide); }

      //! Retrieve first view of all views open
      static GRE_VIEW* GetFirst (
         ) { return (s_FirstView); }

      //! Return auto-redraw time delay.
      static int GetGlobalAutoRedrawDelay (
         ) { return (s_GlobalOptions.m_AutoRedrawDelay); };

      //! Get global options which apply to all views
      static const GLOBALOPTIONS& GetGlobalOptions (
         ) { InitStatic(); return (s_GlobalOptions); }
      
      //! Determine if should redraw views on any change
      static bool GetRedrawOnAnyChange (
         ) { return (s_GlobalOptions.m_RedrawOnAnyChange); }

      //! Get stereo viewing mode (for all views)
      static UINT8 GetStereoMode (
         ) { return (s_StereoParm.StereoMode); }

      //! Get stereo optical separation (for all views) in mm
      static double GetStereoOpticalSeparation (
         ) { return (s_StereoParm.OpticalSeparation); }

      //! Get stereo monitor separation (for all views) in mm
      static double GetStereoMonitorSeparation (
         ) { return (s_StereoParm.MonitorSeparation); }

      //! Determine if views should be updated to screen after each layer is rendered
      static bool GetUpdateAfterDrawLayer (
         ) { return (s_GlobalOptions.m_UpdateAfterDrawLayer); }

   
      //! Determine if should wait for right mouse-button before zoom/pan
      static bool GetZoomPanWaitForRMB (
         ) { return (s_GlobalOptions.m_ZoomPanWaitForRMB); }

      //! Determine if transparency is enabled
      static void SetEnableTransparency (
         bool EnableTransparency
         ) { s_GlobalOptions.m_EnableTransparency = EnableTransparency; }

      //! Set global auto-redraw delay.
      static void SetGlobalAutoRedrawDelay (
         int AutoRedrawDelay                    //!< Auto-redraw delay in milliseconds
         ) { s_GlobalOptions.m_AutoRedrawDelay = AutoRedrawDelay; }

      //! Set global options applying to all views.
      static void SetGlobalOptions (
         const GLOBALOPTIONS& options           //!< Options to set
         );

      //! Set global option for whether zoom/pan tools wait for right mouse button.
      static void SetGlobalZoomPanWaitForRMB (
         bool ZoomPanWaitForRMB
         ) { s_GlobalOptions.m_ZoomPanWaitForRMB = ZoomPanWaitForRMB; }

      //! Set option to redraw views on any change.
      static void SetRedrawOnAnyChange (
         bool RedrawOnAnyChange
         ) { s_GlobalOptions.m_RedrawOnAnyChange = RedrawOnAnyChange; }

      //! Set option for tracking cursor between views
      static void SetTrackCursor (
         bool TrackCursor
         ) { s_GlobalOptions.m_TrackCursor = TrackCursor; }

      //! Set option to update views after each layer is rendered
      static void SetUpdateAfterDrawLayer (
         bool UpdateAfterDrawLayer
         ) { s_GlobalOptions.m_UpdateAfterDrawLayer = UpdateAfterDrawLayer; }

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

      //! Default constructor.
      //! Performs initialization only, must use one of the Create methods to actually
      //! create a usable GRE_VIEW.
      GRE_VIEW ();

      //! Destructor.
      virtual ~GRE_VIEW ();

   #ifdef X_NATIVE
      //! Add default "view" icons (previous, zoom in, zoom out, zoom 1X, etc).
      void AddDftViewIcons (
         UINT32 flags = 0                       //!< MDISPICONVIEW_... flags for desired icons
         );

      //! Add default "drawing" icons (redraw, skip, stop).
      void AddDrawIcons (
         UINT32 flags = 0                       //!< MDISPCREATE_ViewNoRedrawButton, MDISPCREATE_ViewNoSkipButton, MDISPCREATE_ViewNoCancelButton
         );

      //! Add icon buttons to icon row.
      Widget AddIconRowItems (
         const BUTTONITEM *items,               //!< Items to add
         const char *icongroup = 0,             //!< Icon group
         void *cbdata = 0,                      //!< Button item callback data if NULL in item
         void *userdata = 0                     //!< Button item userdata if NULL in item
         );

      //! Add icon pushbuttons to toolbar for MacroScripts.
      void AddMacroScriptIcons (
         );

      //! Add menu items for MacroScripts
      void AddMacroScriptMenuItems (
         );

      //! Add additional items to "Options" menu (must be added before menubar created)
      ERRVALUE AddMenuItemsOptions (
         const MENUITEM *newitems               //!< Array of items to add, terminated by null item
         );

      //! Add icon togglebuttons to toolbar for all defined tools.
      void AddToolIcons (
         bool addscripts = true                 //!< Add ToolScripts and MacroScripts to toolbar
         );

   #endif

      //! Attach LAYERVIEW instance.
      void AttachLayerView (
         GRE::LAYERVIEW *layerview
         );

      //! Cancel drawing of this view, usually done within callback.
      void CancelDrawing (
         int err = EUserCancel                  //!< Error value to set.
         ) { m_CancelDraw = err; }

      //! Clear view's message line.
      void ClearMessage (
         ) const;

      //! Clear previous view list.
      void ClearPreviousViewList (
         ) { m_PrevViewIndex = 0; return; }

      //! Determine if view contains specified layer.
      bool ContainsLayer (
         const GRE_LAYER *layer                 //!< Layer to check
         ) const;

      //! Convert between "screen units" using specified layer for scale.
      //! @return converted value.
      double ConvertScreenUnits (
         GRE_LAYER *layer,                      //!< Layer to use for scale
         double value,                          //!< Value to convert
         int iunits,                            //!< Input units (SCREENUNIT_...)
         int ounits                             //!< Output units (SCREENUNIT_...)
         );

      //! Default constructor.
      ERRVALUE Create (
         GRE_VIEWABLE *viewable,
         int iwidth,
         int iheight,
         UINT32 flags
         );

   #ifdef X_NATIVE
      //! Create menubar with specified set of items.
      //! @return RowColumn widget for menubar.
      Widget CreateMenuBar (
         Widget form,                           //!< Form to contain menubar
         MENUBARITEM *menubar,                  //!< Menu bar items
         UINT32 flags = 0                       //!< None presently defined
         );
   #endif

   #ifdef X_NATIVE
      //! Create menubar with default set of items.
      //! @return RowColumn widget for menubar.
      Widget CreateMenuBar (
         Widget form,                           //!< Form to contain menubar
         UINT32 flags = 0                       //!< None presently defined
         );
   #endif

   #ifdef X_NATIVE
      ERRVALUE CreateX (
         GRE_VIEWABLE *viewable,
         Widget pwidget,
         Arg *arglist,
         int argcount,
         int iwidth,
         int iheight,
         const char *sizefield,              //!< Field from .ini for retrieving window size
         UINT32 flags,
         const SAVESETTINGS *pSettings = 0
         );
   #endif

      //! Get DataTip selection mode.
      DATATIPSELECTION DataTipGetSelection (
         ) const { return (m_DataTipSelection); }

      //! Get DataTip string from specified point.
      ERRVALUE DataTipGetString (
         const DPOINT2D& point,                 //!< Point to obtain DataTip for
         MISTRING& string,                      //!< String to fill in, will be cleared first
         GRE_FIND_FLAGS findflags,              //!< GRE_FIND_ViewCoords or GRE_FIND_DisplayCoords
         int maxlines = 0,                      //!< Approximate maximum number of lines, 0 for no maximum
         DATATIPSELECTION selection = DATATIPSELECTION_FromView
         );

      //! Set DataTip selection mode.
      //! Does not affect currently visible DataTip if any.
      void DataTipSetSelection (
         DATATIPSELECTION selection             //!< Selection mode to set
         ) { m_DataTipSelection = selection; }

      //! Destroy LAYERVIEW instance for specified layer and this view.
      void DestroyLayerView (
         GRE_LAYER *layer
         );

      //! Detach view from viewable.
      //! Intended for use in viewable destructor only, other use may cause crash.
      void Detach (
         ) { m_viewable = 0; }

      //! Detach LAYERVIEW instance.
      void DetachLayerView (
         GRE::LAYERVIEW *layerview
         );

      //! Disable standard hotkeys for this view.
      void DisableHotKeys (
         ) { m_viewflags |= VIEWFLAG_DisableHotKeys; }

      //! Disable redraw for this view.
      void DisableRedraw (
         ) { ++m_DisableRedraw; }

      //! Draw the view.
      ERRVALUE Draw (
         );

      //! Draw view without refreshing other views.
      //! @return TRUE if color map changed, FALSE if not, < 0 if error.
      int DrawDirect (
         UINT32 drawflags = 0                   //!< MDISPDRAW_...
         );

      //! Draw specified group in view.
      ERRVALUE DrawGroup (
         GRE_GROUP *group,                      //!< Group, must be contained in view
         UINT32 drawflags                       //!< MDISPDRAW_...
         );

      //! Draw view if changed since last redraw.
      //! @return TRUE if did redraw, FALSE if not, < 0 if error.
      int DrawIfNeeded (
         );

      //! Draw view if auto-update is on.
      ERRVALUE DrawIfAutoUpdate (
         ) { if (s_GlobalOptions.m_RedrawOnAnyChange) return (Draw()); return (0); }

      //! Draw specified layer in view.
      ERRVALUE DrawLayer (
         GRE_LAYER *layer,                      //!< Layer to draw
         UINT32 drawflags = 0                   //!< Drawing flags, MDISPDRAW_...
         );

      //! Draw single element from specified layer.
      ERRVALUE DrawLayerElement (
         GRE_LAYER *layer,                      //!< Layer
         ELEMTYPE ElemType,                     //!< Element type
         INT32 ElemNum,                         //!< Element number
         UINT32 drawflags                       //!< Drawing flags, MDISPDRAW_...
         );

      //! Draw set of elements for specified layer.
      ERRVALUE DrawLayerElements (
         GRE_LAYER *layer,                      //!< Layer
         ELEMTYPE ElemType,                     //!< Element type
         const UINT8 *ElemSet,                  //!< Bit set of elements to draw, must be large enough for all elements of type
         UINT32 drawflags                       //!< Drawing flags, MDISPDRAW_...
         );

      //! Draw the margin lines.
      //! This function does nothing if not in hardcopy mode.
      void DrawMargins (
         MGD::CONTEXT* gc = 0    //!< context to draw with (default == back buffer)
         );

      //! Draw the page rectangle and margin lines
      //! This function does nothing if not in hardcopy mode.
      void DrawPage (
         MGD::CONTEXT* gc = 0    //!< context to draw with (default == back buffer)
         );

      //! Edit background, highlight, active colors for view.
      //! @return TRUE if colors changed, FALSE if not, < 0 if error.
      int EditColors (
         );

      //! Edit interface customization settings for views of this type.
      void EditCustomization (
         );

      //! Enable standard hotkeys for this view.
      void EnableHotKeys (
         ) { m_viewflags -= VIEWFLAG_DisableHotKeys; }

      //! Enable redraw of this view.
      void EnableRedraw (
         ) { if (m_DisableRedraw > 0) --m_DisableRedraw; }

      //! Find closest element to specified point in view.
      //! @return Element number, -1 if none found, < -1 if error.
      INT32 FindClosestLayerElement (
         GRE_LAYER *layer,                      //!< Layer to search
         int component,                         //!< Layer component index (not the element type)
         const DPOINT2D& point,                 //!< Point to search around
         double *distret,                       //!< Distance passed/returned, NULL if don't need
         GRE_FIND_FLAGS findflags               //!< GRE_FIND... flags
         );

      //! Find closest group to specified point in view.
      //! @return pointer to group or NULL if none found.
      GRE_GROUP* FindPointGroup (
         const DPOINT2D& point,                 //!< Point to search
         GRE_FIND_FLAGS findflags,              //!< Flags for searching
         const SPATREF::COORDREFSYS *pPointCRS = NULL    //!< CoordRefSys for point if GRE_FIND_MapCoords specified
         ) const;

      //! Return "active element" color.
      const COLOR& GetActiveColor (
         ) const { return (m_ActiveColor); }

      //! Return current active tool for view
      GRE_TOOL* GetActiveTool (
         ) const { return (m_ActiveTool); }

      bool GetAutoRedrawSolid (
         ) const { return (m_AutoRedrawSolid); }

      //! Get current background color for view.
      const COLOR& GetBackgroundColor (
         ) const { return (m_BackgroundColor); }

   #ifdef WIN32_NATIVE
      //! Get "color reference" for background color.
      COLOR32 GetBackgroundColorRef (
         ) const { return (static_cast<COLOR32>(GetBackgroundColor().GetColorRef())); }
   #endif

      //! Return name of background color for use in INI file.
      const char* GetBackgroundColorIniName (
         ) const;

      //! Get portion of canvas extents actually used based on zoom factor.
      void GetCanvasExtentsUsed (
         LRECT2D& extents,                      //!< Extents in 'canvas' coordinates returned
         bool UseNext = false                   //!< Use 'next' position instead of 'last' position
         ) const;

      //! Get clipping region for group in view.
      //! @return false if not in visible area, true if visible.
      bool GetClipRegion (
         GRE_GROUP *group,                      //!< Group, NULL for overall clipping region
         MGD::CONTEXT* ggc,                           //!< Graphic context, NULL to use view's
         REGION2D& ClipRegion                   //!< Clipping region returned
         );

   #ifdef X_NATIVE
      //! Get DrawingArea widget for view
      Widget GetDrawingArea (
         ) const { return (m_da); }

      //! Get "form" containing DrawingArea and LegendView.
      Widget GetDrawingAreaForm (
         ) const { return (m_lvswform); }
   #endif

      //! Get height (Y extent) of drawable area.
      //! @return Height in pixels.
      UINT32 GetDrawingAreaHeight (
         ) const { return (m_height); }

      //! Get width (X extent) of drawable area.
      //! @return Width in pixels.
      UINT32 GetDrawingAreaWidth (
         ) const { return (m_width); }

      //! Get MGD::CONTEXT for drawing to 'memory'.
      MGD::CONTEXT* GetDrawingContextMemory (
         ) const { return (m_mgc); }

   #ifdef X_NATIVE
      //! Get MGD::CONTEXT for drawing to 'pixmap' (X only).
      MGD::CONTEXT* GetDrawingContextPixmap (
         ) const { return (m_pgc); }
   #endif

   #ifdef X_NATIVE
      //! Get MGD::CONTEXT for drawing to 'screen' (X only).
      MGD::CONTEXT* GetDrawingContextScreen (
         ) const { return (m_sgc); }
   #endif

      //! Get MGD::DEVICE for drawing to 'memory'.
      MGD::DEVICE_MEM24* GetDrawingDeviceMemory (
         ) const { return (m_mdisp); }

   #ifdef X_NATIVE
      //! Get MGD::DEVICE_X for drawing to 'pixmap' (X only).
      MGD::DEVICE_X* GetDrawingDevicePixmap (
         ) const { return (m_pdisp); }
   #endif

   #ifdef X_NATIVE
      //! Get MGD::DEVICE_X for drawing to 'screen' (X only).
      MGD::DEVICE_X* GetDrawingDeviceScreen (
         ) const { return (m_sdisp); }
   #endif

   #ifdef X_NATIVE
      //! Get X Pixmap.
      //! @return 0 if none exists
      Pixmap GetDrawingPixmap (
         ) const { return (m_pixmap); }
   #endif

      //! Determine if only drawing wireframes for 3D layers.
      bool GetDrawWireframe3D (
         ) const { return (m_DrawWireframe); }

      //! Get full extents of viewable object including margins.
      const DRECT2D& GetFullExtents (
         ) const { return (m_FullExtents); }

   #ifdef X_NATIVE
      //! Get main "form" widget for this view.
      Widget GetForm (
         ) const { return (m_form); }
   #endif

      //! Get geo-lock settings for view.
      const GRE_GEOLOCKSETTINGS& GetGeoLock (
         ) const { return (m_GeoLock); }

      //! Return "highlight" color.
      const COLOR& GetHighlightColor (
         ) const { return (m_HighlightColor); }

   #ifdef X_NATIVE
      //! Get BUTTONITEM array for "Add" icons on toolbar.
      //! @return Cast of array to BUTTONITEM* for convenience.
      const BUTTONITEM* GetIconItemAdd (
         SIMPLE_ARRAY<BUTTONITEM>& items        //!< Array to contain items
         ) const;

      //! Get BUTTONITEM array for "Draw" icons on toolbar.
      //! @return Cast of array to BUTTONITEM* for convenience.
      const BUTTONITEM* GetIconItemDraw (
         SIMPLE_ARRAY<BUTTONITEM>& items,       //!< Array to contain items
         UINT32 flags = 0                       //!< MDISPCREATE_ViewNoRedrawButton, MDISPCREATE_ViewNoSkipButton, MDISPCREATE_ViewNoCancelButton
         ) const;

      //! Get BUTTONITEM array for "Tool" icons on toolbar.
      //! This does not include items for custom script tools.
      //! @return Cast of array to BUTTONITEM* for convenience.
      const BUTTONITEM* GetIconItemTool (
         SIMPLE_ARRAY<BUTTONITEM>& items        //!< Array to contain items
         ) const;

      //! Get BUTTONITEM array for "View" icons on toolbar.
      //! @return Cast of array to BUTTONITEM* for convenience.
      const BUTTONITEM* GetIconItemView (
         SIMPLE_ARRAY<BUTTONITEM>& items,       //!< Array to contain items
         UINT32 flags = MDISPICONVIEW_ViewDefault  //!< MDISPICONVIEW_...
         ) const;

      //! Get "view" toolbar icon.
      //! @return Icon widget or NULL if does not exist.
      Widget GetIconView (
         UINT32 flag                            //!< MDISPICONVIEW_...
         ) const;
   #endif

      const VIEWPOSN& GetLastPosn (
         ) const { return (m_LastPosn); }
   
      //! Get LAYERVIEW, constructing if does not exist.
      GRE::LAYERVIEW* GetLayerView (
         GRE_LAYER *layer
         );

   #ifdef X_NATIVE
      //! Get current panning margin.
      //! @return Margin in meters.
      double GetMargin (
         ) const { return (m_MarginMeters); }

      //! Get "HotKeys" menu items.
      //! @return Internal array
      const MENUITEM* GetMenuItemHotKeys (
         );

      //! Get "LegendView" menu items.
      //! @return Internal array
      const MENUITEM* GetMenuItemLegendView (
         );

      //! Get GPS menu items.
      //! @return Internal array
      const MENUITEM* GetMenuItemGPS (
         );

      //! Get "Options" menu items.
      //! @return Cast of array to MENUITEM* for convenience.
      const MENUITEM* GetMenuItemOptions (
         SIMPLE_ARRAY<MENUITEM>& items          //!< Array of items returned
         );

      //! Get MENUITEM array for "Tool" menu.
      //! @return Cast of array to MENUITEM* for convenience.
      const MENUITEM* GetMenuItemTool (
         SIMPLE_ARRAY<MENUITEM>& items          //!< Array of items returned
         ) const;

      //! Get "View" menu items.
      //! @return Cast of array to MENUITEM* for convenience.
      const MENUITEM* GetMenuItemView (
         SIMPLE_ARRAY<MENUITEM>& items          //!< Array of items returned
         );

      //! Get Widget for item on view's menubar.
      //! @return Widget or NULL if no matching item.
      Widget GetMenuWidget (
         const char* menupath                   //!< Path to menu item (eg. "/view/redraw")
         ) const { return (MxMenuItemWidget(m_menubar,menupath)); }
   #endif

      //! Get name of this view.
      void GetName (
         MISTRING& name                         //!< Name returned
         ) const;

   #ifndef NO_DEPRECATED
      //! Get name of this view.
      //! Name returned, free when done with
      DEPRECATED UNICODE* GetName (
         ) const;
   #endif

      bool GetNeedsRedraw (
         ) const { return (m_NeedsRedraw); }

      //! Get next view of same object as this view.
      //! @return next view or 0 if no more views.
      GRE_VIEW* GetNext (
         ) const;

      GRE_VIEW* GetNextOfAll (
         ) const { return (m_nextview); }

      const VIEWPOSN& GetNextPosn (
         ) const { return (m_NextPosn); }

      //! Get object this view is of.
      GRE_VIEWABLE* GetObject (
         ) const { return (m_viewable); }

      //! Get type of object being viewed.
      GRE_OBJTYPE GetObjectType (
         ) const { return ((m_viewable == 0) ? GRE_OBJTYPE_None : m_viewable->GetType()); }

   #ifdef X_NATIVE
      //! Get "overlay plane" graphic context.
      MGD::CONTEXT *GetOverlayGC (
         ) const { return (m_ogc); }
   #endif

   #ifdef X_NATIVE
      //! Get "overlay plane" X Pixmap.
      //! @return 0 if none exists
      Pixmap GetOverlayPixmap (
         ) const { return (m_opixmap); }
   #endif

      //! Get padding value in pixels for scrolling off edge of object extent.
      INT16 GetPadPixels (
         ) const { return (m_PadPixels); }

      //! Get current projection accuracy.
      GRE_PROJACCUR GetProjAccur (
         ) const { return (m_ProjAccur); }

      //! Get current scale at which view is rendered.
      ERRVALUE GetScale (
         double *xscale,                        //!< X scale returned
         double *yscale                         //!< Y scale returned
         );

      //! Get current scale at which view is rendered.
      double GetScale (
         ) { return (m_LastPosn.MapScale); }

      //! Get "size" of viewable object in "ground" meters.
      ERRVALUE GetSizeMeters (
         DPOINT2D& size                         //!< Size in meters returned
         ) const { return ((m_viewable != 0) ? m_viewable->GetSizeMeters(size) : 0); }

      MSTATUSCONTEXT GetStatusContext (
         ) const { return (m_StatusContext); }

      MSTATUSHANDLE GetStatusHandle (
         ) const { return (m_StatusHandle); }

      //! Get whether to use transparency to hint at sub pi