1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
3 #ifndef XGUI_WORKSHOP_H
4 #define XGUI_WORKSHOP_H
7 //#include "XGUI_Constants.h"
8 #include <Events_Listener.h>
9 #include <ModuleBase_Definitions.h>
10 #include <ModelAPI_Document.h>
11 #include <ModelAPI_Feature.h>
13 #include <ModuleBase_ActionInfo.h>
17 #include <QKeySequence>
20 class AppElements_MainWindow;
21 class AppElements_Command;
22 class AppElements_Workbench;
24 class XGUI_SelectionMgr;
26 class XGUI_OperationMgr;
27 class XGUI_SalomeConnector;
28 class XGUI_ObjectsBrowser;
29 class XGUI_ActionsMgr;
30 class XGUI_ErrorDialog;
31 class XGUI_SalomeViewer;
32 class XGUI_ViewerProxy;
33 class XGUI_PropertyPanel;
34 class XGUI_ContextMenuMgr;
35 class XGUI_ModuleConnector;
37 class ModuleBase_Operation;
38 class ModuleBase_IModule;
39 class ModuleBase_IViewer;
41 class Config_FeatureMessage;
42 class Config_PointerMessage;
48 class ModelAPI_ObjectUpdatedMessage;
49 class ModelAPI_ObjectDeletedMessage;
50 class ModelAPI_ResultPart;
53 /**\class XGUI_Workshop
55 * \brief Class which defines a configuration of the application (Workshop) and launches it.
57 class XGUI_EXPORT XGUI_Workshop : public QObject, public Events_Listener
62 /// \param theConnector a Salome connector object.
63 /// Used only if the workshop is launched in Salome environment
64 XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
65 virtual ~XGUI_Workshop();
67 //! Starting of the application
68 void startApplication();
70 //! Returns main window (Desktop) of the application
71 AppElements_MainWindow* mainWindow() const
76 //! Returns selection manager object
77 XGUI_SelectionMgr* selector() const
83 XGUI_Displayer* displayer() const
88 //! ! Returns operation manager.
89 XGUI_OperationMgr* operationMgr() const
91 return myOperationMgr;
94 //! ! Returns an actions manager
95 XGUI_ActionsMgr* actionsMgr() const
100 //! Returns property panel widget
101 XGUI_PropertyPanel* propertyPanel() const
103 return myPropertyPanel;
106 //! Returns context menu manager object
107 XGUI_ContextMenuMgr* contextMenuMgr() const
109 return myContextMenuMgr;
112 //! Creates and adds a new workbench (menu group) with the given name and returns it
113 AppElements_Workbench* addWorkbench(const QString& theName);
115 //! Redefinition of Events_Listener method
116 virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
118 //! Returns an object which provides interface to Salome Module (LightApp_Module)
119 XGUI_SalomeConnector* salomeConnector() const
121 return mySalomeConnector;
124 //! Provides an object which provides interface to Salome Viewer
125 ModuleBase_IViewer* salomeViewer() const;
127 //! Returns true if the application works as SALOME module
128 bool isSalomeMode() const
130 return mySalomeConnector != 0;
133 //! Returns Object browser
134 XGUI_ObjectsBrowser* objectBrowser() const
136 return myObjectBrowser;
139 /// This method is called by Salome module when selection is changed
140 void salomeViewerSelectionChanged();
142 /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
143 XGUI_ViewerProxy* viewer() const
145 return myViewerProxy;
148 /// Returns the module connectory
149 /// \returns the instance of connector
150 XGUI_ModuleConnector* moduleConnector() const
152 return myModuleConnector;
155 /// Returns a desktop
156 /// \return a desktop instance
157 QMainWindow* desktop() const;
160 void deleteObjects();
162 //! Returns true if there is at least one selected body/construction/group result
163 //! \return boolean value
164 bool canChangeColor() const;
166 //! Change color of the features if it is possible
167 //! The operation is available for construction, body and group results
168 //! theObjects a list of selected objects
169 void changeColor(const QObjectPtrList& theObjects);
171 //! Show the given features in 3d Viewer
172 void showObjects(const QObjectPtrList& theList, bool isVisible);
174 //! Show the given features in 3d Viewer
175 void showOnlyObjects(const QObjectPtrList& theList);
177 /// Set display mode for the given onjects
178 /// \param theList a list of displayed objects
179 /// \param theMode a mode to set (see \ref XGUI_Displayer)
180 void setDisplayMode(const QObjectPtrList& theList, int theMode);
182 /// Returns current module
183 ModuleBase_IModule* module() const
188 /// Returns current directory whic contains data files
189 QString currentDataDir() const { return myCurrentDir; }
191 /// Returns current directory whic contains data files
192 void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
195 * Save the current document into a directory
196 * \param theName - path to the directory
197 * \param theFileNames - returned file names created in this directory
199 void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
202 * If there is an active (uncommited) operation shows a prompt to abort it
203 * and performs abortion if user agreed. Returns true if
204 * - operation aborted successfully
205 * - there is no active operation
207 bool isActiveOperationAborted();
209 //! Delete features. Delete the referenced features. There can be a question with a list of referenced
211 //! \param theList an objects to be deleted
212 //! \param theIgnoredFeatures a list of features to be ignored during delete
213 //! \param theParent a parent widget for the question message box
214 //! \param theAskAboutDeleteReferences if true, the message box with a list of references to the
215 //! objects features appear. If the user chose do not continue, the deletion is not performed
216 //! \return the success of the delete
217 static bool deleteFeatures(const QObjectPtrList& theList,
218 std::set<FeaturePtr> theIgnoredFeatures = std::set<FeaturePtr>(),
219 QWidget* theParent = 0,
220 const bool theAskAboutDeleteReferences = false);
223 /// Emitted when selection happens in Salome viewer
224 void salomeViewerSelection();
226 /// Emitted when error in applivation happens
227 void errorOccurred(const QString&);
229 //! the signal about the workshop actions states are updated.
230 void commandStatusUpdated();
232 //! the application is started
233 void applicationStarted();
235 //! Signal to update Undo history list
236 void updateUndoHistory(const QList<ActionInfo>&);
237 //! Signal to update Redo history list
238 void updateRedoHistory(const QList<ActionInfo>&);
241 /// Update of commands status
242 void updateCommandStatus();
244 /// update history list (undo/redo commands)
245 void updateHistory();
247 /// Create a new dokument
250 /// Open document from file
253 /// Save current document
256 /// Save current document to a file selected by user
262 /// Undo last command
263 void onUndo(int times = 1);
265 /// Redo previous command
266 void onRedo(int times = 1);
268 /// Rebuild data tree
271 /// Open preferences dialog box
272 void onPreferences();
274 /// Show property panel
275 void showPropertyPanel();
277 /// Hide property panel
278 void hidePropertyPanel();
280 /// Show object Browser
281 void showObjectBrowser();
283 /// Hide object Browser
284 void hideObjectBrowser();
286 /// Reaction on command call
287 void onFeatureTriggered();
290 void closeDocument();
293 /// Find the nested features and set them into the operation
294 /// \param theOperation an operation
295 void setNestedFeatures(ModuleBase_Operation* theOperation);
297 /// Update the property panel content by the XML description of the operation and set the panel
298 /// into the operation
299 /// \param theOperation an operation
300 void setPropertyPanel(ModuleBase_Operation* theOperation);
302 /// Procedure to process postponed events
303 bool event(QEvent * theEvent);
305 //Event-loop processing methods:
307 /// Process event "Add a feature"
308 void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
310 /// Connect to operation signals
311 /// \param theOperation an operation
312 void connectWithOperation(ModuleBase_Operation* theOperation);
314 /// Process feature update message
315 void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
317 ///Process feature created message
318 void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
320 /// Process feature redisplay message
321 void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
323 /// Display all results
324 void displayAllResults();
326 /// Displau results from document
327 /// \param theDoc a document
328 void displayDocumentResults(DocumentPtr theDoc);
330 /// Display results from a group
331 void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
334 /// SLOT, that is called after the operation is started. Update workshop state according to
335 /// the started operation, e.g. visualizes the property panel and connect to it.
336 /// \param theOpertion a started operation
337 void onOperationStarted(ModuleBase_Operation* theOperation);
339 /// SLOT, that is called after the operation is resumed. Update workshop state according to
340 /// the started operation, e.g. visualizes the property panel and connect to it.
341 /// \param theOpertion a resumed operation
342 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
344 /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
345 /// hides the property panel and udpate the command status.
346 /// \param theOpertion a stopped operation
347 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
349 /// SLOT, that is called after the operation is committed.
350 /// \param theOpertion a commmitted operation
351 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
353 /// SLOT, that is called after the operation is aborted.
354 /// \param theOpertion an aborted operation
355 void onOperationAborted(ModuleBase_Operation* theOperation);
357 /// Slot, which reacts to the context popup menu call
358 /// \param theId the data value of the clicked action
359 /// \param isChecked a state of toggle if the action is checkable
360 void onContextMenuCommand(const QString& theId, bool isChecked);
362 /// Set waiting cursor
363 void onStartWaiting();
369 /// Register validators
370 void registerValidators() const;
372 /// Load module from external library
373 /// \param theModule name of the module
374 ModuleBase_IModule* loadModule(const QString& theModule);
377 bool activateModule();
379 /// Create object browser widget
380 /// \param theParent a parent of widget
381 QDockWidget* createObjectBrowser(QWidget* theParent);
383 /// Create property panel widget
384 /// \param theParent a parent of widget
385 QDockWidget* createPropertyPanel(QWidget* theParent);
387 // Creates Dock widgets: Object browser and Property panel
388 void createDockWidgets();
390 /// Displaus object and fit all viewer if the object is first (update viewer will not be called)
391 /// Asks the module whether the object can be displayed
392 /// \param theObj an object
393 /// \return true if the object is displayed
394 bool displayObject(ObjectPtr theObj);
396 //! Extends undo/redo toolbutton's with history menu
397 //! \param theObject - in the OpenParts it is a QToolButton by itself,
398 //! in salome mode - QAction that creates a button.
399 //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
400 //! \param theSlot - onUndo(int) or onRedo(int) SLOT
401 void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
403 //! Creates list of actions (commands) by given history list from session
404 QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
407 AppElements_MainWindow* myMainWindow;
408 ModuleBase_IModule* myModule;
409 XGUI_ObjectsBrowser* myObjectBrowser;
410 XGUI_PropertyPanel* myPropertyPanel;
411 XGUI_SelectionMgr* mySelector;
412 XGUI_Displayer* myDisplayer;
413 XGUI_OperationMgr* myOperationMgr; ///< manager to manipulate through the operations
414 XGUI_ActionsMgr* myActionsMgr;
415 XGUI_SalomeConnector* mySalomeConnector;
416 XGUI_ErrorDialog* myErrorDlg;
417 XGUI_ViewerProxy* myViewerProxy;
418 XGUI_ContextMenuMgr* myContextMenuMgr;
419 XGUI_ModuleConnector* myModuleConnector;
421 QString myCurrentDir;
425 // Flag to check that part document is in process of activating
426 bool myPartActivating;
428 /// The flag is true when we loading a document
429 bool myIsLoadingData;