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