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
  36 class SUIT_ViewWindow;
  37
  38 class HYDROGUI_DataModel;
  39 class HYDROGUI_Displayer;
  40 class HYDROGUI_OCCDisplayer;
  41 class HYDROGUI_Shape;
  42
  43 class OCCViewer_Viewer;
  44
  45 /**\class HYDROGUI_Module
  46  *\brief The class representing the HYDROGUI module
  47  */
  48 class HYDROGUI_Module : public LightApp_Module
  49 {
  50   Q_OBJECT
  51
  52   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  53
  54 public:
  55
  56   enum ViewManagerRole
  57   {
  58     VMR_Unknown = 0,
  59     VMR_General,
  60     VMR_TransformImage,
  61     VMR_ReferenceImage,
  62     VMR_ObserveImage,
  63     //VMR_PreviewZone, // totally unused, to delete
  64     VMR_PreviewCaseZones // actually unused, to review
  65   };
  66   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  67
  68   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  69   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  70
  71   struct ObjectState
  72   {
  73     bool Visibility;
  74     double Transparency;
  75     double ZValue;
  76     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
  77   };
  78   typedef QMap< QString, ObjectState > Name2ObjectStateMap;
  79   typedef QMap< int, Name2ObjectStateMap > ViewId2Name2ObjectStateMap;
  80
  81   typedef QList<HYDROGUI_Shape*> ListOfShapes;
  82   typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
  83
  84 public:
  85   HYDROGUI_Module();
  86   virtual ~HYDROGUI_Module();
  87
  88   int                             getStudyId() const;
  89
  90   virtual void                    initialize( CAM_Application* );
  91   virtual void                    windows( QMap<int, int>& ) const;
  92   virtual void                    viewManagers( QStringList& ) const;
  93
  94   virtual void                    contextMenuPopup( const QString&, QMenu*, QString& );
  95
  96   virtual void                    update( const int );
  97   virtual void                    updateCommandsStatus();
  98
  99   virtual void                    selectionChanged();
 100
 101   HYDROGUI_DataModel*             getDataModel() const;
 102   HYDROGUI_Displayer*             getDisplayer() const;
 103   HYDROGUI_OCCDisplayer*          getOCCDisplayer() const;
 104
 105   GraphicsView_Viewer*            getViewer( const int theId ) const;
 106   OCCViewer_Viewer*               getOCCViewer( const int theId ) const;
 107
 108   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
 109   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
 110   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
 111                                                       const ViewManagerRole theRole );
 112
 113   bool                            isObjectVisible( const int theViewId,
 114                                                    const Handle(HYDROData_Entity)& theObject ) const;
 115   void                            setObjectVisible( const int theViewId,
 116                                                     const Handle(HYDROData_Entity)& theObject,
 117                                                     const bool theState );
 118
 119   HYDROGUI_Shape*                 getObjectShape( const int                       theViewId,
 120                                                   const Handle(HYDROData_Entity)& theObject ) const;
 121   void                            setObjectShape( const int                       theViewId,
 122                                                   const Handle(HYDROData_Entity)& theObject,
 123                                                   HYDROGUI_Shape*                 theShape );
 124   void                            removeViewShapes( const int                       theViewId );
 125   void                            removeObjectShape( const int                       theViewId,
 126                                                      const Handle(HYDROData_Entity)& theObject );
 127
 128   QStringList                     GetGeomObjectsToImport();
 129
 130 protected:
 131   CAM_DataModel*                  createDataModel();
 132
 133 public slots:
 134   virtual bool                    activateModule( SUIT_Study* );
 135   virtual bool                    deactivateModule( SUIT_Study* );
 136
 137 protected:
 138   virtual LightApp_Operation*     createOperation( const int ) const;
 139   virtual bool                    reusableOperation( const int id );
 140
 141   virtual void                    customEvent( QEvent* );
 142   virtual bool                    eventFilter( QObject*, QEvent* );
 143
 144 protected slots:
 145   void                            onOperation();
 146
 147   bool                            onUndo( int theNumActions );
 148   bool                            onRedo( int theNumActions );
 149
 150   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 151   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 152   virtual void                    onViewCreated( SUIT_ViewWindow* );
 153
 154   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 155
 156   void                            onExternalOperationFinished( const QString&, const QString&,
 157                                                                const QStringList& );
 158
 159 private:
 160   void                            updateGV( const bool theIsInit = false,
 161                                             const bool theIsForced = false,
 162                                             const bool theDoFitAll = false );
 163
 164   void                            updateOCCViewer( const bool theIsInit = false,
 165                                                    const bool theIsForced = false,
 166                                                    const bool theDoFitAll = false );
 167
 168   void                            createSelector( SUIT_ViewManager* viewMgr );
 169
 170   bool                            setUpdateEnabled( const bool theState );
 171   bool                            isUpdateEnabled() const;
 172
 173   QStringList                     storeSelection() const;
 174   void                            restoreSelection( const QStringList& theEntryList );
 175
 176 private:
 177   void                            createActions();
 178   void                            createMenus();
 179   void                            createPopups();
 180   void                            createToolbars();
 181
 182   void                            createUndoRedoActions();
 183   void                            updateUndoRedoControls();
 184
 185 private:
 186   QAction*                        createAction( const int theId, const QString& theSuffix,
 187                                                 const QString& theImg = QString::null,
 188                                                 const int theKey = 0, const bool isToggle = false,
 189                                                 const QString& theSlot = QString::null );
 190
 191 private:
 192   HYDROGUI_Displayer*             myDisplayer;
 193   HYDROGUI_OCCDisplayer*          myOCCDisplayer;
 194
 195   ViewManagerMap                  myViewManagerMap;
 196   ViewId2Name2ObjectStateMap      myObjectStateMap;
 197
 198   ViewId2ListOfShapes             myShapesMap;
 199
 200   bool                            myIsUpdateEnabled;
 201
 202   QStringList                     myGeomObjectsToImport; ///< entries of GEOM objects to be imported
 203 };
 204
 205 #endif