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_Entity.h>
  27
  28 #include <LightApp_Module.h>
  29
  30 #include <QEvent>
  31
  32 class QGraphicsSceneMouseEvent;
  33
  34 class GraphicsView_Viewer;
  35 class OCCViewer_Viewer;
  36 class SVTK_Viewer;
  37
  38 class SUIT_ViewWindow;
  39 class SUIT_ViewManager;
  40
  41 class HYDROGUI_DataModel;
  42 class HYDROGUI_Displayer;
  43 class HYDROGUI_OCCDisplayer;
  44 class HYDROGUI_VTKPrsDisplayer;
  45 class HYDROGUI_AbstractDisplayer;
  46 class HYDROGUI_Shape;
  47 class HYDROGUI_VTKPrs;
  48
  49 /**\class HYDROGUI_Module
  50  *\brief The class representing the HYDROGUI module
  51  */
  52 class HYDROGUI_Module : public LightApp_Module
  53 {
  54   Q_OBJECT
  55
  56   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  57
  58 public:
  59
  60   enum ViewManagerRole
  61   {
  62     VMR_Unknown = 0,
  63     VMR_General,
  64     VMR_TransformImage,
  65     VMR_ReferenceImage,
  66     VMR_ObserveImage,
  67     //VMR_PreviewZone, // totally unused, to delete
  68     VMR_PreviewCaseZones // actually unused, to review
  69   };
  70   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  71
  72   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  73   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  74
  75   struct ObjectState
  76   {
  77     bool Visibility;
  78     double Transparency;
  79     double ZValue;
  80     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
  81   };
  82   typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
  83   typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
  84
  85   typedef QList<HYDROGUI_Shape*> ListOfShapes;
  86   typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
  87
  88   typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
  89   typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
  90
  91 public:
  92   HYDROGUI_Module();
  93   virtual ~HYDROGUI_Module();
  94
  95   int                             getStudyId() const;
  96
  97   virtual void                    initialize( CAM_Application* );
  98   virtual void                    windows( QMap<int, int>& ) const;
  99   virtual void                    viewManagers( QStringList& ) const;
 100
 101   virtual void                    contextMenuPopup( const QString&, QMenu*, QString& );
 102
 103   virtual void                    update( const int );
 104   virtual void                    updateCommandsStatus();
 105
 106   virtual void                    selectionChanged();
 107
 108   SUIT_ViewManager*               getViewManager( const int theId ) const;
 109   HYDROGUI_DataModel*             getDataModel() const;
 110   HYDROGUI_Displayer*             getDisplayer() const;
 111   HYDROGUI_OCCDisplayer*          getOCCDisplayer() const;
 112   HYDROGUI_VTKPrsDisplayer*       getVTKDisplayer() const;
 113
 114   GraphicsView_Viewer*            getViewer( const int theId ) const;
 115   OCCViewer_Viewer*               getOCCViewer( const int theId ) const;
 116   SVTK_Viewer*                    getVTKViewer( const int theId ) const;
 117
 118   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
 119   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
 120   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
 121                                                       const ViewManagerRole theRole );
 122
 123   bool                            isObjectVisible( const int theViewId,
 124                                                    const Handle(HYDROData_Entity)& theObject ) const;
 125   void                            setObjectVisible( const int theViewId,
 126                                                     const Handle(HYDROData_Entity)& theObject,
 127                                                     const bool theState );
 128   /**
 129    * Set IsToUpdate flag for all presentations of the given object to recompute them during
 130    * the next viewer(s) updating.
 131    * @param theObject the data model object
 132    * @param theState  the flag to set for object's presentations, it's true by default.
 133    */
 134   void                            setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
 135                                                  const bool theState = true );
 136   HYDROGUI_Shape*                 getObjectShape( const int                       theViewId,
 137                                                   const Handle(HYDROData_Entity)& theObject ) const;
 138   void                            setObjectShape( const int                       theViewId,
 139                                                   const Handle(HYDROData_Entity)& theObject,
 140                                                   HYDROGUI_Shape*                 theShape );
 141   void                            removeViewShapes( const int                     theViewId );
 142   void                            removeObjectShape( const int                       theViewId,
 143                                                      const Handle(HYDROData_Entity)& theObject );
 144
 145   HYDROGUI_VTKPrs*                getObjectVTKPrs( const int                       theViewId,
 146                                                    const Handle(HYDROData_Entity)& theObject ) const;
 147   void                            setObjectVTKPrs( const int                       theViewId,
 148                                                    const Handle(HYDROData_Entity)& theObject,
 149                                                    HYDROGUI_VTKPrs*                theShape );
 150   void                            removeViewVTKPrs( const int                      theViewId );
 151   void                            removeObjectVTKPrs( const int                      theViewId,
 152                                                      const Handle(HYDROData_Entity)& theObject );
 153
 154   void                            removeObjectVTKPrs( const int      theViewId,
 155                                                       const QString& theEntry );
 156
 157   /**
 158    * Update global imposed range of Z values for the given VTK viewer id
 159    */
 160   void                            updateVTKZRange( const int theViewId, double theRange[] );
 161
 162   /**
 163    * Returns true if the object with the given entry can be renamed.
 164    * @param theEntry the object entry
 165    */
 166   virtual bool                    renameAllowed( const QString& theEntry ) const;
 167   /**
 168    * Returns true if the object with the given entry is renamed.
 169    * @param theEntry the object entry
 170    * @param theName the new name
 171    */
 172   virtual bool                    renameObject( const QString& theEntry, const QString& theName );
 173
 174   int                             getObjectDisplayOrder( const int theViewId,
 175                                                          const Handle(HYDROData_Entity)& theObject ) const;
 176   QPoint                          getPopupPosition() const;
 177
 178 protected:
 179   CAM_DataModel*                  createDataModel();
 180
 181 public slots:
 182   virtual bool                    activateModule( SUIT_Study* );
 183   virtual bool                    deactivateModule( SUIT_Study* );
 184
 185 protected:
 186   virtual LightApp_Operation*     createOperation( const int ) const;
 187   virtual bool                    reusableOperation( const int id );
 188
 189   virtual void                    customEvent( QEvent* );
 190   virtual bool                    eventFilter( QObject*, QEvent* );
 191
 192 protected slots:
 193   void                            onOperation();
 194   void                            onDelete();
 195
 196
 197   bool                            onUndo( int theNumActions );
 198   bool                            onRedo( int theNumActions );
 199
 200   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 201   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 202   virtual void                    onViewCreated( SUIT_ViewWindow* );
 203
 204   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 205
 206   void                            onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
 207
 208 private:
 209   void                            updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
 210                                                 const bool theIsInit = false,
 211                                                 const bool theIsForced = false,
 212                                                 const bool theDoFitAll = false );
 213
 214   void                            createSelector( SUIT_ViewManager* viewMgr );
 215
 216   bool                            setUpdateEnabled( const bool theState );
 217   bool                            isUpdateEnabled() const;
 218
 219   QStringList                     storeSelection() const;
 220   void                            restoreSelection( const QStringList& theEntryList );
 221
 222 private:
 223   void                            createActions();
 224   void                            createMenus();
 225   void                            createPopups();
 226   void                            createToolbars();
 227
 228   void                            createUndoRedoActions();
 229   void                            updateUndoRedoControls();
 230
 231 private:
 232   QAction*                        createAction( const int theId, const QString& theSuffix,
 233                                                 const QString& theImg = QString::null,
 234                                                 const int theKey = 0, const bool isToggle = false,
 235                                                 const QString& theSlot = QString::null );
 236
 237 private:
 238   HYDROGUI_Displayer*             myDisplayer;
 239   HYDROGUI_OCCDisplayer*          myOCCDisplayer;
 240   HYDROGUI_VTKPrsDisplayer*       myVTKDisplayer;
 241
 242   ViewManagerMap                  myViewManagerMap;
 243   ViewId2Entry2ObjectStateMap     myObjectStateMap;
 244
 245   QMap<int, QStringList>          myObjectDisplayOrderMap;
 246
 247   ViewId2ListOfShapes             myShapesMap;
 248   ViewId2ListOfVTKPrs             myVTKPrsMap;
 249   bool                            myIsUpdateEnabled;
 250
 251   QStringList                     myGeomObjectsToImport; ///< entries of GEOM objects to be imported
 252 };
 253
 254 #endif