gre/uiformview.h

Go to the documentation of this file.

#ifndef  INC_GRE_UIFORMVIEW_H
#define  INC_GRE_UIFORMVIEW_H

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

#ifndef  INC_MGUI_FORM_H
   #include <mgui/form.h>
#endif

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


#ifndef GENERATING_DOXYGEN_OUTPUT
// Forward declarations.
namespace MGUI {
   class CTRL_STATUSBAR;
   class CTRL_MAGNIFIER;
   class DLG_CUSTOMIZE;
   class MENU;
   class SHELL;
   }
namespace SPATREF {
   class COORDREFSYS;
   }
namespace GRE {
   namespace UI {
      class VIEW_CANVAS;
      }
   }
namespace SML {
   union ARG;
   class CONTEXT;
   class FLAG;
   }
namespace UOM {
   class UNIT;
   }
#endif


namespace GRE {
namespace UI {

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

class FORM_VIEW : public MGUI::FORM_COMPOSITE {
   public:

      enum CREATEFLAGS {
         CREATEFLAG_None =                   0x00000000,
         // Flags must match GRE::VIEW::CREATEFLAGS.
         CREATEFLAG_3D =                     0x00000001, 
         CREATEFLAG_NoCallCreateCB =         0x00000002, 
         CREATEFLAG_NoRenderSeparate =       0x00000004, 
         CREATEFLAG_DisableDraw =            0x00000010, 
         CREATEFLAG_IsLocator =              0x00000020, 
         CREATEFLAG_AllowGPS =               0x00000040, 

         CREATEFLAG_NoDftViewButtons =       0x00000100, 
         CREATEFLAG_NoDftAddButtons =        0x00000200, 
         CREATEFLAG_NoDftMarkButtons =       0x00000400, 
         CREATEFLAG_NoDftTools =             0x00000800, 
         CREATEFLAG_NoDft3dButtons =         0x00001000, 
         CREATEFLAG_NoToolScripts =          0x00002000, 
         CREATEFLAG_NoDftButtons =           0x00004000, 
         CREATEFLAG_NoSidebar =              0x00008000, 
         CREATEFLAG_NoLegend =               0x00010000, 
         CREATEFLAG_NoLocator =              0x00020000, 
         CREATEFLAG_NoStatusBar =            0x00040000, 
         CREATEFLAG_NoToolBar =              0x00080000, 
         CREATEFLAG_No3dToolBar =            0x00100000, 
         CREATEFLAG_NoMagnifier =            0x00200000, 
         CREATEFLAG_AddLayerMgrButton =      0x00400000, 
         CREATEFLAG_NoPlaces =               0x00800000, 
         CREATEFLAG_NoScalebarGadget =       0x01000000, 
         CREATEFLAG_NoZoomPane =             0x02000000, 
         CREATEFLAG_NoReadSettingsIni =      0x04000000, 

         CREATEFLAG_AllowGeoLock =           0x10000000  
         };

      enum VIEWBTNS {
         VIEWBTN_Refresh =          0x00000001,
         VIEWBTN_Stop =             0x00000002,
         VIEWBTN_Full =             0x00000004,
         VIEWBTN_Previous =         0x00000008,
         VIEWBTN_ZoomIn =           0x00000020,
         VIEWBTN_ZoomOut =          0x00000040,
         VIEWBTN_ZoomToGroup =      0x00000080,
         VIEWBTN_ZoomToLayer =      0x00000100,
         VIEWBTN_ZoomToMaxDetail =  0x00000200,
         VIEWBTN_Zoom1X =           0x00000800,
         VIEWBTN_Zoom2X =           0x00001000,
         VIEWBTN_Zoom3X =           0x00002000,
         VIEWBTN_Locator =          0x00004000,
         VIEWBTN_Snapshot =         0x00008000,
         VIEWBTN_GeoLock =          0x00010000,
         VIEWBTN_SyncGeoViewer =    0x00020000,    
         VIEWBTN_Stereo =           0x00040000,
         VIEWBTN_PrintSnapshot =    0x00080000,
         VIEWBTN_Default =          VIEWBTN_Refresh | VIEWBTN_Stop | VIEWBTN_Full | VIEWBTN_Previous | VIEWBTN_ZoomIn | VIEWBTN_ZoomOut | VIEWBTN_ZoomToLayer | VIEWBTN_ZoomToGroup | VIEWBTN_ZoomToMaxDetail | VIEWBTN_Snapshot | VIEWBTN_GeoLock | VIEWBTN_SyncGeoViewer | VIEWBTN_Stereo
         };

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

