src/XGUI/XGUI_Workshop.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D -->
   2
   3 #ifndef XGUI_WORKSHOP_H
   4 #define XGUI_WORKSHOP_H
   5
   6 #include "XGUI.h"
   7 //#include "XGUI_Constants.h"
   8 #include <ModuleBase_Definitions.h>
   9 #include <ModelAPI_Document.h>
  10 #include <ModelAPI_Feature.h>
  11
  12 #include <ModuleBase_ActionInfo.h>
  13
  14 #include <QObject>
  15 #include <QMap>
  16 #include <QKeySequence>
  17 #include <QIcon>
  18
  19 #ifndef HAVE_SALOME
  20 class AppElements_MainWindow;
  21 class AppElements_Command;
  22 class AppElements_Workbench;
  23 #endif
  24
  25 class XGUI_ActionsMgr;
  26 class XGUI_ContextMenuMgr;
  27 class XGUI_Displayer;
  28 class XGUI_ErrorDialog;
  29 class XGUI_ErrorMgr;
  30 class XGUI_MenuMgr;
  31 class XGUI_ModuleConnector;
  32 class XGUI_ObjectsBrowser;
  33 class XGUI_OperationMgr;
  34 class XGUI_PropertyPanel;
  35 class XGUI_SalomeConnector;
  36 class XGUI_SalomeViewer;
  37 class XGUI_SelectionMgr;
  38 class XGUI_ViewerProxy;
  39 class XGUI_WorkshopListener;
  40
  41 class ModuleBase_IModule;
  42 class ModuleBase_IViewer;
  43 class ModuleBase_Operation;
  44
  45 class QWidget;
  46 class QDockWidget;
  47 class QMainWindow;
  48
  49 class QAction;
  50 class Config_DataModelReader;
  51
  52 /**\class XGUI_Workshop
  53  * \ingroup GUI
  54  * \brief Class which defines a configuration of the application (Workshop) and launches it.
  55  */
  56 class XGUI_EXPORT XGUI_Workshop : public QObject
  57 {
  58 Q_OBJECT
  59  public:
  60   /// Constructor
  61   /// \param theConnector a Salome connector object.
  62   /// Used only if the workshop is launched in Salome environment
  63   XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
  64   virtual ~XGUI_Workshop();
  65
  66   //! Starting of the application
  67   void startApplication();
  68
  69   /// Activates the module controls. Should be called after module creation
  70   void activateModule();
  71
  72   /// Deactivates the module controls. Should be called after module creation
  73   void deactivateModule();
  74
  75 #ifndef HAVE_SALOME
  76   //! Returns main window (Desktop) of the application
  77   AppElements_MainWindow* mainWindow() const
  78   {
  79     return myMainWindow;
  80   }
  81
  82   //! Creates and adds a new workbench (menu group) with the given name and returns it
  83   AppElements_Workbench* addWorkbench(const QString& theName);
  84 #endif
  85
  86   //! Returns selection manager object
  87   XGUI_SelectionMgr* selector() const
  88   {
  89     return mySelector;
  90   }
  91
  92   //! Returns displayer
  93   XGUI_Displayer* displayer() const
  94   {
  95     return myDisplayer;
  96   }
  97
  98   //! ! Returns operation manager.
  99   XGUI_OperationMgr* operationMgr() const
 100   {
 101     return myOperationMgr;
 102   }
 103
 104   //! ! Returns error manager.
 105   XGUI_ErrorMgr* errorMgr() const
 106   {
 107     return myErrorMgr;
 108   }
 109
 110   //! ! Returns an actions manager
 111   XGUI_ActionsMgr* actionsMgr() const
 112   {
 113     return myActionsMgr;
 114   }
 115
 116   //! ! Returns an actions manager
 117   XGUI_MenuMgr* menuMgr() const
 118   {
 119     return myMenuMgr;
 120   }
 121
 122   //! Returns property panel widget
 123   XGUI_PropertyPanel* propertyPanel() const
 124   {
 125     return myPropertyPanel;
 126   }
 127
 128   //! Returns context menu manager object
 129   XGUI_ContextMenuMgr* contextMenuMgr() const
 130   {
 131     return myContextMenuMgr;
 132   }
 133
 134   //! Returns an object which provides interface to Salome Module (LightApp_Module)
 135   XGUI_SalomeConnector* salomeConnector() const
 136   {
 137     return mySalomeConnector;
 138   }
 139
 140   //! Provides an object which provides interface to Salome Viewer
 141   ModuleBase_IViewer* salomeViewer() const;
 142
 143   //! Returns true if the application works as SALOME module
 144   bool isSalomeMode() const
 145   {
 146     return mySalomeConnector != 0;
 147   }
 148
 149   //! Returns Object browser
 150   XGUI_ObjectsBrowser* objectBrowser() const
 151   {
 152     return myObjectBrowser;
 153   }
 154
 155   /// This method is called by Salome module when selection is changed
 156   void salomeViewerSelectionChanged();
 157
 158   /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
 159   XGUI_ViewerProxy* viewer() const
 160   {
 161     return myViewerProxy;
 162   }
 163
 164   /// Returns the module connector
 165   /// \returns the instance of connector
 166   XGUI_ModuleConnector* moduleConnector() const
 167   {
 168     return myModuleConnector;
 169   }
 170
 171   /// Returns a desktop
 172   /// \return a desktop instance
 173   QMainWindow* desktop() const;
 174
 175   //! Delete features
 176   void deleteObjects();
 177
 178   //! Searches for selected features unused in other (not selected) features. If one or several
 179   //! selected features are found, a warning message proposes to delete them. It contains
 180   //! the list of features to be deleted.
 181   void cleanHistory();
 182
 183   //! Returns true if the selected feature can be moved to the position after the current feature
 184   //! \return boolean value
 185   bool canMoveFeature();
 186
 187   //! Move selected features to be after the current feature
 188   void moveObjects();
 189
 190   //! Returns true if the object can be shaded. If the object is a compsolid result, the method
 191   //! checks subobjects of the result
 192   //! \return boolean value
 193   bool canBeShaded(const ObjectPtr& theObject) const;
 194
 195   //! Returns true if there is at least one selected body/construction/group result
 196   //! \return boolean value
 197   bool canChangeColor() const;
 198
 199   //! Change color of the features if it is possible
 200   //! The operation is available for construction, body and group results
 201   //! theObjects a list of selected objects
 202   void changeColor(const QObjectPtrList& theObjects);
 203
 204   //! Show the given features in 3d Viewer
 205   void showObjects(const QObjectPtrList& theList, bool isVisible);
 206
 207   //! Show the given features in 3d Viewer
 208   void showOnlyObjects(const QObjectPtrList& theList);
 209
 210   /// Set display mode for the given objects
 211   /// \param theList a list of displayed objects
 212   /// \param theMode a mode to set (see \ref XGUI_Displayer)
 213   void setDisplayMode(const QObjectPtrList& theList, int theMode);
 214
 215   /// Set selection mode in viewer. If theMode=-1 then activate default mode
 216   /// \param theMode the selection mode (according to TopAbs_ShapeEnum)
 217   void setViewerSelectionMode(int theMode);
 218
 219   /// Activates current selection mode for the given list of objects
 220   void activateObjectsSelection(const QObjectPtrList& theList);
 221
 222   /// Returns current module
 223   ModuleBase_IModule* module() const
 224   {
 225     return myModule;
 226   }
 227
 228   /// Returns current directory which contains data files
 229   QString currentDataDir() const { return myCurrentDir; }
 230
 231   /// Returns current directory which contains data files
 232   void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
 233
 234   /**
 235   * Save the current document into a directory
 236   * \param theName - path to the directory
 237   * \param theFileNames - returned file names created in this directory
 238   */
 239   void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 240
 241   /**
 242    * If there is an active (uncommitted) operation shows a prompt to abort it
 243    * and performs abortion if user agreed. Returns true if
 244    * - operation aborted successfully
 245    * - there is no active operation
 246    */
 247   bool abortAllOperations();
 248
 249   //! Delete features. Delete the referenced features. There can be a question with a list of
 250   //! referenced objects.
 251   //! \param theList an objects to be deleted
 252   //! \param theIgnoredFeatures a list of features to be ignored during delete
 253   bool deleteFeatures(const QObjectPtrList& theFeatures,
 254                       const std::set<FeaturePtr>& theIgnoredFeatures = std::set<FeaturePtr>());
 255
 256   /// Deactivates the object, if it is active and the module returns that the activation
 257   /// of selection for the object is not possible currently(the current operation uses it)
 258   /// \param theObject an object
 259   /// \param theUpdateViewer a boolean flag to update viewer immediately
 260   void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
 261
 262   /// Returns true if the action of the feature is created to contain Accept/Cancel button
 263   /// \param theFeature a feature
 264   bool isFeatureOfNested(const FeaturePtr& theFeature);
 265
 266   /// Has to be called in order to display objects with visibility status = true
 267   void synchronizeViewer();
 268
 269   /// Has to be called in order to display objects from a cpecifed group with visibility status = true
 270   /// \param theDoc the document for objects synchronisation
 271   /// \param theGroup the group name
 272   /// \param theUpdateViewer update viewer flag
 273   void synchronizeGroupInViewer(const DocumentPtr& theDoc, const std::string& theGroup, bool theUpdateViewer);
 274
 275   /// Update the property panel content by the XML description of the operation and set the panel
 276   /// into the operation
 277   /// \param theOperation an operation
 278   void setPropertyPanel(ModuleBase_Operation* theOperation);
 279
 280   /// Connects or disconnects to the value changed signal of the property panel widgets
 281   /// \param isToConnect a boolean value whether connect or disconnect
 282   void connectToPropertyPanel(const bool isToConnect);
 283
 284   /// Returns defailt selection mode in 3d viewer
 285   int viewerSelectionMode() const { return myViewerSelMode; }
 286
 287   /// Highlights result objects in Object Browser according to
 288   /// features found in the given list
 289   void highlightResults(const QObjectPtrList& theObjects);
 290
 291   /// Returns Data Model XML reader which contains information about
 292   /// Data structure configuration
 293   const Config_DataModelReader* dataModelXMLReader() const { return myDataModelXMLReader; }
 294
 295   /// A constant string used for "Move to end" command definition
 296   /// It is used for specific processing of Undo/Redo for this command.
 297   static QString MOVE_TO_END_COMMAND;
 298
 299 signals:
 300   /// Emitted when selection happens in Salome viewer
 301   void salomeViewerSelection();
 302
 303   /// Emitted when error in application happens
 304   void errorOccurred(const QString&);
 305
 306   //! the signal about the workshop actions states are updated.
 307   void commandStatusUpdated();
 308
 309   //! the application is started
 310   void applicationStarted();
 311
 312   //! Signal to update Undo history list
 313   void updateUndoHistory(const QList<ActionInfo>&);
 314
 315   //! Signal to update Redo history list
 316   void updateRedoHistory(const QList<ActionInfo>&);
 317
 318  public slots:
 319    /// Update of commands status
 320   void updateCommandStatus();
 321
 322   /// update history list (undo/redo commands)
 323   void updateHistory();
 324
 325   /// Save current document
 326   bool onSave();
 327
 328   /// Save current document to a file selected by user
 329   bool onSaveAs();
 330
 331   /// Undo last command
 332   void onUndo(int times = 1);
 333
 334   /// Redo previous command
 335   void onRedo(int times = 1);
 336
 337   // Rebuild data tree
 338   //void onRebuild();
 339
 340   /// Validates the operation to change the "Apply" button state.
 341   /// \param thePreviousState the previous state of the widget
 342   void onWidgetStateChanged(int thePreviousState);
 343
 344   /// Calls activate of the current widget again. It is possible that selection filters are
 345   /// differs in the new state of paged container
 346   void onValuesChanged();
 347
 348   /// Listens the corresponded signal of model widget and updates Apply button state by feature
 349   void onWidgetObjectUpdated();
 350
 351   /// Show property panel
 352   void showPropertyPanel();
 353
 354   /// Hide property panel
 355   void hidePropertyPanel();
 356
 357   /// Show object Browser
 358   void showObjectBrowser();
 359
 360   /// Hide object Browser
 361   void hideObjectBrowser();
 362
 363   /// Close document
 364   void closeDocument();
 365
 366   /// Open document from file
 367   void onOpen();
 368
 369   /// Create a new document
 370   void onNew();
 371
 372 #ifndef HAVE_SALOME
 373   /// Exit application
 374   void onExit();
 375
 376   /// Open preferences dialog box
 377   void onPreferences();
 378 #endif
 379
 380   /// Activates/deactivates the trihedron in the viewer AIS context
 381   void onTrihedronVisibilityChanged(bool theState);
 382
 383
 384  protected:
 385   /// Sets the granted operations for the parameter operation. Firstly, it finds the nested features
 386   /// and set them into the operation. Secondly, it asks the module about ids of granted operations.
 387   /// \param theOperation an operation
 388    void setGrantedFeatures(ModuleBase_Operation* theOperation);
 389
 390   //! \param theIgnoredFeatures a list of features to be ignored during delete
 391   //! \param theList an objects to be checked
 392   //! \param aDirectRefFeatures a list of direct reference features
 393   //! \param aIndirectRefFeatures a list of features which depend on the feature through others
 394   //! \param doDeleteReferences flag if referenced features should be removed also
 395   bool deleteFeaturesInternal(const QObjectPtrList& theList,
 396                               const std::set<FeaturePtr>& aDirectRefFeatures,
 397                               const std::set<FeaturePtr>& aIndirectRefFeatures,
 398                               const std::set<FeaturePtr>& theIgnoredFeatures,
 399                               const bool doDeleteReferences = true);
 400
 401 private:
 402   /// Display all results
 403   //void displayAllResults();
 404
 405   /// Display results from document
 406   /// \param theDoc a document
 407   void displayDocumentResults(DocumentPtr theDoc);
 408
 409   /// Display results from a group
 410   void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 411
 412  private slots:
 413   /// SLOT, that is called after the operation is started. Update workshop state according to
 414   /// the started operation, e.g. visualizes the property panel and connect to it.
 415   /// \param theOpertion a started operation
 416   void onOperationStarted(ModuleBase_Operation* theOperation);
 417
 418   /// SLOT, that is called after the operation is resumed. Update workshop state according to
 419   /// the started operation, e.g. visualizes the property panel and connect to it.
 420   /// \param theOpertion a resumed operation
 421   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 422
 423   /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
 424   /// hides the property panel and update the command status.
 425   /// \param theOpertion a stopped operation
 426   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 427
 428   /// SLOT, that is called after the operation is committed.
 429   /// \param theOpertion a committed operation
 430   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 431
 432   /// SLOT, that is called after the operation is aborted.
 433   /// \param theOpertion an aborted operation
 434   void onOperationAborted(ModuleBase_Operation* theOperation);
 435
 436   /// Slot, which reacts to the context popup menu call
 437   /// \param theId the data value of the clicked action
 438   /// \param isChecked a state of toggle if the action is checkable
 439   void onContextMenuCommand(const QString& theId, bool isChecked);
 440
 441   /// Set waiting cursor
 442   void onStartWaiting();
 443
 444   /// Called by Ok button clicked in the property panel. Asks the error manager whether
 445   /// the operation can be committed and do it if it returns true.
 446   void onAcceptActionClicked();
 447
 448   /// Called by Preview button clicked in the property panel. Sends signal to model to
 449   /// compute preview.
 450   void onPreviewActionClicked();
 451
 452  private:
 453    /// Init menu
 454   void initMenu();
 455
 456   /// Register validators
 457   void registerValidators() const;
 458
 459   /// Load module from external library
 460   /// \param theModule name of the module
 461   ModuleBase_IModule* loadModule(const QString& theModule);
 462
 463   /// Create module
 464   bool createModule();
 465
 466   /// Create object browser widget
 467   /// \param theParent a parent of widget
 468   QDockWidget* createObjectBrowser(QWidget* theParent);
 469
 470   /// Create property panel widget
 471   /// \param theParent a parent of widget
 472   QDockWidget* createPropertyPanel(QWidget* theParent);
 473
 474   // Creates Dock widgets: Object browser and Property panel
 475   void createDockWidgets();
 476
 477   //! Extends undo/redo toolbutton's with history menu
 478   //! \param theObject - in the OpenParts it is a QToolButton by itself,
 479   //! in salome mode - QAction that creates a button.
 480   //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
 481   //! \param theSlot - onUndo(int) or onRedo(int) SLOT
 482   void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
 483
 484
 485   /// Calls removeFeature of the document for each object in the list
 486   //! \param theList an objects to be deleted
 487   //! \param theIgnoredFeatures a list of features to be ignored during delete
 488   //! \param theActionId an action command key to find context menu object types enabled for remove
 489   //! \param theFlushRedisplay a boolean value if the redisplay signal should be flushed
 490   bool removeFeatures(const QObjectPtrList& theList,
 491                       const std::set<FeaturePtr>& theIgnoredFeatures,
 492                       const QString& theActionId,
 493                       const bool theFlushRedisplay);
 494
 495   //! Creates list of actions (commands) by given history list from session
 496   QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 497
 498 private:
 499 #ifndef HAVE_SALOME
 500   AppElements_MainWindow* myMainWindow;
 501 #endif
 502
 503   ModuleBase_IModule* myModule;
 504   XGUI_ErrorMgr* myErrorMgr;
 505   XGUI_ObjectsBrowser* myObjectBrowser;
 506   XGUI_PropertyPanel* myPropertyPanel;
 507   XGUI_SelectionMgr* mySelector;
 508   XGUI_Displayer* myDisplayer;
 509   XGUI_OperationMgr* myOperationMgr;  ///< manager to manipulate through the operations
 510   XGUI_ActionsMgr* myActionsMgr;
 511   XGUI_MenuMgr* myMenuMgr; ///< manager to build menu/tool bar using order defined in XML
 512   XGUI_SalomeConnector* mySalomeConnector;
 513   XGUI_ErrorDialog* myErrorDlg;
 514   XGUI_ViewerProxy* myViewerProxy;
 515   XGUI_ContextMenuMgr* myContextMenuMgr;
 516   XGUI_ModuleConnector* myModuleConnector;
 517   XGUI_WorkshopListener* myEventsListener;
 518
 519   QString myCurrentDir;
 520
 521   int myViewerSelMode;
 522
 523   Config_DataModelReader* myDataModelXMLReader;
 524 };
 525
 526 #endif