1 // PARAVIS : ParaView wrapper SALOME module
3 // Copyright (C) 2010-2014 CEA/DEN, EDF R&D
5 // This library is free software; you can redistribute it and/or
6 // modify it under the terms of the GNU Lesser General Public
7 // License as published by the Free Software Foundation; either
8 // version 2.1 of the License, or (at your option) any later version.
10 // This library is distributed in the hope that it will be useful,
11 // but WITHOUT ANY WARRANTY; without even the implied warranty of
12 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 // Lesser General Public License for more details.
15 // You should have received a copy of the GNU Lesser General Public
16 // License along with this library; if not, write to the Free Software
17 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
21 // File : PVGUI_Module.h
22 // Author : Sergey ANIKIN
26 #ifndef PVGUI_Module_H
27 #define PVGUI_Module_H
29 #include <SalomeApp_Module.h>
30 #include <SALOMEconfig.h>
31 #include CORBA_SERVER_HEADER(PVSERVER_Gen)
37 #include <pqVariableType.h>
45 class pqMainWindowCore;
46 class vtkEventQtSlotConnect;
47 class pqPythonScriptEditor;
48 class pqPVApplicationCore;
49 class pqDataRepresentation;
50 class pqRepresentation;
51 class PVViewer_GUIElements;
52 class PVViewer_EngineWrapper;
54 class PVGUI_Module : public SalomeApp_Module
103 CreateCustomFilterId,
104 ManageCustomFiltersId,
108 ManagePluginsExtensionsId,
111 RecordTestScreenshotId,
126 // Menu "Window" - "New Window"
129 // "Save state" ParaVis module root object popup
132 // "Add state" and "Reload state" popups
134 CleanAndAddStatePopupId,
136 // "Rename" and "Delete" popups (Object Browser)
145 virtual void initialize( CAM_Application* );
146 virtual void windows( QMap<int, int>& ) const;
148 virtual QString engineIOR() const; // to be removed when becoming Light
150 void openFile(const char* theName);
151 void executeScript(const char *script);
152 void saveParaviewState(const char* theFileName);
153 void loadParaviewState(const char* theFileName);
154 void clearParaviewState();
156 QString getTraceString();
159 void saveTrace(const char* theName);
161 pqServer* getActiveServer();
163 virtual void createPreferences();
165 virtual void contextMenuPopup(const QString& theClient, QMenu* theMenu, QString& theTitle);
167 inline static PVViewer_EngineWrapper * GetEngine();
168 inline static PVSERVER_ORB::PVSERVER_Gen_var GetCPPEngine(); // to be removed once light!
169 inline static pqPVApplicationCore * GetPVApplication();
171 virtual CAM_DataModel* createDataModel();
172 void fixAnimationScene();
175 //void onImportFromVisu(QString theEntry);
178 void deleteTemporaryFiles();
180 //! Create actions for ParaView GUI operations
181 void pvCreateActions();
183 //! Create menus for ParaView GUI operations duplicating menus in pqMainWindow ParaView class
184 void pvCreateMenus();
186 //! Create toolbars for ParaView GUI operations duplicating toolbars in pqMainWindow ParaView class
187 void pvCreateToolBars();
189 //! Create dock widgets for ParaView widgets
190 void setupDockWidgets();
192 //! Save states of dockable ParaView widgets
193 void saveDockWidgetsState();
195 //! Restore states of dockable ParaView widgets
196 void restoreDockWidgetsState();
198 //! Shows or hides ParaView view window
199 void showView( bool );
201 //! Returns QMenu object for a given menu id
202 QMenu* getMenu( const int );
204 //! Discover help project files from the resources.
205 QString getHelpFileName();
207 //! Create actions for ParaViS
208 void createActions();
210 //! Create menus for ParaViS
213 //! Load selected state
214 void loadSelectedState(bool toClear);
216 //! Get list of embedded macros files
217 QStringList getEmbeddedMacrosList();
219 //! update macros state
222 //! store visibility of the common dockable windows (OB, PyConsole, ... etc.)
223 void storeCommonWindowsState();
225 //! restore visibility of the common dockable windows (OB, PyConsole, ... etc.)
226 void restoreCommonWindowsState();
230 void showHelpForProxy( const QString&, const QString& );
234 void endWaitCursor();
236 // void buildToolbarsMenu();
238 //void showParaViewHelp();
239 //void showHelp(const QString& url);
241 void onDataRepresentationUpdated();
243 void onStartProgress();
244 void onEndProgress();
246 void onRestartTrace();
248 // void onNewParaViewWindow();
250 void onSaveMultiState();
252 void onCleanAddState();
258 virtual bool activateModule( SUIT_Study* );
259 virtual bool deactivateModule( SUIT_Study* );
260 virtual void onApplicationClosed( SUIT_Application* );
261 virtual void studyClosed( SUIT_Study* );
264 virtual void onModelOpened();
265 virtual void onPushTraceTimer();
266 virtual void onInitTimer();
269 int mySelectionControlsTb;
272 int myToolbarsMenuId;
276 typedef QMap<QWidget*, bool> WgMap;
279 WgMap myToolbarBreaks;
280 QList<QMenu*> myMenus;
282 typedef QMap<int, bool> DockWindowMap;
283 DockWindowMap myCommonMap;
285 QStringList myTemporaryFiles;
287 QtMsgHandler myOldMsgHandler;
289 vtkEventQtSlotConnect *VTKConnect;
291 pqPythonScriptEditor* myTraceWindow;
295 //! Single shot timer used to connect to the PVServer, and start the trace.
296 QTimer * myInitTimer;
298 //! Timer used to regularly push the Python trace to the engine.
299 QTimer * myPushTraceTimer;
301 PVViewer_GUIElements * myGuiElements;
303 static PVSERVER_ORB::PVSERVER_Gen_var MyEngine;
307 #endif // PVGUI_Module_H