1 // Copyright (C) 2007-2015 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, or (at your option) any later version.
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 CT_PointingHandCursor,
92 //VMR_PreviewZone, // totally unused, to delete
93 VMR_PreviewCaseZones // actually unused, to review
95 typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
97 typedef QMap < int, ViewManagerInfo > ViewManagerMap;
98 typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
105 ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
107 typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
108 typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
110 typedef QList<HYDROGUI_Shape*> ListOfShapes;
111 typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
113 typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
114 typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
118 virtual ~HYDROGUI_Module();
120 int getStudyId() const;
122 virtual void initialize( CAM_Application* );
123 virtual void windows( QMap<int, int>& ) const;
124 virtual void viewManagers( QStringList& ) const;
126 virtual void contextMenuPopup( const QString&, QMenu*, QString& );
127 virtual void createPreferences();
129 virtual void update( const int );
130 virtual void updateCommandsStatus();
132 virtual void selectionChanged();
134 SUIT_ViewManager* getViewManager( const int theId ) const;
135 HYDROGUI_DataModel* getDataModel() const;
136 HYDROGUI_Displayer* getDisplayer() const;
137 HYDROGUI_OCCDisplayer* getOCCDisplayer() const;
138 HYDROGUI_VTKPrsDisplayer* getVTKDisplayer() const;
140 GraphicsView_Viewer* getViewer( const int theId ) const;
141 OCCViewer_Viewer* getOCCViewer( const int theId ) const;
142 SVTK_Viewer* getVTKViewer( const int theId ) const;
144 int getViewManagerId( SUIT_ViewManager* theViewManager );
145 ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
146 void setViewManagerRole( SUIT_ViewManager* theViewManager,
147 const ViewManagerRole theRole );
149 bool isObjectVisible( const int theViewId,
150 const Handle(HYDROData_Entity)& theObject ) const;
151 void setObjectVisible( const int theViewId,
152 const Handle(HYDROData_Entity)& theObject,
153 const bool theState );
155 * Set IsToUpdate flag for all presentations of the given object to recompute them during
156 * the next viewer(s) updating.
157 * @param theObject the data model object
158 * @param theState the flag to set for object's presentations, it's true by default.
160 void setIsToUpdate( const Handle(HYDROData_Entity)& theObject,
161 const bool theState = true );
162 QList<HYDROGUI_Shape*> getObjectShapes( const int theViewId,
163 ObjectKind theKind ) const;
164 HYDROGUI_Shape* getObjectShape( const int theViewId,
165 const Handle(HYDROData_Entity)& theObject ) const;
166 void setObjectShape( const int theViewId,
167 const Handle(HYDROData_Entity)& theObject,
168 HYDROGUI_Shape* theShape );
169 void removeViewShapes( const int theViewId );
170 void removeObjectShape( const int theViewId,
171 const Handle(HYDROData_Entity)& theObject );
173 HYDROGUI_VTKPrs* getObjectVTKPrs( const int theViewId,
174 const Handle(HYDROData_Entity)& theObject ) const;
175 void setObjectVTKPrs( const int theViewId,
176 const Handle(HYDROData_Entity)& theObject,
177 HYDROGUI_VTKPrs* theShape );
178 void removeViewVTKPrs( const int theViewId );
179 void removeObjectVTKPrs( const int theViewId,
180 const Handle(HYDROData_Entity)& theObject );
182 void removeObjectVTKPrs( const int theViewId,
183 const QString& theEntry );
186 * Update global imposed range of Z values for the given VTK viewer id
188 void updateVTKZRange( const int theViewId, double theRange[] );
191 * Returns true if the object with the given entry can be renamed.
192 * @param theEntry the object entry
194 virtual bool renameAllowed( const QString& theEntry ) const;
196 * Returns true if the object with the given entry is renamed.
197 * @param theEntry the object entry
198 * @param theName the new name
200 virtual bool renameObject( const QString& theEntry, const QString& theName );
202 QStack<HYDROGUI_Operation*>& getActiveOperations();
203 HYDROGUI_Operation* activeOperation();
206 CAM_DataModel* createDataModel();
209 virtual bool activateModule( SUIT_Study* );
210 virtual bool deactivateModule( SUIT_Study* );
211 virtual void onObjectClicked( SUIT_DataObject*, int );
214 virtual LightApp_Operation* createOperation( const int ) const;
215 virtual bool reusableOperation( const int id );
217 virtual void customEvent( QEvent* );
218 virtual bool eventFilter( QObject*, QEvent* );
225 bool onUndo( int theNumActions );
226 bool onRedo( int theNumActions );
228 virtual void onViewManagerAdded( SUIT_ViewManager* );
229 virtual void onViewManagerRemoved( SUIT_ViewManager* );
230 virtual void onViewCreated( SUIT_ViewWindow* );
232 void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
234 void onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
237 void updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
238 const bool theIsInit = false,
239 const bool theIsForced = false,
240 const bool theDoFitAll = false );
242 void createSelector( SUIT_ViewManager* viewMgr );
244 bool setUpdateEnabled( const bool theState );
245 bool isUpdateEnabled() const;
247 QStringList storeSelection() const;
248 void restoreSelection( const QStringList& theEntryList );
251 void createActions();
254 void createToolbars();
256 void createUndoRedoActions();
257 void updateUndoRedoControls();
260 QAction* createAction( const int theId, const QString& theSuffix,
261 const QString& theImg = QString::null,
262 const int theKey = 0, const bool isToggle = false,
263 const QString& theSlot = QString::null );
266 HYDROGUI_Displayer* myDisplayer;
267 HYDROGUI_OCCDisplayer* myOCCDisplayer;
268 HYDROGUI_VTKPrsDisplayer* myVTKDisplayer;
270 ViewManagerMap myViewManagerMap;
271 ViewId2Entry2ObjectStateMap myObjectStateMap;
273 QStack<HYDROGUI_Operation*> myActiveOperationMap;
275 ViewId2ListOfShapes myShapesMap;
276 ViewId2ListOfVTKPrs myVTKPrsMap;
277 bool myIsUpdateEnabled;
279 QStringList myGeomObjectsToImport; ///< entries of GEOM objects to be imported