      enum STATUSDISPLAY {
         STATUSDISPLAY_Default =                0x00,
         STATUSDISPLAY_UseLatLonIfNoSetCRS =    0x01, 
         STATUSDISPLAY_HasZ =                   0x02, 
         };

      enum SUBMENUS {
         SUBMENU_View =          0x01,
         SUBMENU_Tools =         0x02,
         SUBMENU_GPS =           0x04,
         SUBMENU_Options =       0x08,
         SUBMENU_Macros =        0x10,
         SUBMENU_HotKeys =       0x20,
         SUBMENUS_All =          0xFF
         };

      class SETTINGS;

      typedef fastdelegate::FastDelegate<void(UI::VIEW_CANVAS*)> DELEGATE_ADDTOOLS;

      explicit FORM_VIEW (
         GRE::VIEWABLE *viewable
         );

      virtual ~FORM_VIEW ();

      void ClearMessage ();

      void ClearPreviousViewList ();

      ERRVALUE Create (
         MGUI::LAYOUT_PANE_BASE& PaneParent,
         INT32 CanvasWidth,
         INT32 CanvasHeight,
         const char *IniFieldBase = 0,          
         CREATEFLAGS CreateFlags = CREATEFLAG_None,
         MGUI::LAYOUT_SIZEALIGN sizealign = MGUI::LAYOUT_SIZEALIGN_Expand,
         const SETTINGS *pSettings = 0
         );

      void Create3dToolBar (
         MGUI::LAYOUT_PANE& PaneParent          
         );

      void CreatePaneToolBar (
         MGUI::LAYOUT_PANE& PaneParent          
         );

      void CreateStatusBar (
         MGUI::LAYOUT_PANE& PaneParent,
         const SETTINGS *pSettings = 0
         );

      void DisableDraw (
         );

      void DlgCustomizeAddMenuItems (
         MGUI::DLG_CUSTOMIZE& dlg
         );

      void DlgCustomizeAddToolBarItems (
         MGUI::DLG_CUSTOMIZE& dlg
         );

      int DlgEditColors (
         );

      void DlgEditCustomization (
         );

      ERRVALUE Draw (
         );

      ERRVALUE DrawIfAutoUpdate (
         );

      int DrawIfNeeded (
         );

      void EnableDraw (
         );

      MGUI::CTRL_MAGNIFIER* GetCanvasMagnifier (
         ) const;

      MGUI::LAYOUT_PANE& GetPaneToolBar (
         );

      bool GetRedrawOnAnyChange (
         ) const;

      const SETTINGS& GetSettingsToSave (
         );

      MGUI::CTRL_STATUSBAR& GetStatusBar (
         );
   
      UI::VIEW_CANVAS* GetViewCanvas (
         ) const;

      UI::VIEW_CANVAS* GetViewLocator (
         ) const;

      GRE::VIEWABLE* GetViewable (
         ) const;

      void LegendEnableRedraw (
         bool enable
         );

      bool LegendIsVisible (
         bool CheckSidebar = true            
         ) const;

      void LegendRedraw (
         );

      void LegendSetVisible (
         bool visible
         );

      INT16 PlacesGetHeight (
         ) const;

      bool PlacesIsVisible (
         bool CheckSidebar = true            
         ) const;

      void PlacesSetHeight (
         INT16 height                        
         );

      void PlacesSetVisible (
         bool visible
         );

      INT16 LocatorGetHeight (
         ) const;

      bool LocatorIsVisible (
         bool CheckSidebar = true            
         ) const;

      void LocatorSetHeight (
         INT16 height                        
         );

      void LocatorSetVisible (
         bool visible
         );

      INT16 MagnifierGetHeight (
         ) const;

      INT16 MagnifierGetZoom (
         ) const;

      bool MagnifierIsVisible (
         bool CheckSidebar = true            
         ) const;

      void MagnifierSetHeight (
         INT16 height                        
         );

      void MagnifierSetZoom (
         INT16 zoom                          
         );

      void MagnifierSetVisible (
         bool visible
         );

      void MenuAddItemsHotKeys (
         MGUI::MENU& submenu                 
         );
   
      void MenuAddItemsView (
         MGUI::MENU& submenu                 
         );

      void MenuAddSubMenuGPS (
         MGUI::MENU& menu                 
         );
   
      void MenuAddSubMenuHotKeys (
         MGUI::MENU& menu                 
         );
   
      void MenuAddSubMenuMacros (
         MGUI::MENU& menu                 
         );
   
