1 // Copyright (C) 2007-2013 CEA/DEN, EDF R&D, OPEN CASCADE
3 // Copyright (C) 2003-2007 OPEN CASCADE, EADS/CCR, LIP6, CEA/DEN,
4 // CEDRAT, EDF R&D, LEG, PRINCIPIA R&D, BUREAU VERITAS
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.
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.
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
20 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
23 #ifndef HYDROGUI_MODULE_H
24 #define HYDROGUI_MODULE_H
26 #include <HYDROData_Entity.h>
28 #include <LightApp_Module.h>
33 class QGraphicsSceneMouseEvent;
35 class GraphicsView_Viewer;
36 class OCCViewer_Viewer;
39 class SUIT_ViewWindow;
40 class SUIT_ViewManager;
42 class HYDROGUI_DataModel;
43 class HYDROGUI_Displayer;
44 class HYDROGUI_OCCDisplayer;
45 class HYDROGUI_VTKPrsDisplayer;
46 class HYDROGUI_AbstractDisplayer;
48 class HYDROGUI_VTKPrs;
49 class HYDROGUI_Operation;
51 /**\class HYDROGUI_Module
52 *\brief The class representing the HYDROGUI module
54 class HYDROGUI_Module : public LightApp_Module
58 enum CustomEvent { NewViewEvent = QEvent::User + 100 };
69 //VMR_PreviewZone, // totally unused, to delete
70 VMR_PreviewCaseZones // actually unused, to review
72 typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
74 typedef QMap < int, ViewManagerInfo > ViewManagerMap;
75 typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
82 ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
84 typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
85 typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
87 typedef QList<HYDROGUI_Shape*> ListOfShapes;
88 typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
90 typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
91 typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
95 virtual ~HYDROGUI_Module();
97 int getStudyId() const;
99 virtual void initialize( CAM_Application* );
100 virtual void windows( QMap<int, int>& ) const;
101 virtual void viewManagers( QStringList& ) const;
103 virtual void contextMenuPopup( const QString&, QMenu*, QString& );
105 virtual void update( const int );
106 virtual void updateCommandsStatus();
108 virtual void selectionChanged();
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;
116 GraphicsView_Viewer* getViewer( const int theId ) const;
117 OCCViewer_Viewer* getOCCViewer( const int theId ) const;
118 SVTK_Viewer* getVTKViewer( const int theId ) const;
120 int getViewManagerId( SUIT_ViewManager* theViewManager );
121 ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
122 void setViewManagerRole( SUIT_ViewManager* theViewManager,
123 const ViewManagerRole theRole );
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 );
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.
136 void setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
137 const bool theState = true );
138 HYDROGUI_Shape* getObjectShape( const int theViewId,
139 const Handle(HYDROData_Entity)& theObject ) const;
140 void setObjectShape( const int theViewId,
141 const Handle(HYDROData_Entity)& theObject,
142 HYDROGUI_Shape* theShape );
143 void removeViewShapes( const int theViewId );
144 void removeObjectShape( const int theViewId,
145 const Handle(HYDROData_Entity)& theObject );
147 HYDROGUI_VTKPrs* getObjectVTKPrs( const int theViewId,
148 const Handle(HYDROData_Entity)& theObject ) const;
149 void setObjectVTKPrs( const int theViewId,
150 const Handle(HYDROData_Entity)& theObject,
151 HYDROGUI_VTKPrs* theShape );
152 void removeViewVTKPrs( const int theViewId );
153 void removeObjectVTKPrs( const int theViewId,
154 const Handle(HYDROData_Entity)& theObject );
156 void removeObjectVTKPrs( const int theViewId,
157 const QString& theEntry );
160 * Update global imposed range of Z values for the given VTK viewer id
162 void updateVTKZRange( const int theViewId, double theRange[] );
165 * Returns true if the object with the given entry can be renamed.
166 * @param theEntry the object entry
168 virtual bool renameAllowed( const QString& theEntry ) const;
170 * Returns true if the object with the given entry is renamed.
171 * @param theEntry the object entry
172 * @param theName the new name
174 virtual bool renameObject( const QString& theEntry, const QString& theName );
176 int getObjectDisplayOrder( const int theViewId,
177 const Handle(HYDROData_Entity)& theObject ) const;
179 QStack<HYDROGUI_Operation*>& getActiveOperations();
180 HYDROGUI_Operation* activeOperation();
183 CAM_DataModel* createDataModel();
186 virtual bool activateModule( SUIT_Study* );
187 virtual bool deactivateModule( SUIT_Study* );
190 virtual LightApp_Operation* createOperation( const int ) const;
191 virtual bool reusableOperation( const int id );
193 virtual void customEvent( QEvent* );
194 virtual bool eventFilter( QObject*, QEvent* );
201 bool onUndo( int theNumActions );
202 bool onRedo( int theNumActions );
204 virtual void onViewManagerAdded( SUIT_ViewManager* );
205 virtual void onViewManagerRemoved( SUIT_ViewManager* );
206 virtual void onViewCreated( SUIT_ViewWindow* );
208 void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
210 void onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
213 void updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
214 const bool theIsInit = false,
215 const bool theIsForced = false,
216 const bool theDoFitAll = false );
218 void createSelector( SUIT_ViewManager* viewMgr );
220 bool setUpdateEnabled( const bool theState );
221 bool isUpdateEnabled() const;
223 QStringList storeSelection() const;
224 void restoreSelection( const QStringList& theEntryList );
227 void createActions();
230 void createToolbars();
232 void createUndoRedoActions();
233 void updateUndoRedoControls();
236 QAction* createAction( const int theId, const QString& theSuffix,
237 const QString& theImg = QString::null,
238 const int theKey = 0, const bool isToggle = false,
239 const QString& theSlot = QString::null );
242 HYDROGUI_Displayer* myDisplayer;
243 HYDROGUI_OCCDisplayer* myOCCDisplayer;
244 HYDROGUI_VTKPrsDisplayer* myVTKDisplayer;
246 ViewManagerMap myViewManagerMap;
247 ViewId2Entry2ObjectStateMap myObjectStateMap;
249 QMap<int, QStringList> myObjectDisplayOrderMap;
250 QStack<HYDROGUI_Operation*> myActiveOperationMap;
252 ViewId2ListOfShapes myShapesMap;
253 ViewId2ListOfVTKPrs myVTKPrsMap;
254 bool myIsUpdateEnabled;
256 QStringList myGeomObjectsToImport; ///< entries of GEOM objects to be imported