src/HYDROGUI/HYDROGUI_Module.h

   1 // Copyright (C) 2007-2013  CEA/DEN, EDF R&D, OPEN CASCADE
   2 //
   3 // Copyright (C) 2003-2007  OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
   4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
   5 //
   6 // This library is free software; you can redistribute it and/or
   7 // modify it under the terms of the GNU Lesser General Public
   8 // License as published by the Free Software Foundation; either
   9 // version 2.1 of the License.
  10 //
  11 // This library is distributed in the hope that it will be useful,
  12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14 // Lesser General Public License for more details.
  15 //
  16 // You should have received a copy of the GNU Lesser General Public
  17 // License along with this library; if not, write to the Free Software
  18 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19 //
  20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  21 //
  22
  23 #ifndef HYDROGUI_MODULE_H
  24 #define HYDROGUI_MODULE_H
  25
  26 #include <LightApp_Module.h>
  27
  28 #include <QEvent>
  29
  30 class QGraphicsSceneMouseEvent;
  31
  32 class GraphicsView_Viewer;
  33
  34 class SUIT_ViewWindow;
  35
  36 class HYDROGUI_DataModel;
  37 class HYDROGUI_Displayer;
  38
  39 /**\class HYDROGUI_Module
  40  *\brief The class representing the HYDROGUI module
  41  */
  42 class HYDROGUI_Module : public LightApp_Module
  43 {
  44   Q_OBJECT
  45
  46   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  47
  48 public:
  49   enum ViewManagerRole { VMR_Unknown = 0, VMR_General, VMR_TransformImage, VMR_ObserveImage };
  50   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  51
  52   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  53   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  54
  55 public:
  56   HYDROGUI_Module();
  57   virtual ~HYDROGUI_Module();
  58
  59   /**
  60    * Returns the module study identifier
  61    */
  62   int getStudyId() const;
  63
  64   virtual void initialize( CAM_Application* );
  65   virtual void windows( QMap<int, int>& ) const;
  66   virtual void viewManagers( QStringList& ) const;
  67
  68   virtual void contextMenuPopup( const QString&, QMenu*, QString& );
  69
  70   virtual void update( const int );
  71   virtual void updateCommandsStatus();
  72
  73   HYDROGUI_DataModel* getDataModel() const;
  74   HYDROGUI_Displayer* getDisplayer() const;
  75
  76   GraphicsView_Viewer* getViewer( const int theId ) const;
  77
  78   int getViewManagerId( SUIT_ViewManager* theViewManager );
  79   ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
  80   void setViewManagerRole( SUIT_ViewManager* theViewManager,
  81                            const ViewManagerRole theRole );
  82
  83 protected:
  84   CAM_DataModel* createDataModel();
  85
  86 public slots:
  87   virtual bool activateModule( SUIT_Study* );
  88   virtual bool deactivateModule( SUIT_Study* );
  89
  90 protected:
  91   virtual LightApp_Operation* createOperation( const int ) const;
  92
  93   virtual void customEvent( QEvent* );
  94   virtual bool eventFilter( QObject*, QEvent* );
  95
  96 protected slots:
  97   void onOperation();
  98
  99   bool onUndo( int theNumActions );
 100   bool onRedo( int theNumActions );
 101
 102   virtual void onViewManagerAdded( SUIT_ViewManager* );
 103   virtual void onViewManagerRemoved( SUIT_ViewManager* );
 104   virtual void onViewCreated( SUIT_ViewWindow* );
 105
 106   void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 107
 108 private:
 109   void updateGV( const bool theIsInit = false,
 110                  const bool theIsForced = false );
 111
 112   void createSelector( SUIT_ViewManager* viewMgr );
 113
 114   bool setUpdateEnabled( const bool theState );
 115   bool isUpdateEnabled() const;
 116
 117 private:
 118   void createActions();
 119   void createMenus();
 120   void createPopups();
 121   void createToolbars();
 122
 123   void createUndoRedoActions();
 124   void updateUndoRedoControls();
 125
 126 private:
 127   QAction* createAction( const int theId, const QString& theSuffix,
 128                          const QString& theImg = QString::null,
 129                          const int theKey = 0, const bool isToggle = false,
 130                          const QString& theSlot = QString::null );
 131
 132 private:
 133   HYDROGUI_Displayer* myDisplayer;
 134
 135   ViewManagerMap myViewManagerMap;
 136
 137   bool myIsUpdateEnabled;
 138 };
 139
 140 #endif