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
  52   enum ViewManagerRole { VMR_Unknown = 0, VMR_General,
  53                          VMR_TransformImage, VMR_ObserveImage,
  54                          VMR_PreviewZone,    VMR_PreviewCaseZones };
  55   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  56
  57   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  58   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  59
  60   struct ObjectState
  61   {
  62     bool Visibility;
  63     double Transparency;
  64     double ZValue;
  65     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
  66   };
  67   typedef QMap< QString, ObjectState > Name2ObjectStateMap;
  68   typedef QMap< int, Name2ObjectStateMap > ViewId2Name2ObjectStateMap;
  69
  70 public:
  71   HYDROGUI_Module();
  72   virtual ~HYDROGUI_Module();
  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   virtual void                    selectionChanged();
  86
  87   HYDROGUI_DataModel*             getDataModel() const;
  88   HYDROGUI_Displayer*             getDisplayer() const;
  89
  90   GraphicsView_Viewer*            getViewer( const int theId ) const;
  91
  92   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
  93   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
  94   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
  95                                                       const ViewManagerRole theRole );
  96
  97   bool                            isObjectVisible( const int theViewId,
  98                                                    const Handle(HYDROData_Object)& theObject );
  99   void                            setObjectVisible( const int theViewId,
 100                                                     const Handle(HYDROData_Object)& theObject,
 101                                                     const bool theState );
 102
 103 protected:
 104   CAM_DataModel*                  createDataModel();
 105
 106 public slots:
 107   virtual bool                    activateModule( SUIT_Study* );
 108   virtual bool                    deactivateModule( SUIT_Study* );
 109
 110 protected:
 111   virtual LightApp_Operation*     createOperation( const int ) const;
 112
 113   virtual void                    customEvent( QEvent* );
 114   virtual bool                    eventFilter( QObject*, QEvent* );
 115
 116 protected slots:
 117   void                            onOperation();
 118
 119   bool                            onUndo( int theNumActions );
 120   bool                            onRedo( int theNumActions );
 121
 122   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 123   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 124   virtual void                    onViewCreated( SUIT_ViewWindow* );
 125
 126   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 127
 128   void                            onTestSplit(); // ouv: tmp, to delete
 129
 130 private:
 131   void                            updateGV( const bool theIsInit = false,
 132                                             const bool theIsForced = false );
 133
 134   void                            createSelector( SUIT_ViewManager* viewMgr );
 135
 136   bool                            setUpdateEnabled( const bool theState );
 137   bool                            isUpdateEnabled() const;
 138
 139   QStringList                     storeSelection() const;
 140   void                            restoreSelection( const QStringList& theEntryList );
 141
 142 private:
 143   void                            createActions();
 144   void                            createMenus();
 145   void                            createPopups();
 146   void                            createToolbars();
 147
 148   void                            createUndoRedoActions();
 149   void                            updateUndoRedoControls();
 150
 151 private:
 152   QAction*                        createAction( const int theId, const QString& theSuffix,
 153                                                 const QString& theImg = QString::null,
 154                                                 const int theKey = 0, const bool isToggle = false,
 155                                                 const QString& theSlot = QString::null );
 156
 157 private:
 158   HYDROGUI_Displayer*             myDisplayer;
 159
 160   ViewManagerMap                  myViewManagerMap;
 161   ViewId2Name2ObjectStateMap      myObjectStateMap;
 162
 163   bool                            myIsUpdateEnabled;
 164 };
 165
 166 #endif