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>
34 class QGraphicsSceneMouseEvent;
36 class GraphicsView_Viewer;
37 class OCCViewer_Viewer;
39 class vtkWorldPointPicker;
41 class SUIT_ViewWindow;
42 class SUIT_ViewManager;
44 class HYDROGUI_DataModel;
45 class HYDROGUI_Displayer;
46 class HYDROGUI_OCCDisplayer;
47 class HYDROGUI_VTKPrsDisplayer;
48 class HYDROGUI_AbstractDisplayer;
50 class HYDROGUI_VTKPrs;
52 /**\class HYDROGUI_Module
53 *\brief The class representing the HYDROGUI module
55 class HYDROGUI_Module : public LightApp_Module
59 enum CustomEvent { NewViewEvent = QEvent::User + 100 };
70 //VMR_PreviewZone, // totally unused, to delete
71 VMR_PreviewCaseZones // actually unused, to review
73 typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
75 typedef QMap < int, ViewManagerInfo > ViewManagerMap;
76 typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
83 ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
85 typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
86 typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
88 typedef QList<HYDROGUI_Shape*> ListOfShapes;
89 typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
91 typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
92 typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
96 virtual ~HYDROGUI_Module();
98 int getStudyId() const;
100 virtual void initialize( CAM_Application* );
101 virtual void windows( QMap<int, int>& ) const;
102 virtual void viewManagers( QStringList& ) const;
104 virtual void contextMenuPopup( const QString&, QMenu*, QString& );
106 virtual void update( const int );
107 virtual void updateCommandsStatus();
109 virtual void selectionChanged();
111 SUIT_ViewManager* getViewManager( const int theId ) const;
112 HYDROGUI_DataModel* getDataModel() const;
113 HYDROGUI_Displayer* getDisplayer() const;
114 HYDROGUI_OCCDisplayer* getOCCDisplayer() const;
115 HYDROGUI_VTKPrsDisplayer* getVTKDisplayer() const;
117 GraphicsView_Viewer* getViewer( const int theId ) const;
118 OCCViewer_Viewer* getOCCViewer( const int theId ) const;
119 SVTK_Viewer* getVTKViewer( const int theId ) const;
121 int getViewManagerId( SUIT_ViewManager* theViewManager );
122 ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
123 void setViewManagerRole( SUIT_ViewManager* theViewManager,
124 const ViewManagerRole theRole );
126 bool isObjectVisible( const int theViewId,
127 const Handle(HYDROData_Entity)& theObject ) const;
128 void setObjectVisible( const int theViewId,
129 const Handle(HYDROData_Entity)& theObject,
130 const bool theState );
132 * Set IsToUpdate flag for all presentations of the given object to recompute them during
133 * the next viewer(s) updating.
134 * @param theObject the data model object
135 * @param theState the flag to set for object's presentations, it's true by default.
137 void setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
138 const bool theState = true );
139 HYDROGUI_Shape* getObjectShape( const int theViewId,
140 const Handle(HYDROData_Entity)& theObject ) const;
141 void setObjectShape( const int theViewId,
142 const Handle(HYDROData_Entity)& theObject,
143 HYDROGUI_Shape* theShape );
144 void removeViewShapes( const int theViewId );
145 void removeObjectShape( const int theViewId,
146 const Handle(HYDROData_Entity)& theObject );
148 HYDROGUI_VTKPrs* getObjectVTKPrs( const int theViewId,
149 const Handle(HYDROData_Entity)& theObject ) const;
150 void setObjectVTKPrs( const int theViewId,
151 const Handle(HYDROData_Entity)& theObject,
152 HYDROGUI_VTKPrs* theShape );
153 void removeViewVTKPrs( const int theViewId );
154 void removeObjectVTKPrs( const int theViewId,
155 const Handle(HYDROData_Entity)& theObject );
158 * Update global imposed range of Z values for the given VTK viewer id
160 void updateVTKZRange( const int theViewId, double theRange[] );
163 * Returns true if the object with the given entry can be renamed.
164 * @param theEntry the object entry
166 virtual bool renameAllowed( const QString& theEntry ) const;
168 * Returns true if the object with the given entry is renamed.
169 * @param theEntry the object entry
170 * @param theName the new name
172 virtual bool renameObject( const QString& theEntry, const QString& theName );
174 int getObjectDisplayOrder( const int theViewId,
175 const Handle(HYDROData_Entity)& theObject ) const;
178 CAM_DataModel* createDataModel();
181 virtual bool activateModule( SUIT_Study* );
182 virtual bool deactivateModule( SUIT_Study* );
185 virtual LightApp_Operation* createOperation( const int ) const;
186 virtual bool reusableOperation( const int id );
188 virtual void customEvent( QEvent* );
189 virtual bool eventFilter( QObject*, QEvent* );
196 bool onUndo( int theNumActions );
197 bool onRedo( int theNumActions );
199 virtual void onViewManagerAdded( SUIT_ViewManager* );
200 virtual void onViewManagerRemoved( SUIT_ViewManager* );
201 virtual void onViewCreated( SUIT_ViewWindow* );
203 void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
205 void onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
208 void updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
209 const bool theIsInit = false,
210 const bool theIsForced = false,
211 const bool theDoFitAll = false );
213 void createSelector( SUIT_ViewManager* viewMgr );
215 bool setUpdateEnabled( const bool theState );
216 bool isUpdateEnabled() const;
218 QStringList storeSelection() const;
219 void restoreSelection( const QStringList& theEntryList );
222 void createActions();
225 void createToolbars();
227 void createUndoRedoActions();
228 void updateUndoRedoControls();
231 QAction* createAction( const int theId, const QString& theSuffix,
232 const QString& theImg = QString::null,
233 const int theKey = 0, const bool isToggle = false,
234 const QString& theSlot = QString::null );
237 HYDROGUI_Displayer* myDisplayer;
238 HYDROGUI_OCCDisplayer* myOCCDisplayer;
239 HYDROGUI_VTKPrsDisplayer* myVTKDisplayer;
241 ViewManagerMap myViewManagerMap;
242 ViewId2Entry2ObjectStateMap myObjectStateMap;
244 QMap<int, QStringList> myObjectDisplayOrderMap;
246 ViewId2ListOfShapes myShapesMap;
247 ViewId2ListOfVTKPrs myVTKPrsMap;
248 vtkNew<vtkWorldPointPicker> myPicker;
250 bool myIsUpdateEnabled;
252 QStringList myGeomObjectsToImport; ///< entries of GEOM objects to be imported