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 <HYDROData_Object.h>
  27
  28 #include <LightApp_Module.h>
  29
  30 #include <QEvent>
  31
  32 class QGraphicsSceneMouseEvent;
  33
  34 class GraphicsView_Viewer;
  35
  36 class SUIT_ViewWindow;
  37
  38 class HYDROGUI_DataModel;
  39 class HYDROGUI_Displayer;
  40
  41 /**\class HYDROGUI_Module
  42  *\brief The class representing the HYDROGUI module
  43  */
  44 class HYDROGUI_Module : public LightApp_Module
  45 {
  46   Q_OBJECT
  47
  48   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  49
  50 public:
  51   enum ViewManagerRole { VMR_Unknown = 0, VMR_General, VMR_TransformImage, VMR_ObserveImage };
  52   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  53
  54   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  55   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  56
  57   struct ObjectState
  58   {
  59     bool Visibility;
  60     double Transparency;
  61     double ZValue;
  62     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
  63   };
  64   typedef QMap< QString, ObjectState > Name2ObjectStateMap;
  65   typedef QMap< int, Name2ObjectStateMap > ViewId2Name2ObjectStateMap;
  66
  67 public:
  68   HYDROGUI_Module();
  69   virtual ~HYDROGUI_Module();
  70
  71   /**
  72    * Returns the module study identifier
  73    */
  74   int getStudyId() const;
  75
  76   virtual void initialize( CAM_Application* );
  77   virtual void windows( QMap<int, int>& ) const;
  78   virtual void viewManagers( QStringList& ) const;
  79
  80   virtual void contextMenuPopup( const QString&, QMenu*, QString& );
  81
  82   virtual void update( const int );
  83   virtual void updateCommandsStatus();
  84
  85   HYDROGUI_DataModel* getDataModel() const;
  86   HYDROGUI_Displayer* getDisplayer() const;
  87
  88   GraphicsView_Viewer* getViewer( const int theId ) const;
  89
  90   int getViewManagerId( SUIT_ViewManager* theViewManager );
  91   ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
  92   void setViewManagerRole( SUIT_ViewManager* theViewManager,
  93                            const ViewManagerRole theRole );
  94
  95   bool isObjectVisible( const int theViewId,
  96                         const Handle(HYDROData_Object)& theObject );
  97   void setObjectVisible( const int theViewId,
  98                          const Handle(HYDROData_Object)& theObject,
  99                          const bool theState );
 100
 101 protected:
 102   CAM_DataModel* createDataModel();
 103
 104 public slots:
 105   virtual bool activateModule( SUIT_Study* );
 106   virtual bool deactivateModule( SUIT_Study* );
 107
 108 protected:
 109   virtual LightApp_Operation* createOperation( const int ) const;
 110
 111   virtual void customEvent( QEvent* );
 112   virtual bool eventFilter( QObject*, QEvent* );
 113
 114 protected slots:
 115   void onOperation();
 116
 117   bool onUndo( int theNumActions );
 118   bool onRedo( int theNumActions );
 119
 120   virtual void onViewManagerAdded( SUIT_ViewManager* );
 121   virtual void onViewManagerRemoved( SUIT_ViewManager* );
 122   virtual void onViewCreated( SUIT_ViewWindow* );
 123
 124   void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 125
 126 private:
 127   void updateGV( const bool theIsInit = false,
 128                  const bool theIsForced = false );
 129
 130   void createSelector( SUIT_ViewManager* viewMgr );
 131
 132   bool setUpdateEnabled( const bool theState );
 133   bool isUpdateEnabled() const;
 134
 135 private:
 136   void createActions();
 137   void createMenus();
 138   void createPopups();
 139   void createToolbars();
 140
 141   void createUndoRedoActions();
 142   void updateUndoRedoControls();
 143
 144 private:
 145   QAction* createAction( const int theId, const QString& theSuffix,
 146                          const QString& theImg = QString::null,
 147                          const int theKey = 0, const bool isToggle = false,
 148                          const QString& theSlot = QString::null );
 149
 150 private:
 151   HYDROGUI_Displayer* myDisplayer;
 152
 153   ViewManagerMap myViewManagerMap;
 154   ViewId2Name2ObjectStateMap myObjectStateMap;
 155
 156   bool myIsUpdateEnabled;
 157 };
 158
 159 #endif