1 // Copyright (C) 2014-2015 EDF-R&D
2 // This library is free software; you can redistribute it and/or
3 // modify it under the terms of the GNU Lesser General Public
4 // License as published by the Free Software Foundation; either
5 // version 2.1 of the License, or (at your option) any later version.
7 // This library is distributed in the hope that it will be useful,
8 // but WITHOUT ANY WARRANTY; without even the implied warranty of
9 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
10 // Lesser General Public License for more details.
12 // You should have received a copy of the GNU Lesser General Public
13 // License along with this library; if not, write to the Free Software
14 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
19 #ifndef HYDROGUI_MODULE_H
20 #define HYDROGUI_MODULE_H
22 #include <HYDROData_Entity.h>
24 #include <LightApp_Module.h>
29 class QGraphicsSceneMouseEvent;
31 class GraphicsView_Viewer;
32 class OCCViewer_Viewer;
35 class SUIT_ViewWindow;
36 class SUIT_ViewManager;
38 class Handle(HYDROData_StricklerTable);
40 class HYDROGUI_DataModel;
41 class HYDROGUI_Displayer;
42 class HYDROGUI_OCCDisplayer;
43 class HYDROGUI_VTKPrsDisplayer;
44 class HYDROGUI_AbstractDisplayer;
46 class HYDROGUI_VTKPrs;
47 class HYDROGUI_Operation;
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 };
72 CT_PointingHandCursor,
90 //VMR_PreviewZone, // totally unused, to delete
91 VMR_PreviewCaseZones // actually unused, to review
93 typedef QPair< SUIT_ViewManager*, ViewManagerRole > ViewManagerInfo;
95 typedef QMap < int, ViewManagerInfo > ViewManagerMap;
96 typedef QMapIterator< int, ViewManagerInfo > ViewManagerMapIterator;
103 ObjectState() : Visibility( false ), Transparency( 1.0 ), ZValue( 0.0 ) {}
105 typedef QMap< QString, ObjectState > Entry2ObjectStateMap;
106 typedef QMap< int, Entry2ObjectStateMap > ViewId2Entry2ObjectStateMap;
108 typedef QList<HYDROGUI_Shape*> ListOfShapes;
109 typedef QMap<int,ListOfShapes> ViewId2ListOfShapes;
111 typedef QList<HYDROGUI_VTKPrs*> ListOfVTKPrs;
112 typedef QMap<int,ListOfVTKPrs> ViewId2ListOfVTKPrs;
114 typedef QMap<int, Handle(HYDROData_StricklerTable)> ViewId2StricklerTable;
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 * Returns the cursor defined for edition operations in module preferences.
207 * \return specific cursor
209 QCursor getPrefEditCursor() const;
212 * Returns Strickler table used for Land Cover scalar map coloring in the given view.
213 * @param theViewId the view id
214 * @return the Strickler table used for scalar map coloring of Land Covers in the given view;
215 null - if scalar map coloring is off for the view
217 Handle(HYDROData_StricklerTable) getLandCoverColoringTable( const int theViewId ) const;
220 * Set Strickler table to be used for Land Cover scalar map coloring in the given view.
221 * @param theViewId the view id
222 * @param theTable the Strickler table
224 void setLandCoverColoringTable( const int theViewId,
225 const Handle(HYDROData_StricklerTable)& theTable );
227 * Set Land Cover scalar map coloring mode off for the given view.
228 * @param theViewId the view id
230 void setLandCoversScalarMapModeOff( const int theViewId );
233 * Check if Land Cover scalar map coloring mode is on in the given view.
234 * @param theViewId the view id
235 * @return true if the mode is on, false if the mode is off
237 bool isLandCoversScalarMapModeOn( const int theViewId ) const;
240 * Set object as removed.
241 * @param theObject the removed object
243 void setObjectRemoved( const Handle(HYDROData_Entity)& theObject );
246 CAM_DataModel* createDataModel();
249 virtual bool activateModule( SUIT_Study* );
250 virtual bool deactivateModule( SUIT_Study* );
251 virtual void onObjectClicked( SUIT_DataObject*, int );
254 virtual LightApp_Operation* createOperation( const int ) const;
255 virtual bool reusableOperation( const int id );
257 virtual void customEvent( QEvent* );
258 virtual bool eventFilter( QObject*, QEvent* );
265 bool onUndo( int theNumActions );
266 bool onRedo( int theNumActions );
268 virtual void onViewManagerAdded( SUIT_ViewManager* );
269 virtual void onViewManagerRemoved( SUIT_ViewManager* );
270 virtual void onViewCreated( SUIT_ViewWindow* );
272 void onViewPortMouseEvent( QGraphicsSceneMouseEvent* );
274 void onMouseMove( SUIT_ViewWindow*, QMouseEvent* );
277 void updateViewer( HYDROGUI_AbstractDisplayer* theDisplayer,
278 const bool theIsInit = false,
279 const bool theIsForced = false,
280 const bool theDoFitAll = false );
282 void createSelector( SUIT_ViewManager* viewMgr );
284 bool setUpdateEnabled( const bool theState );
285 bool isUpdateEnabled() const;
287 QStringList storeSelection() const;
288 void restoreSelection( const QStringList& theEntryList );
291 void createActions();
294 void createToolbars();
296 void createUndoRedoActions();
297 void updateUndoRedoControls();
300 QAction* createAction( const int theId, const QString& theSuffix,
301 const QString& theImg = QString::null,
302 const int theKey = 0, const bool isToggle = false,
303 const QString& theSlot = QString::null );
306 HYDROGUI_Displayer* myDisplayer;
307 HYDROGUI_OCCDisplayer* myOCCDisplayer;
308 HYDROGUI_VTKPrsDisplayer* myVTKDisplayer;
310 ViewManagerMap myViewManagerMap;
311 ViewId2Entry2ObjectStateMap myObjectStateMap;
313 QStack<HYDROGUI_Operation*> myActiveOperationMap;
315 ViewId2ListOfShapes myShapesMap;
316 ViewId2ListOfVTKPrs myVTKPrsMap;
317 bool myIsUpdateEnabled;
319 QStringList myGeomObjectsToImport; ///< entries of GEOM objects to be imported
321 ViewId2StricklerTable myLandCoverColoringMap;