1 // Copyright (C) 2014-2021 CEA/DEN, EDF R&D
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
20 #ifndef XGUI_WORKSHOP_H
21 #define XGUI_WORKSHOP_H
25 #include <ModelAPI_Document.h>
26 #include <ModelAPI_Feature.h>
27 #include <ModelAPI_ResultBody.h>
29 #include <ModuleBase_ActionInfo.h>
30 #include <ModuleBase_ActionType.h>
31 #include <ModuleBase_Definitions.h>
33 #include <SelectMgr_ListOfFilter.hxx>
37 #include <QKeySequence>
39 #include <QTemporaryDir>
42 class AppElements_Command;
43 class AppElements_MainWindow;
44 class AppElements_Workbench;
47 class Config_DataModelReader;
49 class XGUI_ActionsMgr;
50 class XGUI_ActiveControlMgr;
51 class XGUI_ContextMenuMgr;
53 class XGUI_ErrorDialog;
55 class XGUI_FacesPanel;
57 class XGUI_ModuleConnector;
58 class XGUI_ObjectsBrowser;
59 class XGUI_OperationMgr;
60 class XGUI_PropertyPanel;
61 class XGUI_SalomeConnector;
62 class XGUI_SalomeViewer;
63 class XGUI_SelectionActivate;
64 class XGUI_SelectionMgr;
65 class XGUI_ViewerProxy;
66 class XGUI_WorkshopListener;
67 class XGUI_InspectionPanel;
69 class ModuleBase_IModule;
70 class ModuleBase_IViewer;
71 class ModuleBase_Operation;
78 /// \class XGUI_Workshop
80 /// \brief Class which defines a configuration of the application (Workshop) and launches it.
81 class XGUI_EXPORT XGUI_Workshop : public QObject
86 /// \param theConnector a Salome connector object.
87 /// Used only if the workshop is launched in Salome environment
88 XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
89 virtual ~XGUI_Workshop();
91 /// Starting of the application
92 void startApplication();
94 /// Activates the module controls. Should be called after module creation
95 void activateModule();
97 /// Deactivates the module controls. Should be called after module creation
98 void deactivateModule();
101 /// Returns main window (Desktop) of the application
102 AppElements_MainWindow* mainWindow() const { return myMainWindow; }
104 /// Creates and adds a new workbench (menu group) with the given name and returns it
105 AppElements_Workbench* addWorkbench(const QString& theName);
108 /// Returns selection manager object
109 XGUI_SelectionMgr* selector() const { return mySelector; }
111 /// Returns selection activating object
112 XGUI_SelectionActivate* selectionActivate() const { return mySelectionActivate; }
114 /// Returns displayer
115 XGUI_Displayer* displayer() const { return myDisplayer; }
117 /// Returns operation manager.
118 XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
120 /// Returns error manager.
121 XGUI_ErrorMgr* errorMgr() const { return myErrorMgr; }
123 /// Returns an actions manager
124 XGUI_ActionsMgr* actionsMgr() const { return myActionsMgr; }
126 /// Returns an active control manager
127 XGUI_ActiveControlMgr* activeControlMgr() const { return myActiveControlMgr; }
129 /// Returns an actions manager
130 XGUI_MenuMgr* menuMgr() const { return myMenuMgr; }
132 /// Returns property panel widget
133 XGUI_PropertyPanel* propertyPanel() const { return myPropertyPanel; }
135 /// Returns property panel widget
136 XGUI_InspectionPanel* inspectionPanel() const { return myInspectionPanel; }
138 /// Returns panel for hide object faces
139 XGUI_FacesPanel* facesPanel() const { return myFacesPanel; }
141 /// Returns context menu manager object
142 XGUI_ContextMenuMgr* contextMenuMgr() const { return myContextMenuMgr; }
144 /// Returns an object which provides interface to Salome Module (LightApp_Module)
145 XGUI_SalomeConnector* salomeConnector() const { return mySalomeConnector; }
147 /// Provides an object which provides interface to Salome Viewer
148 ModuleBase_IViewer* salomeViewer() const;
150 /// Returns true if the application works as SALOME module
151 bool isSalomeMode() const { return mySalomeConnector != 0; }
153 /// Returns Object browser
154 XGUI_ObjectsBrowser* objectBrowser() const { return myObjectBrowser; }
156 /// This method is called by Salome module when selection is changed
157 void salomeViewerSelectionChanged();
159 /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
160 XGUI_ViewerProxy* viewer() const { return myViewerProxy; }
162 /// Returns the module connector
163 /// \returns the instance of connector
164 XGUI_ModuleConnector* moduleConnector() const { return myModuleConnector; }
166 /// Returns a desktop
167 /// \return a desktop instance
168 QMainWindow* desktop() const;
170 /// If faces panel made the object hidden, show message box whether the object should be
171 /// restored (removed from the panel) and displayed, if answer is No, returns false
172 /// \param theObject a model object
173 /// \return boolean state if the object should not be displayed
174 virtual bool prepareForDisplay(const std::set<ObjectPtr>& theObjects) const;
177 void deleteObjects();
179 /// Searches for selected features unused in other (not selected) features. If one or several
180 /// selected features are found, a warning message proposes to delete them. It contains
181 /// the list of features to be deleted.
184 /// Returns true if the selected feature can be moved to the position after the current feature
185 /// \return boolean value
186 bool canMoveFeature();
188 /// Move selected features to be after the current feature
189 void moveObjects(const bool theSplit);
191 /// Returns true if the object can be shaded. If the object is a compsolid result, the method
192 /// checks subobjects of the result
193 /// \return boolean value
194 bool canBeShaded(const ObjectPtr& theObject) const;
196 /// Returns true if there is at least one selected body/construction/group result
197 /// \param theActionName text of the checked action
198 /// \return boolean value
199 bool canChangeProperty(const QString& theActionName) const;
201 /// Change color of the results if it is possible
202 /// The operation is available for construction, body and group results
203 /// theObjects a list of selected objects
204 void changeColor(const QObjectPtrList& theObjects);
206 /// Change Autocolor of the results if it is possible
207 /// The operation is available for group results
208 /// theObjects a list of selected objects
209 void changeAutoColor(const QObjectPtrList& theObjects);
211 /// Change deflection of the results if it is possible
212 /// The operation is available for construction, body and group results
213 /// theObjects a list of selected objects
214 void changeDeflection(const QObjectPtrList& theObjects);
216 /// Change transparency of the results if it is possible
217 /// The operation is available for construction, body and group results
218 /// theObjects a list of selected objects
219 void changeTransparency(const QObjectPtrList& theObjects);
221 /// Change number of iso-lines for the given objects
222 /// theObjects a list of selected objects
223 void changeIsoLines(const QObjectPtrList& theObjects);
225 /// Show the given features in 3d Viewer
226 void showObjects(const QObjectPtrList& theList, bool isVisible);
228 /// Show the given features in 3d Viewer
229 void showOnlyObjects(const QObjectPtrList& theList);
231 /// Set display mode for the given objects
232 /// \param theList a list of displayed objects
233 /// \param theMode a mode to set (see \ref XGUI_Displayer)
234 void setDisplayMode(const QObjectPtrList& theList, int theMode);
236 /// Set selection mode in viewer. If theMode=-1 then activate default mode
237 /// \param theMode the selection mode (according to TopAbs_ShapeEnum)
238 void setViewerSelectionMode(int theMode);
240 /// Activates current selection mode for the given list of objects
241 void activateObjectsSelection(const QObjectPtrList& theList);
243 /// Returns current module
244 ModuleBase_IModule* module() const { return myModule; }
246 /// Returns current file
247 QString currentDataFile() const { return myCurrentFile; }
249 /// Returns current file
250 void setCurrentDataFile(const QString& theDir) { myCurrentFile = theDir; }
252 /// Save the current document into a directory
253 /// \param theName - path to the directory
254 /// \param theFileNames - returned file names created in this directory
255 void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
257 /// If there is an active (uncommitted) operation shows a prompt to abort it
258 /// and performs abortion if user agreed. Returns true if
259 /// - operation aborted successfully
260 /// - there is no active operation
261 bool abortAllOperations();
263 /// Updates workshop state according to the started operation, e.g. visualizes the property panel
264 /// and connect to it.
265 /// \param theOpertion a started operation
266 void operationStarted(ModuleBase_Operation* theOperation);
268 /// Delete features. Delete the referenced features. There can be a question with a list of
269 /// referenced objects.
270 /// \param theFeatures a list of objects to be deleted
271 bool deleteFeatures(const QObjectPtrList& theFeatures);
273 /// Deactivates the object, if it is active and the module returns that the activation
274 /// of selection for the object is not possible currently(the current operation uses it)
275 /// \param theObject an object
276 /// \param theUpdateViewer a boolean flag to update viewer immediately
277 void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
279 /// Returns true if the action of the feature is created to contain Accept/Cancel button
280 /// \param theFeature a feature
281 bool isFeatureOfNested(const FeaturePtr& theFeature);
283 /// Shows the message in the status bar
284 /// \param theMessage a message
285 void setStatusBarMessage(const QString& theMessage);
288 /// Has to be called in order to display objects with visibility status = true
289 void synchronizeViewer();
291 /// Has to be called in order to display objects from a specifed group
292 /// with visibility status = true
293 /// \param theDoc the document for objects synchronisation
294 /// \param theUpdateViewer update viewer flag
295 void synchronizeGroupInViewer(const DocumentPtr& theDoc,
296 bool theUpdateViewer);
298 void synchronizeResultTree(const ResultBodyPtr& theRes, bool theUpdateViewer);
301 /// Update the property panel content by the XML description of the operation and set the panel
302 /// into the operation
303 /// \param theOperation an operation
304 void fillPropertyPanel(ModuleBase_Operation* theOperation);
306 /// Connects or disconnects to the value changed signal of the property panel widgets
307 /// \param isToConnect a boolean value whether connect or disconnect
308 void connectToPropertyPanel(const bool isToConnect);
310 /// Returns defailt selection mode in 3d viewer
311 QIntList viewerSelectionModes() const { return myViewerSelMode; }
313 /// Highlights result objects in Object Browser according to
314 /// features found in the given list
315 void highlightResults(const QObjectPtrList& theObjects);
317 /// Highlights feature objects in Object Browser according to
318 /// features found in the given list
319 void highlightFeature(const QObjectPtrList& theObjects);
321 /// Returns Data Model XML reader which contains information about
322 /// Data structure configuration
323 const Config_DataModelReader* dataModelXMLReader() const { return myDataModelXMLReader; }
325 /// A constant string used for "Move to end" command definition
326 /// It is used for specific processing of Undo/Redo for this command.
327 static QString MOVE_TO_END_COMMAND;
328 /// A constant string used for "Move to end and split" command definition
329 /// It is used for specific processing of Undo/Redo for this command.
330 static QString MOVE_TO_END_SPLIT_COMMAND;
332 /// Closes all in the current session and load the directory
333 /// \param theDirectory a path to directory
334 void openFile(const QString& theDirectory);
336 void updateAutoComputeState();
338 void deactivateCurrentSelector();
340 /// The method updates a Color Scale object in the viewer
341 void updateColorScaleVisibility();
343 void showHelpPage(const QString& thePage) const;
346 /// Emitted when selection happens in Salome viewer
347 void salomeViewerSelection();
349 /// the signal about the workshop actions states are updated.
350 void commandStatusUpdated();
352 /// the application is started
353 void applicationStarted();
355 /// Signal to update Undo history list
356 void updateUndoHistory(const QList<ActionInfo>&);
358 /// Signal to update Redo history list
359 void updateRedoHistory(const QList<ActionInfo>&);
362 /// Update of commands status
363 void updateCommandStatus();
365 /// update history list (undo/redo commands)
366 void updateHistory();
368 /// Save current document
371 /// Save current document to a file selected by user
374 /// Undo last command
375 void onUndo(int times = 1);
377 /// Redo previous command
378 void onRedo(int times = 1);
380 /// Validates the operation to change the "Apply" button state.
381 /// \param thePreviousState the previous state of the widget
382 void onWidgetStateChanged(int thePreviousState);
384 /// Calls activate of the current widget again. It is possible that selection filters are
385 /// differs in the new state of paged container
386 void onValuesChanged();
388 /// Listens the corresponded signal of model widget and updates Apply button state by feature
389 void onWidgetObjectUpdated();
391 /// Show dock widget panel
392 void showPanel(QDockWidget* theDockWidget);
394 /// Hide dock widget panel
395 void hidePanel(QDockWidget* theDockWidget);
397 /// Show object Browser
398 void showObjectBrowser();
400 /// Hide object Browser
401 void hideObjectBrowser();
404 void closeDocument();
406 /// Open document from file
409 /// Create a new document
412 /// Import part structure from a file
415 /// Import shape from a file
416 void onImportShape();
418 /// Import image from a file
419 void onImportImage();
421 /// Export features to a file
424 /// Export a shape to a file
425 void onExportShape();
431 /// Open preferences dialog box
432 void onPreferences();
435 /// A slot calleon toggle of auto-compute button
438 /// Activates/deactivates the trihedron in the viewer AIS context
439 void onTrihedronVisibilityChanged(bool theState);
441 /// Apply the current transparency value if preview in transparency dialog is switched on
442 void onTransparencyValueChanged();
445 /// Sets the granted operations for the parameter operation. Firstly, it finds the nested features
446 /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
447 /// \param theOperation an operation
448 void setGrantedFeatures(ModuleBase_Operation* theOperation);
451 /// Display results from document
452 /// \param theDoc a document
453 void displayDocumentResults(DocumentPtr theDoc);
455 /// Display results from a group
456 void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
458 /// Insert folder object before currently selected feature
459 void insertFeatureFolder();
461 /// Insert an object to a folder above or below
462 void insertToFolder(bool isBefore);
464 /// Insert an object to a folder above or below
465 void moveOutFolder(bool isBefore);
468 /// SLOT, that is called after the operation is resumed. Update workshop state according to
469 /// the started operation, e.g. visualizes the property panel and connect to it.
470 /// \param theOpertion a resumed operation
471 virtual void onOperationResumed(ModuleBase_Operation* theOperation);
473 /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
474 /// hides the property panel and update the command status.
475 /// \param theOpertion a stopped operation
476 virtual void onOperationStopped(ModuleBase_Operation* theOperation);
478 /// SLOT, that is called after the operation is committed.
479 /// \param theOpertion a committed operation
480 virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
482 /// SLOT, that is called after the operation is aborted.
483 /// \param theOpertion an aborted operation
484 void onOperationAborted(ModuleBase_Operation* theOperation);
486 /// Slot, which reacts to the context popup menu call
487 /// \param theId the data value of the clicked action
488 /// \param isChecked a state of toggle if the action is checkable
489 void onContextMenuCommand(const QString& theId, bool isChecked);
491 /// Set waiting cursor
492 void onStartWaiting();
494 /// Called by Ok button clicked in the property panel. Asks the error manager whether
495 /// the operation can be committed and do it if it returns true.
496 void onAcceptActionClicked();
498 /// Called by OkPlus button clicked in the property panel. Asks the error manager whether
499 /// the operation can be committed and do it if it returns true.
500 void onAcceptPlusActionClicked();
502 /// Called by Preview button clicked in the property panel. Sends signal to model to
504 void onPreviewActionClicked();
506 /// Called on help button clicked in the property panel.
507 void onHelpActionClicked() const;
509 //! The slot is called only once on resizing of Object Browser
510 void onDockSizeChanged();
516 /// Register validators
517 void registerValidators() const;
519 /// Load module from external library
520 /// \param theModule name of the module
521 ModuleBase_IModule* loadModule(const QString& theModule);
526 /// Create object browser widget
527 /// \param theParent a parent of widget
528 QDockWidget* createObjectBrowser(QWidget* theParent);
530 // Creates Dock widgets: Object browser and Property panel
531 void createDockWidgets();
533 /// Extends undo/redo toolbutton's with history menu
534 /// \param theObject - in the CADBuilder it is a QToolButton by itself,
535 /// in salome mode - QAction that creates a button.
536 /// \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
537 /// \param theSlot - onUndo(int) or onRedo(int) SLOT
538 void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
540 /// Creates list of actions (commands) by given history list from session
541 QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
543 /// Pefrom Undo/Redo and necessary workshop updates(viewer, browser, actions state)
544 /// \param theActionType a type of the action (Undo or Redo)
545 /// \param theTimes number of applies the given action
546 void processUndoRedo(const ModuleBase_ActionType theActionType, int theTimes);
548 /// Clear content of temporary directory
549 void clearTemporaryDir();
551 /// Set current point of view normal to selected planar face
552 /// \param toInvert invert the normal vector
553 void setNormalView(bool toInvert = false);
557 AppElements_MainWindow* myMainWindow; ///< desktop window
560 ModuleBase_IModule* myModule; ///< current module
561 XGUI_ErrorMgr* myErrorMgr; ///< updator of error message
562 XGUI_ObjectsBrowser* myObjectBrowser; ///< data tree widget
563 XGUI_PropertyPanel* myPropertyPanel; ///< container of feature attributes widgets
564 XGUI_FacesPanel* myFacesPanel; ///< panel for hide object faces
565 XGUI_SelectionMgr* mySelector; ///< handler of selection processing
566 XGUI_SelectionActivate* mySelectionActivate; /// manager of selection activating
567 XGUI_Displayer* myDisplayer; ///< handler of objects display
568 XGUI_OperationMgr* myOperationMgr; ///< manager to manipulate through the operations
569 XGUI_ActionsMgr* myActionsMgr; ///< manager of workshop actions
570 XGUI_ActiveControlMgr* myActiveControlMgr; ///< manager to have none or one active control
571 XGUI_MenuMgr* myMenuMgr; ///< manager to build menu/tool bar using order defined in XML
572 XGUI_SalomeConnector* mySalomeConnector; ///< connector to SALOME module interface
573 XGUI_ErrorDialog* myErrorDlg; ///< dialog to show information of occured error events
574 XGUI_ViewerProxy* myViewerProxy; ///< connector to SALOME viewer interface
575 XGUI_ContextMenuMgr* myContextMenuMgr; ///< manager of context menu build
576 XGUI_ModuleConnector* myModuleConnector; ///< implementation of ModuleBase_IWorkshop
577 XGUI_WorkshopListener* myEventsListener; ///< processing of events
578 QString myCurrentFile; ///< cached the last open directory
579 QIntList myViewerSelMode; ///< selection modes set in the viewer
580 Config_DataModelReader* myDataModelXMLReader; ///< XML reader of data model
581 XGUI_InspectionPanel* myInspectionPanel; ///< container of feature attributes widgets
582 QTemporaryDir myTmpDir; ///< a direcory for uncompressed files