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>
32 class QGraphicsSceneMouseEvent;
34 class GraphicsView_Viewer;
35 class OCCViewer_Viewer;
38 class SUIT_ViewWindow;
39 class SUIT_ViewManager;
41 class HYDROGUI_DataModel;
42 class HYDROGUI_Displayer;
43 class HYDROGUI_OCCDisplayer;
44 class HYDROGUI_VTKPrsDisplayer;
45 class HYDROGUI_AbstractDisplayer;
47 class HYDROGUI_VTKPrs;
49 /**\class HYDROGUI_Module
50 *\brief The class representing the HYDROGUI module
52 class HYDROGUI_Module : public LightApp_Module
56 enum CustomEvent { NewViewEvent = QEvent::User + 100 };
67 //VMR_PreviewZone, // totally unused, to delete
68 VMR_PreviewCaseZones // actually unused, to review
70 typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
72 typedef QMap < int, ViewManagerInfo > ViewManagerMap;
73 typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
80 ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
82 typedef QMap< QString, ObjectState > Name2ObjectStateMap;
83 typedef QMap< int, Name2ObjectStateMap > ViewId2Name2ObjectStateMap;
85 typedef QList<HYDROGUI_Shape*> ListOfShapes;
86 typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
88 typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
89 typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
93 virtual ~HYDROGUI_Module();
95 int getStudyId() const;
97 virtual void initialize( CAM_Application* );
98 virtual void windows( QMap<int, int>& ) const;
99 virtual void viewManagers( QStringList& ) const;
101 virtual void contextMenuPopup( const QString&, QMenu*, QString& );
103 virtual void update( const int );
104 virtual void updateCommandsStatus();
106 virtual void selectionChanged();
108 SUIT_ViewManager* getViewManager( const int theId ) const;
109 HYDROGUI_DataModel* getDataModel() const;
110 HYDROGUI_Displayer* getDisplayer() const;
111 HYDROGUI_OCCDisplayer* getOCCDisplayer() const;
112 HYDROGUI_VTKPrsDisplayer* getVTKDisplayer() const;
114 GraphicsView_Viewer* getViewer( const int theId ) const;
115 OCCViewer_Viewer* getOCCViewer( const int theId ) const;
116 SVTK_Viewer* getVTKViewer( const int theId ) const;
118 int getViewManagerId( SUIT_ViewManager* theViewManager );
119 ViewManagerRole getViewManagerRole( SUIT_ViewManager* theViewManager );
120 void setViewManagerRole( SUIT_ViewManager* theViewManager,
121 const ViewManagerRole theRole );
123 bool isObjectVisible( const int theViewId,
124 const Handle(HYDROData_Entity)& theObject ) const;
125 void setObjectVisible( const int theViewId,
126 const Handle(HYDROData_Entity)& theObject,
127 const bool theState );
129 HYDROGUI_Shape* getObjectShape( const int theViewId,
130 const Handle(HYDROData_Entity)& theObject ) const;
131 void setObjectShape( const int theViewId,
132 const Handle(HYDROData_Entity)& theObject,
133 HYDROGUI_Shape* theShape );
134 void removeViewShapes( const int theViewId );
135 void removeObjectShape( const int theViewId,
136 const Handle(HYDROData_Entity)& theObject );
138 HYDROGUI_VTKPrs* getObjectVTKPrs( const int theViewId,
139 const Handle(HYDROData_Entity)& theObject ) const;
140 void setObjectVTKPrs( const int theViewId,
141 const Handle(HYDROData_Entity)& theObject,
142 HYDROGUI_VTKPrs* theShape );
143 void removeViewVTKPrs( const int theViewId );
144 void removeObjectVTKPrs( const int theViewId,
145 const Handle(HYDROData_Entity)& theObject );
147 * Update global imposed range of Z values for the given VTK viewer id
149 void updateVTKZRange( const int theViewId, double theRange[] );
151 QStringList GetGeomObjectsToImport();
154 * Returns true if the object with the given entry can be renamed.
155 * @param theEntry the object entry
157 virtual bool renameAllowed( const QString& theEntry ) const;
159 * Returns true if the object with the given entry is renamed.
160 * @param theEntry the object entry
161 * @param theName the new name
163 virtual bool renameObject( const QString& theEntry, const QString& theName );
166 CAM_DataModel* createDataModel();
169 virtual bool activateModule( SUIT_Study* );
170 virtual bool deactivateModule( SUIT_Study* );
173 virtual LightApp_Operation* createOperation( const int ) const;
174 virtual bool reusableOperation( const int id );
176 virtual void customEvent( QEvent* );
177 virtual bool eventFilter( QObject*, QEvent* );
184 bool onUndo( int theNumActions );
185 bool onRedo( int theNumActions );
187 virtual void onViewManagerAdded( SUIT_ViewManager* );
188 virtual void onViewManagerRemoved( SUIT_ViewManager* );
189 virtual void onViewCreated( SUIT_ViewWindow* );
191 void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
193 void onExternalOperationFinished( const QString&, const QString&,
194 const QStringList& );
196 void onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
199 void updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
200 const bool theIsInit = false,
201 const bool theIsForced = false,
202 const bool theDoFitAll = false );
204 void createSelector( SUIT_ViewManager* viewMgr );
206 bool setUpdateEnabled( const bool theState );
207 bool isUpdateEnabled() const;
209 QStringList storeSelection() const;
210 void restoreSelection( const QStringList& theEntryList );
213 void createActions();
216 void createToolbars();
218 void createUndoRedoActions();
219 void updateUndoRedoControls();
222 QAction* createAction( const int theId, const QString& theSuffix,
223 const QString& theImg = QString::null,
224 const int theKey = 0, const bool isToggle = false,
225 const QString& theSlot = QString::null );
228 HYDROGUI_Displayer* myDisplayer;
229 HYDROGUI_OCCDisplayer* myOCCDisplayer;
230 HYDROGUI_VTKPrsDisplayer* myVTKDisplayer;
232 ViewManagerMap myViewManagerMap;
233 ViewId2Name2ObjectStateMap myObjectStateMap;
235 ViewId2ListOfShapes myShapesMap;
236 ViewId2ListOfVTKPrs myVTKPrsMap;
238 bool myIsUpdateEnabled;
240 QStringList myGeomObjectsToImport; ///< entries of GEOM objects to be imported