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_Object.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
  41 /**\class HYDROGUI_Module
  42  *\brief The class representing the HYDROGUI module
  43  */
  44 class HYDROGUI_Module : public LightApp_Module
  45 {
  46   Q_OBJECT
  47
  48   enum CustomEvent { NewViewEvent = QEvent::User + 100 };
  49
  50 public:
  51   enum ViewManagerRole { VMR_Unknown = 0, VMR_General, VMR_TransformImage, VMR_ObserveImage };
  52   typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
  53
  54   typedef QMap        < int, ViewManagerInfo > ViewManagerMap;
  55   typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
  56
  57   struct ObjectState
  58   {
  59     bool Visibility;
  60     double Transparency;
  61     double ZValue;
  62     ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
  63   };
  64   typedef QMap< QString, ObjectState > Name2ObjectStateMap;
  65   typedef QMap< int, Name2ObjectStateMap > ViewId2Name2ObjectStateMap;
  66
  67 public:
  68   HYDROGUI_Module();
  69   virtual ~HYDROGUI_Module();
  70
  71   int                             getStudyId() const;
  72
  73   virtual void                    initialize( CAM_Application* );
  74   virtual void                    windows( QMap<int, int>& ) const;
  75   virtual void                    viewManagers( QStringList& ) const;
  76
  77   virtual void                    contextMenuPopup( const QString&, QMenu*, QString& );
  78
  79   virtual void                    update( const int );
  80   virtual void                    updateCommandsStatus();
  81
  82   HYDROGUI_DataModel*             getDataModel() const;
  83   HYDROGUI_Displayer*             getDisplayer() const;
  84
  85   GraphicsView_Viewer*            getViewer( const int theId ) const;
  86
  87   int                             getViewManagerId( SUIT_ViewManager* theViewManager );
  88   ViewManagerRole                 getViewManagerRole( SUIT_ViewManager* theViewManager );
  89   void                            setViewManagerRole( SUIT_ViewManager* theViewManager,
  90                                                       const ViewManagerRole theRole );
  91
  92   bool                            isObjectVisible( const int theViewId,
  93                                                    const Handle(HYDROData_Object)& theObject );
  94   void                            setObjectVisible( const int theViewId,
  95                                                     const Handle(HYDROData_Object)& theObject,
  96                                                     const bool theState );
  97
  98 protected:
  99   CAM_DataModel*                  createDataModel();
 100
 101 public slots:
 102   virtual bool                    activateModule( SUIT_Study* );
 103   virtual bool                    deactivateModule( SUIT_Study* );
 104
 105 protected:
 106   virtual LightApp_Operation*     createOperation( const int ) const;
 107
 108   virtual void                    customEvent( QEvent* );
 109   virtual bool                    eventFilter( QObject*, QEvent* );
 110
 111 protected slots:
 112   void                            onOperation();
 113
 114   bool                            onUndo( int theNumActions );
 115   bool                            onRedo( int theNumActions );
 116
 117   virtual void                    onViewManagerAdded( SUIT_ViewManager* );
 118   virtual void                    onViewManagerRemoved( SUIT_ViewManager* );
 119   virtual void                    onViewCreated( SUIT_ViewWindow* );
 120
 121   void                            onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
 122
 123 private:
 124   void                            updateGV( const bool theIsInit = false,
 125                                             const bool theIsForced = false );
 126
 127   void                            createSelector( SUIT_ViewManager* viewMgr );
 128
 129   bool                            setUpdateEnabled( const bool theState );
 130   bool                            isUpdateEnabled() const;
 131
 132 private:
 133   void                            createActions();
 134   void                            createMenus();
 135   void                            createPopups();
 136   void                            createToolbars();
 137
 138   void                            createUndoRedoActions();
 139   void                            updateUndoRedoControls();
 140
 141 private:
 142   QAction*                        createAction( const int theId, const QString& theSuffix,
 143                                                 const QString& theImg = QString::null,
 144                                                 const int theKey = 0, const bool isToggle = false,
 145                                                 const QString& theSlot = QString::null );
 146
 147 private:
 148   HYDROGUI_Displayer*             myDisplayer;
 149
 150   ViewManagerMap                  myViewManagerMap;
 151   ViewId2Name2ObjectStateMap      myObjectStateMap;
 152
 153   bool                            myIsUpdateEnabled;
 154 };
 155
 156 #endif