src/XGUI/XGUI_Workshop.h

   1 // Copyright (C) 2014-2023  CEA/DEN, EDF R&D
   2 //
   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.
   7 //
   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.
  12 //
  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
  16 //
  17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
  18 //
  19
  20 #ifndef XGUI_WORKSHOP_H
  21 #define XGUI_WORKSHOP_H
  22
  23 #include "XGUI.h"
  24
  25 #include <ModelAPI_Document.h>
  26 #include <ModelAPI_Feature.h>
  27 #include <ModelAPI_ResultBody.h>
  28
  29 #include <ModuleBase_ActionInfo.h>
  30 #include <ModuleBase_ActionType.h>
  31 #include <ModuleBase_Definitions.h>
  32
  33 #include <SelectMgr_ListOfFilter.hxx>
  34
  35 #include <QIcon>
  36 #include <QObject>
  37 #include <QKeySequence>
  38 #include <QMap>
  39 #include <QTemporaryDir>
  40
  41 #ifndef HAVE_SALOME
  42 class AppElements_Command;
  43 class AppElements_MainWindow;
  44 class AppElements_Workbench;
  45 #endif
  46
  47 class Config_DataModelReader;
  48
  49 class XGUI_ActionsMgr;
  50 class XGUI_ActiveControlMgr;
  51 class XGUI_ContextMenuMgr;
  52 class XGUI_Displayer;
  53 class XGUI_ErrorDialog;
  54 class XGUI_ErrorMgr;
  55 class XGUI_FacesPanel;
  56 class XGUI_MenuMgr;
  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;
  68
  69 class ModuleBase_IModule;
  70 class ModuleBase_IViewer;
  71 class ModuleBase_Operation;
  72
  73 class QAction;
  74 class QDockWidget;
  75 class QMainWindow;
  76 class QWidget;
  77
  78 /// \class XGUI_Workshop
  79 /// \ingroup GUI
  80 /// \brief Class which defines a configuration of the application (Workshop) and launches it.
  81 class XGUI_EXPORT XGUI_Workshop : public QObject
  82 {
  83 Q_OBJECT
  84  public:
  85   /// Constructor
  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();
  90
  91   /// Starting of the application
  92   void startApplication();
  93
  94   /// Activates the module controls. Should be called after module creation
  95   void activateModule();
  96
  97   /// Deactivates the module controls. Should be called after module creation
  98   void deactivateModule();
  99
 100 #ifndef HAVE_SALOME
 101   /// Returns main window (Desktop) of the application
 102   AppElements_MainWindow* mainWindow() const { return myMainWindow; }
 103
 104   /// Creates and adds a new workbench (menu group) with the given name and returns it
 105   AppElements_Workbench* addWorkbench(const QString& theName);
 106 #endif
 107
 108   /// Returns selection manager object
 109   XGUI_SelectionMgr* selector() const { return mySelector; }
 110
 111   /// Returns selection activating object
 112   XGUI_SelectionActivate* selectionActivate() const { return mySelectionActivate; }
 113
 114   /// Returns displayer
 115   XGUI_Displayer* displayer() const { return myDisplayer; }
 116
 117   /// Returns operation manager.
 118   XGUI_OperationMgr* operationMgr() const { return myOperationMgr; }
 119
 120   /// Returns error manager.
 121   XGUI_ErrorMgr* errorMgr() const { return myErrorMgr; }
 122
 123   /// Returns an actions manager
 124   XGUI_ActionsMgr* actionsMgr() const { return myActionsMgr; }
 125
 126   /// Returns an active control manager
 127   XGUI_ActiveControlMgr* activeControlMgr() const { return myActiveControlMgr; }
 128
 129   /// Returns an actions manager
 130   XGUI_MenuMgr* menuMgr() const { return myMenuMgr; }
 131
 132   /// Returns property panel widget
 133   XGUI_PropertyPanel* propertyPanel() const { return myPropertyPanel; }
 134
 135   /// Returns property panel widget
 136   XGUI_InspectionPanel* inspectionPanel() const { return myInspectionPanel; }
 137
 138   /// Returns panel for hide object faces
 139   XGUI_FacesPanel* facesPanel() const { return myFacesPanel; }
 140
 141   /// Returns context menu manager object
 142   XGUI_ContextMenuMgr* contextMenuMgr() const { return myContextMenuMgr; }
 143
 144   /// Returns an object which provides interface to Salome Module (LightApp_Module)
 145   XGUI_SalomeConnector* salomeConnector() const { return mySalomeConnector; }
 146
 147   /// Provides an object which provides interface to Salome Viewer
 148   ModuleBase_IViewer* salomeViewer() const;
 149
 150   /// Returns true if the application works as SALOME module
 151   bool isSalomeMode() const { return mySalomeConnector != 0; }
 152
 153   /// Returns Object browser
 154   XGUI_ObjectsBrowser* objectBrowser() const { return myObjectBrowser; }
 155
 156   /// This method is called by Salome module when selection is changed
 157   void salomeViewerSelectionChanged();
 158
 159   /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
 160   XGUI_ViewerProxy* viewer() const { return myViewerProxy; }
 161
 162   /// Returns the module connector
 163   /// \returns the instance of connector
 164   XGUI_ModuleConnector* moduleConnector() const { return myModuleConnector; }
 165
 166   /// Returns a desktop
 167   /// \return a desktop instance
 168   QMainWindow* desktop() const;
 169
 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;
 175
 176   /// Delete features
 177   void deleteObjects();
 178
 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.
 182   void cleanHistory();
 183
 184   /// Returns true if the selected feature can be moved to the position after the current feature
 185   /// \return boolean value
 186   bool canMoveFeature();
 187
 188   /// Move selected features to be after the current feature
 189   void moveObjects(const bool theSplit);
 190
 191   /// Start a "Recover" feature on the selected one
 192   void recoverFeature();
 193
 194   /// Returns true if the object can be shaded. If the object is a compsolid result, the method
 195   /// checks subobjects of the result
 196   /// \return boolean value
 197   bool canBeShaded(const ObjectPtr& theObject) const;
 198
 199   /// Returns true if there is at least one selected body/construction/group result
 200   /// \param theActionName text of the checked action
 201   /// \return boolean value
 202   bool canChangeProperty(const QString& theActionName) const;
 203
 204   /// Change color of the results if it is possible
 205   /// The operation is available for construction, body and group results
 206   /// theObjects a list of selected objects
 207   void changeColor(const QObjectPtrList& theObjects);
 208
 209   /// Change Autocolor of the results if it is possible
 210   /// The operation is available for group results
 211   /// theObjects a list of selected objects
 212   void changeAutoColor(const QObjectPtrList& theObjects);
 213
 214   /// Change deflection of the results if it is possible
 215   /// The operation is available for construction, body and group results
 216   /// theObjects a list of selected objects
 217   void changeDeflection(const QObjectPtrList& theObjects);
 218
 219   /// Change transparency of the results if it is possible
 220   /// The operation is available for construction, body and group results
 221   /// theObjects a list of selected objects
 222   void changeTransparency(const QObjectPtrList& theObjects);
 223
 224   /// Change number of iso-lines for the given objects
 225   /// theObjects a list of selected objects
 226   void changeIsoLines(const QObjectPtrList& theObjects);
 227
 228   /// Show the given features in 3d Viewer
 229   void showObjects(const QObjectPtrList& theList, bool isVisible);
 230
 231   /// Show the given features in 3d Viewer
 232   void showOnlyObjects(const QObjectPtrList& theList);
 233
 234   /// Set display mode for the given objects
 235   /// \param theList a list of displayed objects
 236   /// \param theMode a mode to set (see \ref XGUI_Displayer)
 237   void setDisplayMode(const QObjectPtrList& theList, int theMode);
 238
 239   /// Toggle visualisation of edges direction
 240   void toggleEdgesDirection(const QObjectPtrList& theList);
 241
 242   /// Toggle state of display priority (normal/in front)
 243   void toggleBringToFront(const QObjectPtrList& theList);
 244
 245   /// Set selection mode in viewer. If theMode=-1 then activate default mode
 246   /// \param theMode the selection mode (according to TopAbs_ShapeEnum)
 247   void setViewerSelectionMode(int theMode);
 248
 249   /// Activates current selection mode for the given list of objects
 250   void activateObjectsSelection(const QObjectPtrList& theList);
 251
 252   /// Returns current module
 253   ModuleBase_IModule* module() const { return myModule; }
 254
 255   /// Returns current file
 256   QString currentDataFile() const { return myCurrentFile; }
 257
 258   /// Returns current file
 259   void setCurrentDataFile(const QString& theDir) { myCurrentFile = theDir; }
 260
 261   /// Save the current document into a directory
 262   /// \param theName - path to the directory
 263   /// \param theFileNames - returned file names created in this directory
 264   void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 265
 266   /// If there is an active (uncommitted) operation shows a prompt to abort it
 267   /// and performs abortion if user agreed. Returns true if
 268   /// - operation aborted successfully
 269   /// - there is no active operation
 270   bool abortAllOperations();
 271
 272   /// Updates workshop state according to the started operation, e.g. visualizes the property panel
 273   /// and connect to it.
 274   /// \param theOpertion a started operation
 275   void operationStarted(ModuleBase_Operation* theOperation);
 276
 277   /// Delete features. Delete the referenced features. There can be a question with a list of
 278   /// referenced objects.
 279   /// \param theFeatures a list of objects to be deleted
 280   bool deleteFeatures(const QObjectPtrList& theFeatures);
 281
 282   /// Deactivates the object, if it is active and the module returns that the activation
 283   /// of selection for the object is not possible currently(the current operation uses it)
 284   /// \param theObject an object
 285   /// \param theUpdateViewer a boolean flag to update viewer immediately
 286   void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
 287
 288   /// Returns true if the action of the feature is created to contain Accept/Cancel button
 289   /// \param theFeature a feature
 290   bool isFeatureOfNested(const FeaturePtr& theFeature);
 291
 292   /// Shows the message in the status bar
 293   /// \param theMessage a message
 294   void setStatusBarMessage(const QString& theMessage);
 295
 296 #ifdef HAVE_SALOME
 297   /// Has to be called in order to display objects with visibility status = true
 298   void synchronizeViewer();
 299
 300   /// Has to be called in order to display objects from a specifed group
 301   /// with visibility status = true
 302   /// \param theDoc the document for objects synchronisation
 303   /// \param theUpdateViewer update viewer flag
 304   void synchronizeGroupInViewer(const DocumentPtr& theDoc,
 305                                 bool theUpdateViewer);
 306
 307   void synchronizeResultTree(const ResultBodyPtr& theRes, bool theUpdateViewer);
 308
 309 #endif
 310   /// Update the property panel content by the XML description of the operation and set the panel
 311   /// into the operation
 312   /// \param theOperation an operation
 313   void fillPropertyPanel(ModuleBase_Operation* theOperation);
 314
 315   /// Connects or disconnects to the value changed signal of the property panel widgets
 316   /// \param isToConnect a boolean value whether connect or disconnect
 317   void connectToPropertyPanel(const bool isToConnect);
 318
 319   /// Returns defailt selection mode in 3d viewer
 320   QIntList viewerSelectionModes() const { return myViewerSelMode; }
 321
 322   /// Highlights result objects in Object Browser according to
 323   /// features found in the given list
 324   void highlightResults(const QObjectPtrList& theObjects);
 325
 326   /// Highlights feature objects in Object Browser according to
 327   /// features found in the given list
 328   void highlightFeature(const QObjectPtrList& theObjects);
 329
 330   /// Returns Data Model XML reader which contains information about
 331   /// Data structure configuration
 332   const Config_DataModelReader* dataModelXMLReader() const { return myDataModelXMLReader; }
 333
 334   /// A constant string used for "Move to end" command definition
 335   /// It is used for specific processing of Undo/Redo for this command.
 336   static QString MOVE_TO_END_COMMAND;
 337   /// A constant string used for "Move to end and split" command definition
 338   /// It is used for specific processing of Undo/Redo for this command.
 339   static QString MOVE_TO_END_SPLIT_COMMAND;
 340
 341   /// Closes all in the current session and load the directory
 342   /// \param theDirectory a path to directory
 343   void openFile(const QString& theDirectory);
 344
 345   void updateAutoComputeState();
 346
 347   void deactivateCurrentSelector();
 348
 349   /// The method updates a Color Scale object in the viewer
 350   void updateColorScaleVisibility();
 351
 352   /// The method updates a Text of Group names in the viewer.
 353   void updateGroupsText();
 354
 355   void showHelpPage(const QString& thePage) const;
 356
 357 signals:
 358   /// Emitted when selection happens in Salome viewer
 359   void salomeViewerSelection();
 360
 361   /// the signal about the workshop actions states are updated.
 362   void commandStatusUpdated();
 363
 364   /// the application is started
 365   void applicationStarted();
 366
 367   /// Signal to update Undo history list
 368   void updateUndoHistory(const QList<ActionInfo>&);
 369
 370   /// Signal to update Redo history list
 371   void updateRedoHistory(const QList<ActionInfo>&);
 372
 373  public slots:
 374    /// Update of commands status
 375   void updateCommandStatus();
 376
 377   /// update history list (undo/redo commands)
 378   void updateHistory();
 379
 380   /// Save current document
 381   bool onSave();
 382
 383   /// Save current document to a file selected by user
 384   bool onSaveAs();
 385
 386   /// Undo last command
 387   void onUndo(int times = 1);
 388
 389   /// Redo previous command
 390   void onRedo(int times = 1);
 391
 392   /// Validates the operation to change the "Apply" button state.
 393   /// \param thePreviousState the previous state of the widget
 394   void onWidgetStateChanged(int thePreviousState);
 395
 396   /// Calls activate of the current widget again. It is possible that selection filters are
 397   /// differs in the new state of paged container
 398   void onValuesChanged();
 399
 400   /// Listens the corresponded signal of model widget and updates Apply button state by feature
 401   void onWidgetObjectUpdated();
 402
 403   /// Show dock widget panel
 404   void showPanel(QDockWidget* theDockWidget);
 405
 406   /// Hide dock widget panel
 407   void hidePanel(QDockWidget* theDockWidget);
 408
 409   /// Show object Browser
 410   void showObjectBrowser();
 411
 412   /// Hide object Browser
 413   void hideObjectBrowser();
 414
 415   /// Close document
 416   void closeDocument();
 417
 418   /// Open document from file
 419   void onOpen();
 420
 421   /// Create a new document
 422   void onNew();
 423
 424   /// Import part structure from a file
 425   void onImportPart();
 426
 427   /// Import shape from a file
 428   void onImportShape();
 429
 430   /// Import  image from a file
 431   void onImportImage();
 432
 433   /// Export features to a file
 434   void onExportPart();
 435
 436   /// Export a shape to a file
 437   void onExportShape();
 438
 439 #ifndef HAVE_SALOME
 440   /// Exit application
 441   void onExit();
 442
 443   /// Open preferences dialog box
 444   void onPreferences();
 445 #endif
 446
 447   /// A slot calleon toggle of auto-compute button
 448   void onAutoApply();
 449
 450   /// Activates/deactivates the trihedron in the viewer AIS context
 451   void onTrihedronVisibilityChanged(bool theState);
 452
 453   /// Apply the current transparency value if preview in transparency dialog is switched on
 454   void onTransparencyValueChanged();
 455
 456  protected:
 457   /// Sets the granted operations for the parameter operation. Firstly, it finds the nested features
 458   /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
 459   /// \param theOperation an operation
 460   void setGrantedFeatures(ModuleBase_Operation* theOperation);
 461
 462 private:
 463   /// Display results from document
 464   /// \param theDoc a document
 465   void displayDocumentResults(DocumentPtr theDoc);
 466
 467   /// Display results from a group
 468   void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 469
 470   /// Insert folder object before currently selected feature
 471   void insertFeatureFolder();
 472
 473   /// Insert an object to a folder above or below
 474   void insertToFolder(bool isBefore);
 475
 476   /// Insert an object to a folder above or below
 477   void moveOutFolder(bool isBefore);
 478
 479  private slots:
 480   /// SLOT, that is called after the operation is resumed. Update workshop state according to
 481   /// the started operation, e.g. visualizes the property panel and connect to it.
 482   /// \param theOpertion a resumed operation
 483   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 484
 485   /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
 486   /// hides the property panel and update the command status.
 487   /// \param theOpertion a stopped operation
 488   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 489
 490   /// SLOT, that is called after the operation is committed.
 491   /// \param theOpertion a committed operation
 492   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 493
 494   /// SLOT, that is called after the operation is aborted.
 495   /// \param theOpertion an aborted operation
 496   void onOperationAborted(ModuleBase_Operation* theOperation);
 497
 498   /// Slot, which reacts to the context popup menu call
 499   /// \param theId the data value of the clicked action
 500   /// \param isChecked a state of toggle if the action is checkable
 501   void onContextMenuCommand(const QString& theId, bool isChecked);
 502
 503   /// Set waiting cursor
 504   void onStartWaiting();
 505
 506   /// Called by Ok button clicked in the property panel. Asks the error manager whether
 507   /// the operation can be committed and do it if it returns true.
 508   void onAcceptActionClicked();
 509
 510   /// Called by OkPlus button clicked in the property panel. Asks the error manager whether
 511   /// the operation can be committed and do it if it returns true.
 512   void onAcceptPlusActionClicked();
 513
 514   /// Called by Preview button clicked in the property panel. Sends signal to model to
 515   /// compute preview.
 516   void onPreviewActionClicked();
 517
 518   /// Called on help button clicked in the property panel.
 519   void onHelpActionClicked() const;
 520
 521   //! The slot is called only once on resizing of Object Browser
 522   void onDockSizeChanged();
 523
 524  private:
 525   /// Init menu
 526   void initMenu();
 527
 528   /// Register validators
 529   void registerValidators() const;
 530
 531   /// Load module from external library
 532   /// \param theModule name of the module
 533   ModuleBase_IModule* loadModule(const QString& theModule);
 534
 535   /// Create module
 536   bool createModule();
 537
 538   /// Create object browser widget
 539   /// \param theParent a parent of widget
 540   QDockWidget* createObjectBrowser(QWidget* theParent);
 541
 542   // Creates Dock widgets: Object browser and Property panel
 543   void createDockWidgets();
 544
 545   /// Extends undo/redo toolbutton's with history menu
 546   /// \param theObject - in the CADBuilder it is a QToolButton by itself,
 547   /// in salome mode - QAction that creates a button.
 548   /// \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
 549   /// \param theSlot - onUndo(int) or onRedo(int) SLOT
 550   void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
 551
 552   /// Creates list of actions (commands) by given history list from session
 553   QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 554
 555   /// Pefrom Undo/Redo and necessary workshop updates(viewer, browser, actions state)
 556   /// \param theActionType a type of the action (Undo or Redo)
 557   /// \param theTimes number of applies the given action
 558   void processUndoRedo(const ModuleBase_ActionType theActionType, int theTimes);
 559
 560   /// Clear content of temporary directory
 561   void clearTemporaryDir();
 562
 563   /// Set current point of view normal to selected planar face
 564   /// \param toInvert invert the normal vector
 565   void setNormalView(bool toInvert = false);
 566
 567 private:
 568 #ifndef HAVE_SALOME
 569   AppElements_MainWindow* myMainWindow; ///< desktop window
 570 #endif
 571
 572   ModuleBase_IModule* myModule; ///< current module
 573   XGUI_ErrorMgr* myErrorMgr; ///< updator of error message
 574   XGUI_ObjectsBrowser* myObjectBrowser; ///< data tree widget
 575   XGUI_PropertyPanel* myPropertyPanel; ///< container of feature attributes widgets
 576   XGUI_FacesPanel* myFacesPanel; ///< panel for hide object faces
 577   XGUI_SelectionMgr* mySelector; ///< handler of selection processing
 578   XGUI_SelectionActivate* mySelectionActivate; /// manager of selection activating
 579   XGUI_Displayer* myDisplayer; ///< handler of objects display
 580   XGUI_OperationMgr* myOperationMgr;  ///< manager to manipulate through the operations
 581   XGUI_ActionsMgr* myActionsMgr; ///< manager of workshop actions
 582   XGUI_ActiveControlMgr* myActiveControlMgr; ///< manager to have none or one active control
 583   XGUI_MenuMgr* myMenuMgr; ///< manager to build menu/tool bar using order defined in XML
 584   XGUI_SalomeConnector* mySalomeConnector; ///< connector to SALOME module interface
 585   XGUI_ErrorDialog* myErrorDlg; ///< dialog to show information of occured error events
 586   XGUI_ViewerProxy* myViewerProxy; ///< connector to SALOME viewer interface
 587   XGUI_ContextMenuMgr* myContextMenuMgr; ///< manager of context menu build
 588   XGUI_ModuleConnector* myModuleConnector; ///< implementation of ModuleBase_IWorkshop
 589   XGUI_WorkshopListener* myEventsListener; ///< processing of events
 590   QString myCurrentFile; ///< cached the last open directory
 591   QIntList myViewerSelMode; ///< selection modes set in the viewer
 592   Config_DataModelReader* myDataModelXMLReader; ///< XML reader of data model
 593   XGUI_InspectionPanel* myInspectionPanel; ///< container of feature attributes widgets
 594   QTemporaryDir myTmpDir; ///< a direcory for uncompressed files
 595 };
 596
 597 #endif