src/HYDROGUI/HYDROGUI_Module.h

   1 // Copyright (C) 2014-2015  EDF-R&D
   2 // This library is free software; you can redistribute it and/or
   3 // modify it under the terms of the GNU Lesser General Public
   4 // License as published by the Free Software Foundation; either
   5 // version 2.1 of the License, or (at your option) any later version.
   6 //
   7 // This library is distributed in the hope that it will be useful,
   8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  10 // Lesser General Public License for more details.
  11 //
  12 // You should have received a copy of the GNU Lesser General Public
  13 // License along with this library; if not, write to the Free Software
  14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  15 //
  16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  17 //
  18
  19 #ifndef HYDROGUI_MODULE_H
  20 #define HYDROGUI_MODULE_H
  21
  22 #include <HYDROData_Entity.h>
  23
  24 #include <LightApp_Module.h>
  25
  26 #include <QEvent>
  27 #include <QStack>
  28
  29 class QGraphicsSceneMouseEvent;
  30
  31 class GraphicsView_Viewer;
  32 class OCCViewer_Viewer;
  33 class SVTK_Viewer;
  34
  35 class SUIT_ViewWindow;
  36 class SUIT_ViewManager;
  37
  38 class Handle(HYDROData_StricklerTable);
  39
  40 class HYDROGUI_DataModel;
  41 class HYDROGUI_Displayer;
  42 class HYDROGUI_OCCDisplayer;
  43 class HYDROGUI_VTKPrsDisplayer;
  44 class HYDROGUI_AbstractDisplayer;
  45 class HYDROGUI_Shape;
  46 class HYDROGUI_VTKPrs;
  47 class HYDROGUI_Operation;
  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   enum CursorType
  59   {
  60     CT_ArrowCursor = 0,
  61     CT_UpArrowCursor,
  62     CT_CrossCursor,
  63     CT_WaitCursor,
  64     CT_IBeamCursor,
  65     CT_SizeVerCursor,
  66     CT_SizeHorCursor,
  67     CT_SizeBDiagCursor,
  68     CT_SizeFDiagCursor,
  69     CT_SizeAllCursor,
  70     CT_SplitVCursor,
  71     CT_SplitHCursor,
  72     CT_PointingHandCursor,
  73     CT_ForbiddenCursor,
  74     CT_WhatsThisCursor,
  75     CT_BusyCursor,
  76     CT_OpenHandCursor,
  77     CT_ClosedHandCursor,
  78     CT_User
  79   };
  80
  81 public:
  82
  83   enum ViewManagerRole
  84   {
  85     VMR_Unknown = 0,
  86     VMR_General,
  87     VMR_TransformImage,
  88     VMR_ReferenceImage,
  89     VMR_ObserveImage,
  90     //VMR_PreviewZone, // totally unused, to delete
  91     VMR_PreviewCaseZones // actually unused, to review
  92   };
  93   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  94
  95   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  96   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  97
  98   struct ObjectState
  99   {
 100     bool Visibility;
 101     double Transparency;
 102     double ZValue;
 103     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
 104   };
 105   typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
 106   typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
 107
 108   typedef QList<HYDROGUI_Shape*> ListOfShapes;
 109   typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
 110
 111   typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
 112   typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
 113
 114   typedef QMap<int, Handle(HYDROData_StricklerTable)> ViewId2StricklerTable;
 115
 116 public:
 117   HYDROGUI_Module();
 118   virtual ~HYDROGUI_Module();
 119
 120   int                             getStudyId() const;
 121
 122   virtual void                    initialize( CAM_Application* );
 123   virtual void                    windows( QMap<int, int>& ) const;
 124   virtual void                    viewManagers( QStringList& ) const;
 125
 126   virtual void                    contextMenuPopup( const QString&, QMenu*, QString& );
 127   virtual void                    createPreferences();
 128
 129   virtual void                    update( const int );
 130   virtual void                    updateCommandsStatus();
 131
 132   virtual void                    selectionChanged();
 133
 134   SUIT_ViewManager*               getViewManager( const int theId ) const;
 135   HYDROGUI_DataModel*             getDataModel() const;
 136   HYDROGUI_Displayer*             getDisplayer() const;
 137   HYDROGUI_OCCDisplayer*          getOCCDisplayer() const;
 138   HYDROGUI_VTKPrsDisplayer*       getVTKDisplayer() const;
 139
 140   GraphicsView_Viewer*            getViewer( const int theId ) const;
 141   OCCViewer_Viewer*               getOCCViewer( const int theId ) const;
 142   SVTK_Viewer*                    getVTKViewer( const int theId ) const;
 143
 144   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
 145   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
 146   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
 147                                                       const ViewManagerRole theRole );
 148
 149   bool                            isObjectVisible( const int theViewId,
 150                                                    const Handle(HYDROData_Entity)& theObject ) const;
 151   void                            setObjectVisible( const int theViewId,
 152                                                     const Handle(HYDROData_Entity)& theObject,
 153                                                     const bool theState );
 154   /**
 155    * Set IsToUpdate flag for all presentations of the given object to recompute them during
 156    * the next viewer(s) updating.
 157    * @param theObject the data model object
 158    * @param theState  the flag to set for object's presentations, it's true by default.
 159    */
 160   void                            setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
 161                                                  const bool theState = true );
 162   QList<HYDROGUI_Shape*>          getObjectShapes( const int  theViewId,
 163                                                    ObjectKind theKind ) const;
 164   HYDROGUI_Shape*                 getObjectShape( const int                       theViewId,
 165                                                   const Handle(HYDROData_Entity)& theObject ) const;
 166   void                            setObjectShape( const int                       theViewId,
 167                                                   const Handle(HYDROData_Entity)& theObject,
 168                                                   HYDROGUI_Shape*                 theShape );
 169   void                            removeViewShapes( const int                     theViewId );
 170   void                            removeObjectShape( const int                       theViewId,
 171                                                      const Handle(HYDROData_Entity)& theObject );
 172
 173   HYDROGUI_VTKPrs*                getObjectVTKPrs( const int                       theViewId,
 174                                                    const Handle(HYDROData_Entity)& theObject ) const;
 175   void                            setObjectVTKPrs( const int                       theViewId,
 176                                                    const Handle(HYDROData_Entity)& theObject,
 177                                                    HYDROGUI_VTKPrs*                theShape );
 178   void                            removeViewVTKPrs( const int                      theViewId );
 179   void                            removeObjectVTKPrs( const int                      theViewId,
 180                                                      const Handle(HYDROData_Entity)& theObject );
 181
 182   void                            removeObjectVTKPrs( const int      theViewId,
 183                                                       const QString& theEntry );
 184
 185   /**
 186    * Update global imposed range of Z values for the given VTK viewer id
 187    */
 188   void                            updateVTKZRange( const int theViewId, double theRange[] );
 189
 190   /**
 191    * Returns true if the object with the given entry can be renamed.
 192    * @param theEntry the object entry
 193    */
 194   virtual bool                    renameAllowed( const QString& theEntry ) const;
 195   /**
 196    * Returns true if the object with the given entry is renamed.
 197    * @param theEntry the object entry
 198    * @param theName the new name
 199    */
 200   virtual bool                    renameObject( const QString& theEntry, const QString& theName );
 201
 202   QStack<HYDROGUI_Operation*>&    getActiveOperations();
 203   HYDROGUI_Operation*             activeOperation();
 204
 205   /**
 206    * Returns the cursor defined for edition operations in module preferences.
 207    * \return specific cursor
 208    */
 209   QCursor                         getPrefEditCursor() const;
 210
 211   /**
 212    * Returns Strickler table used for Land Cover scalar map coloring in the given view.
 213    * @param theViewId the view id
 214    * @return the Strickler table used for scalar map coloring of Land Covers in the given view;
 215              null - if scalar map coloring is off for the view
 216    */
 217   Handle(HYDROData_StricklerTable) getLandCoverColoringTable( const int theViewId ) const;
 218
 219   /**
 220    * Set Strickler table to be used for Land Cover scalar map coloring in the given view.
 221    * @param theViewId the view id
 222    * @param theTable the Strickler table
 223    */
 224   void                             setLandCoverColoringTable( const int theViewId,
 225                                                               const Handle(HYDROData_StricklerTable)& theTable );
 226   /**
 227    * Set Land Cover scalar map coloring mode off for the given view.
 228    * @param theViewId the view id
 229    */
 230   void                             setLandCoversScalarMapModeOff( const int theViewId );
 231
 232   /**
 233    * Check if Land Cover scalar map coloring mode is on in the given view.
 234    * @param theViewId the view id
 235    * @return true if the mode is on, false if the mode is off
 236    */
 237   bool                             isLandCoversScalarMapModeOn( const int theViewId ) const;
 238
 239 protected:
 240   CAM_DataModel*                  createDataModel();
 241
 242 public slots:
 243   virtual bool                    activateModule( SUIT_Study* );
 244   virtual bool                    deactivateModule( SUIT_Study* );
 245   virtual void                    onObjectClicked( SUIT_DataObject*, int );
 246
 247 protected:
 248   virtual LightApp_Operation*     createOperation( const int ) const;
 249   virtual bool                    reusableOperation( const int id );
 250
 251   virtual void                    customEvent( QEvent* );
 252   virtual bool                    eventFilter( QObject*, QEvent* );
 253
 254 protected slots:
 255   void                            onOperation();
 256   void                            onDelete();
 257
 258
 259   bool                            onUndo( int theNumActions );
 260   bool                            onRedo( int theNumActions );
 261
 262   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 263   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 264   virtual void                    onViewCreated( SUIT_ViewWindow* );
 265
 266   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 267
 268   void                            onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
 269
 270 private:
 271   void                            updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
 272                                                 const bool theIsInit = false,
 273                                                 const bool theIsForced = false,
 274                                                 const bool theDoFitAll = false );
 275
 276   void                            createSelector( SUIT_ViewManager* viewMgr );
 277
 278   bool                            setUpdateEnabled( const bool theState );
 279   bool                            isUpdateEnabled() const;
 280
 281   QStringList                     storeSelection() const;
 282   void                            restoreSelection( const QStringList& theEntryList );
 283
 284 private:
 285   void                            createActions();
 286   void                            createMenus();
 287   void                            createPopups();
 288   void                            createToolbars();
 289
 290   void                            createUndoRedoActions();
 291   void                            updateUndoRedoControls();
 292
 293 private:
 294   QAction*                        createAction( const int theId, const QString& theSuffix,
 295                                                 const QString& theImg = QString::null,
 296                                                 const int theKey = 0, const bool isToggle = false,
 297                                                 const QString& theSlot = QString::null );
 298
 299 private:
 300   HYDROGUI_Displayer*             myDisplayer;
 301   HYDROGUI_OCCDisplayer*          myOCCDisplayer;
 302   HYDROGUI_VTKPrsDisplayer*       myVTKDisplayer;
 303
 304   ViewManagerMap                  myViewManagerMap;
 305   ViewId2Entry2ObjectStateMap     myObjectStateMap;
 306
 307   QStack<HYDROGUI_Operation*>     myActiveOperationMap;
 308
 309   ViewId2ListOfShapes             myShapesMap;
 310   ViewId2ListOfVTKPrs             myVTKPrsMap;
 311   bool                            myIsUpdateEnabled;
 312
 313   QStringList                     myGeomObjectsToImport; ///< entries of GEOM objects to be imported
 314
 315   ViewId2StricklerTable           myLandCoverColoringMap;
 316 };
 317
 318 #endif