      void MenuAddSubMenuOptions (
         MGUI::MENU& menu                 
         );
   
      void MenuAddSubMenuTools (
         MGUI::MENU& menu                 
         );
   
      void MenuAddSubMenuView (
         MGUI::MENU& menu                 
         );

      void MenuBarAddSubMenus (
         MGUI::MENU& MenuBar,                
         SUBMENUS submenus                   
         );

      void MenuBarCreate (
         MGUI::SHELL& shell,                 
         SUBMENUS submenus = SUBMENUS_All,   
         bool AddSeparator = true            
         );

      MGUI::MENU& MenuGetOptions ();
   
      ERRVALUE SaveSnapshotQuick (
         ) const;

      ERRVALUE SaveSnapshotToRaster (
         ) const;

      void SetDelegateAddTools (
         DELEGATE_ADDTOOLS DelegateAddTools
         );

      void SetDrawWireframe3D (
         bool DrawWireframe3D
         );

      void SetLayerListPos (
         GRE::LISTPOS ListPos
         );

      void SetPreviousView ();

      void SetRedrawOnAnyChange (
         bool RedrawOnAnyChange,
         bool redraw = true                  
         );

      void SetViewBtnsToCreate (
         VIEWBTNS viewbtns                   
         );

      INT16 SidebarGetWidth (
         ) const;

      bool SidebarIsVisible (
         ) const;

      void SidebarSetVisible (
         bool visible
         );

      void SidebarSetWidth (
         INT16 width                         
         );

      void StatusClearCoord (
         COORDSOURCE CoordSource = COORDSOURCE_None
         );

      void StatusDisplayCoord (
         COORDSOURCE CoordSource,                  
         const DPOINT3D& point,                    
         const SPATREF::COORDREFSYS& PointCRS,     
         const DPOINT3D *pPtConfidence,            
         STATUSDISPLAY StatusDisplay,              
         const UOM::UNIT *pUnitZ = 0               
         );

      COORDSOURCE StatusGetCoordSource () const;

      bool StatusIsPosVisible (
         int idx = -1
         ) const;

      void StatusSetCoordRefSys (
         unsigned idx,
         const SPATREF::COORDREFSYS& CoordRefSys
         );

      void StatusSetCoordSource (
         COORDSOURCE CoordSource
         );

      void StatusSetLatLonFormat (
         unsigned idx,
         DMSTYPE LatLonFormat
         );

      void StatusSetPosVisible (
         unsigned idx,
         bool visible
         );

      void StatusSetVisible (
         bool visible
         );

      bool StereoIsViewIndicatorVisible () const;

      void StereoSetViewIndicatorVisible (
         bool visible                        
         );

      void ToolBarAdd3dButtons ();

      void ToolBarAddAddButtons ();

      void ToolBarAddMacroScriptButtons ();

      void ToolBarAddMarkButtons ();

      void ToolBarAddToolButtons ();

      void ToolBarAddViewButtons (
         VIEWBTNS buttons = VIEWBTN_Default     
         );

      void UpdateMessage (
         const MISTRING& string
         ) const;

      INT16 ZoomGetHeight (
         ) const;

      bool ZoomIsVisible (
         bool CheckSidebar = true            
         ) const;

      void ZoomSetHeight (
         INT16 height                        
         );

      void ZoomSetVisible (
         bool visible
         );

   #ifndef GENERATING_DOXYGEN_OUTPUT

      static FORM_VIEW* SML_CreateForm (
         int numargs,
         SML::ARG *args,
         SML::CONTEXT *context,
         CREATEFLAGS createflags = CREATEFLAG_None
         );

      static SML::FLAG* SML_GetCreateFlags ();

   #endif

   private:
      #ifndef GENERATING_DOXYGEN_OUTPUT
      class PRIV;
      PRIV *m_pPriv;

      // Unimplemented
      FORM_VIEW (const FORM_VIEW&);
      FORM_VIEW& operator= (const FORM_VIEW&);
      #endif
   };

#ifndef GENERATING_DOXYGEN_OUTPUT
DEFINE_ENUM_OP_BITWISE(FORM_VIEW::CREATEFLAGS)
DEFINE_ENUM_OP_BITWISE(FORM_VIEW::VIEWBTNS)
DEFINE_ENUM_OP_BITWISE(FORM_VIEW::STATUSDISPLAY)
DEFINE_ENUM_OP_BITWISE(FORM_VIEW::SUBMENUS)
#endif

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

}  // End namespace UI
}  // End namespace GRE

#endif   // INC_GRE_UIFORMVIEW_H

---