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 #ifdef WIN32
  25   #pragma warning ( disable: 4251 )
  26 #endif
  27
  28 #include <LightApp_Module.h>
  29 #include <QEvent>
  30 #include <QStack>
  31
  32 #ifdef WIN32
  33   #pragma warning ( default: 4251 )
  34 #endif
  35
  36 class QGraphicsSceneMouseEvent;
  37 class GraphicsView_Viewer;
  38 class OCCViewer_Viewer;
  39 class SVTK_Viewer;
  40
  41 class SUIT_ViewWindow;
  42 class SUIT_ViewManager;
  43
  44 class Handle(HYDROData_StricklerTable);
  45
  46 class HYDROGUI_DataModel;
  47 class HYDROGUI_Displayer;
  48 class HYDROGUI_OCCDisplayer;
  49 class HYDROGUI_VTKPrsDisplayer;
  50 class HYDROGUI_AbstractDisplayer;
  51 class HYDROGUI_Shape;
  52 class HYDROGUI_VTKPrs;
  53 class HYDROGUI_Operation;
  54
  55 /**\class HYDROGUI_Module
  56  *\brief The class representing the HYDROGUI module
  57  */
  58 class HYDROGUI_Module : public LightApp_Module
  59 {
  60   Q_OBJECT
  61
  62   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  63
  64   enum CursorType
  65   {
  66     CT_ArrowCursor = 0,
  67     CT_UpArrowCursor,
  68     CT_CrossCursor,
  69     CT_WaitCursor,
  70     CT_IBeamCursor,
  71     CT_SizeVerCursor,
  72     CT_SizeHorCursor,
  73     CT_SizeBDiagCursor,
  74     CT_SizeFDiagCursor,
  75     CT_SizeAllCursor,
  76     CT_SplitVCursor,
  77     CT_SplitHCursor,
  78     CT_PointingHandCursor,
  79     CT_ForbiddenCursor,
  80     CT_WhatsThisCursor,
  81     CT_BusyCursor,
  82     CT_OpenHandCursor,
  83     CT_ClosedHandCursor,
  84     CT_User
  85   };
  86
  87 public:
  88
  89   enum ViewManagerRole
  90   {
  91     VMR_Unknown = 0,
  92     VMR_General,
  93     VMR_TransformImage,
  94     VMR_ReferenceImage,
  95     VMR_ObserveImage,
  96     //VMR_PreviewZone, // totally unused, to delete
  97     VMR_PreviewCaseZones // actually unused, to review
  98   };
  99   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
 100
 101   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
 102   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
 103
 104   struct ObjectState
 105   {
 106     bool Visibility;
 107     double Transparency;
 108     double ZValue;
 109     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
 110   };
 111   typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
 112   typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
 113
 114   typedef QList<HYDROGUI_Shape*> ListOfShapes;
 115   typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
 116
 117   typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
 118   typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
 119
 120   typedef QMap<int, Handle(HYDROData_StricklerTable)> ViewId2StricklerTable;
 121
 122 public:
 123   HYDROGUI_Module();
 124   virtual ~HYDROGUI_Module();
 125
 126   int                             getStudyId() const;
 127
 128   virtual void                    initialize( CAM_Application* );
 129   virtual void                    windows( QMap<int, int>& ) const;
 130   virtual void                    viewManagers( QStringList& ) const;
 131
 132   virtual void                    contextMenuPopup( const QString&, QMenu*, QString& );
 133   virtual void                    createPreferences();
 134
 135   virtual void                    update( const int );
 136   virtual void                    updateCommandsStatus();
 137
 138   virtual void                    selectionChanged();
 139
 140   SUIT_ViewManager*               getViewManager( const int theId ) const;
 141   HYDROGUI_DataModel*             getDataModel() const;
 142   HYDROGUI_Displayer*             getDisplayer() const;
 143   HYDROGUI_OCCDisplayer*          getOCCDisplayer() const;
 144   HYDROGUI_VTKPrsDisplayer*       getVTKDisplayer() const;
 145
 146   GraphicsView_Viewer*            getViewer( const int theId ) const;
 147   OCCViewer_Viewer*               getOCCViewer( const int theId ) const;
 148   SVTK_Viewer*                    getVTKViewer( const int theId ) const;
 149
 150   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
 151   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
 152   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
 153                                                       const ViewManagerRole theRole );
 154
 155   bool                            isObjectVisible( const int theViewId,
 156                                                    const Handle(HYDROData_Entity)& theObject ) const;
 157   void                            setObjectVisible( const int theViewId,
 158                                                     const Handle(HYDROData_Entity)& theObject,
 159                                                     const bool theState );
 160   /**
 161    * Set IsToUpdate flag for all presentations of the given object to recompute them during
 162    * the next viewer(s) updating.
 163    * @param theObject the data model object
 164    * @param theState  the flag to set for object's presentations, it's true by default.
 165    */
 166   void                            setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
 167                                                  const bool theState = true );
 168   QList<HYDROGUI_Shape*>          getObjectShapes( const int  theViewId,
 169                                                    ObjectKind theKind ) const;
 170   HYDROGUI_Shape*                 getObjectShape( const int                       theViewId,
 171                                                   const Handle(HYDROData_Entity)& theObject ) const;
 172   void                            setObjectShape( const int                       theViewId,
 173                                                   const Handle(HYDROData_Entity)& theObject,
 174                                                   HYDROGUI_Shape*                 theShape );
 175   void                            removeViewShapes( const int                     theViewId );
 176   void                            removeObjectShape( const int                       theViewId,
 177                                                      const Handle(HYDROData_Entity)& theObject );
 178
 179   HYDROGUI_VTKPrs*                getObjectVTKPrs( const int                       theViewId,
 180                                                    const Handle(HYDROData_Entity)& theObject ) const;
 181   void                            setObjectVTKPrs( const int                       theViewId,
 182                                                    const Handle(HYDROData_Entity)& theObject,
 183                                                    HYDROGUI_VTKPrs*                theShape );
 184   void                            removeViewVTKPrs( const int                      theViewId );
 185   void                            removeObjectVTKPrs( const int                      theViewId,
 186                                                      const Handle(HYDROData_Entity)& theObject );
 187
 188   void                            removeObjectVTKPrs( const int      theViewId,
 189                                                       const QString& theEntry );
 190
 191   /**
 192    * Update global imposed range of Z values for the given VTK viewer id
 193    */
 194   void                            updateVTKZRange( const int theViewId, double theRange[] );
 195
 196   /**
 197    * Returns true if the object with the given entry can be renamed.
 198    * @param theEntry the object entry
 199    */
 200   virtual bool                    renameAllowed( const QString& theEntry ) const;
 201   /**
 202    * Returns true if the object with the given entry is renamed.
 203    * @param theEntry the object entry
 204    * @param theName the new name
 205    */
 206   virtual bool                    renameObject( const QString& theEntry, const QString& theName );
 207
 208   QStack<HYDROGUI_Operation*>&    getActiveOperations();
 209   HYDROGUI_Operation*             activeOperation();
 210
 211   /**
 212    * Returns the cursor defined for edition operations in module preferences.
 213    * \return specific cursor
 214    */
 215   QCursor                         getPrefEditCursor() const;
 216
 217   /**
 218    * Returns Strickler table used for Land Cover scalar map coloring in the given view.
 219    * @param theViewId the view id
 220    * @return the Strickler table used for scalar map coloring of Land Covers in the given view;
 221              null - if scalar map coloring is off for the view
 222    */
 223   Handle(HYDROData_StricklerTable) getLandCoverColoringTable( const int theViewId ) const;
 224
 225   /**
 226    * Set Strickler table to be used for Land Cover scalar map coloring in the given view.
 227    * @param theViewId the view id
 228    * @param theTable the Strickler table
 229    */
 230   void                             setLandCoverColoringTable( const int theViewId,
 231                                                               const Handle(HYDROData_StricklerTable)& theTable );
 232   /**
 233    * Set Land Cover scalar map coloring mode off for the given view.
 234    * @param theViewId the view id
 235    */
 236   void                             setLandCoversScalarMapModeOff( const int theViewId );
 237
 238   /**
 239    * Check if Land Cover scalar map coloring mode is on in the given view.
 240    * @param theViewId the view id
 241    * @return true if the mode is on, false if the mode is off
 242    */
 243   bool                             isLandCoversScalarMapModeOn( const int theViewId ) const;
 244
 245   /**
 246    * Set object as removed.
 247    * @param theObject the removed object
 248    */
 249   void                            setObjectRemoved( const Handle(HYDROData_Entity)& theObject );
 250
 251 protected:
 252   CAM_DataModel*                  createDataModel();
 253
 254 public slots:
 255   virtual bool                    activateModule( SUIT_Study* );
 256   virtual bool                    deactivateModule( SUIT_Study* );
 257   virtual void                    onObjectClicked( SUIT_DataObject*, int );
 258
 259 protected:
 260   virtual LightApp_Operation*     createOperation( const int ) const;
 261   virtual bool                    reusableOperation( const int id );
 262
 263   virtual void                    customEvent( QEvent* );
 264   virtual bool                    eventFilter( QObject*, QEvent* );
 265
 266 protected slots:
 267   void                            onOperation();
 268   void                            onDelete();
 269
 270
 271   bool                            onUndo( int theNumActions );
 272   bool                            onRedo( int theNumActions );
 273
 274   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 275   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 276   virtual void                    onViewCreated( SUIT_ViewWindow* );
 277
 278   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 279
 280   void                            onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
 281
 282 private:
 283   void                            updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
 284                                                 const bool theIsInit = false,
 285                                                 const bool theIsForced = false,
 286                                                 const bool theDoFitAll = false );
 287
 288   void                            createSelector( SUIT_ViewManager* viewMgr );
 289
 290   bool                            setUpdateEnabled( const bool theState );
 291   bool                            isUpdateEnabled() const;
 292
 293   QStringList                     storeSelection() const;
 294   void                            restoreSelection( const QStringList& theEntryList );
 295
 296 private:
 297   void                            createActions();
 298   void                            createMenus();
 299   void                            createPopups();
 300   void                            createToolbars();
 301
 302   void                            createUndoRedoActions();
 303   void                            updateUndoRedoControls();
 304
 305 private:
 306   QAction*                        createAction( const int theId, const QString& theSuffix,
 307                                                 const QString& theImg = QString::null,
 308                                                 const int theKey = 0, const bool isToggle = false,
 309                                                 const QString& theSlot = QString::null );
 310
 311 private:
 312   HYDROGUI_Displayer*             myDisplayer;
 313   HYDROGUI_OCCDisplayer*          myOCCDisplayer;
 314   HYDROGUI_VTKPrsDisplayer*       myVTKDisplayer;
 315
 316   ViewManagerMap                  myViewManagerMap;
 317   ViewId2Entry2ObjectStateMap     myObjectStateMap;
 318
 319   QStack<HYDROGUI_Operation*>     myActiveOperationMap;
 320
 321   ViewId2ListOfShapes             myShapesMap;
 322   ViewId2ListOfVTKPrs             myVTKPrsMap;
 323   bool                            myIsUpdateEnabled;
 324
 325   QStringList                     myGeomObjectsToImport; ///< entries of GEOM objects to be imported
 326
 327   ViewId2StricklerTable           myLandCoverColoringMap;
 328 };
 329
 330 #endif