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 class AppElements_MainWindow;
  20 class AppElements_Command;
  21 class AppElements_Workbench;
  22
  23 class XGUI_ActionsMgr;
  24 class XGUI_ContextMenuMgr;
  25 class XGUI_Displayer;
  26 class XGUI_ErrorDialog;
  27 class XGUI_ErrorMgr;
  28 class XGUI_ModuleConnector;
  29 class XGUI_ObjectsBrowser;
  30 class XGUI_OperationMgr;
  31 class XGUI_PropertyPanel;
  32 class XGUI_SalomeConnector;
  33 class XGUI_SalomeViewer;
  34 class XGUI_SelectionMgr;
  35 class XGUI_ViewerProxy;
  36 class XGUI_WorkshopListener;
  37
  38 class ModuleBase_IModule;
  39 class ModuleBase_IViewer;
  40 class ModuleBase_Operation;
  41
  42 class QWidget;
  43 class QDockWidget;
  44 class QMainWindow;
  45
  46 class QAction;
  47
  48 /**\class XGUI_Workshop
  49  * \ingroup GUI
  50  * \brief Class which defines a configuration of the application (Workshop) and launches it.
  51  */
  52 class XGUI_EXPORT XGUI_Workshop : public QObject
  53 {
  54 Q_OBJECT
  55  public:
  56   /// Constructor
  57   /// \param theConnector a Salome connector object.
  58   /// Used only if the workshop is launched in Salome environment
  59   XGUI_Workshop(XGUI_SalomeConnector* theConnector = 0);
  60   virtual ~XGUI_Workshop();
  61
  62   //! Starting of the application
  63   void startApplication();
  64
  65   // Activates the module controls. Should be called after module creation
  66   void activateModule();
  67
  68   // Deactivates the module controls. Should be called after module creation
  69   void deactivateModule();
  70
  71   //! Returns main window (Desktop) of the application
  72   AppElements_MainWindow* mainWindow() const
  73   {
  74     return myMainWindow;
  75   }
  76
  77   //! Returns selection manager object
  78   XGUI_SelectionMgr* selector() const
  79   {
  80     return mySelector;
  81   }
  82
  83   //! Returns displayer
  84   XGUI_Displayer* displayer() const
  85   {
  86     return myDisplayer;
  87   }
  88
  89   //! ! Returns operation manager.
  90   XGUI_OperationMgr* operationMgr() const
  91   {
  92     return myOperationMgr;
  93   }
  94
  95   //! ! Returns an actions manager
  96   XGUI_ActionsMgr* actionsMgr() const
  97   {
  98     return myActionsMgr;
  99   }
 100
 101   //! Returns property panel widget
 102   XGUI_PropertyPanel* propertyPanel() const
 103   {
 104     return myPropertyPanel;
 105   }
 106
 107   //! Returns context menu manager object
 108   XGUI_ContextMenuMgr* contextMenuMgr() const
 109   {
 110     return myContextMenuMgr;
 111   }
 112
 113   //! Creates and adds a new workbench (menu group) with the given name and returns it
 114   AppElements_Workbench* addWorkbench(const QString& theName);
 115
 116   //! Returns an object which provides interface to Salome Module (LightApp_Module)
 117   XGUI_SalomeConnector* salomeConnector() const
 118   {
 119     return mySalomeConnector;
 120   }
 121
 122   //! Provides an object which provides interface to Salome Viewer
 123   ModuleBase_IViewer* salomeViewer() const;
 124
 125   //! Returns true if the application works as SALOME module
 126   bool isSalomeMode() const
 127   {
 128     return mySalomeConnector != 0;
 129   }
 130
 131   //! Returns Object browser
 132   XGUI_ObjectsBrowser* objectBrowser() const
 133   {
 134     return myObjectBrowser;
 135   }
 136
 137   /// This method is called by Salome module when selection is changed
 138   void salomeViewerSelectionChanged();
 139
 140   /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
 141   XGUI_ViewerProxy* viewer() const
 142   {
 143     return myViewerProxy;
 144   }
 145
 146   /// Returns the module connectory
 147   /// \returns the instance of connector
 148   XGUI_ModuleConnector* moduleConnector() const
 149   {
 150     return myModuleConnector;
 151   }
 152
 153   /// Returns a desktop
 154   /// \return a desktop instance
 155   QMainWindow* desktop() const;
 156
 157   //! Delete features
 158   void deleteObjects();
 159
 160   //! Returns true if the selected feature can be moved to the position after the current feature
 161   //! \return boolean value
 162   bool canMoveFeature();
 163
 164   //! Move selected features to be after the current feature
 165   void moveObjects();
 166
 167   //! Returns true if the object can be shaded. If the object is a compsolid result, the method
 168   //! checks subobjects of the result
 169   //! \return boolean value
 170   bool canBeShaded(const ObjectPtr& theObject) const;
 171
 172   //! Returns true if there is at least one selected body/construction/group result
 173   //! \return boolean value
 174   bool canChangeColor() const;
 175
 176   //! Change color of the features if it is possible
 177   //! The operation is available for construction, body and group results
 178   //! theObjects a list of selected objects
 179   void changeColor(const QObjectPtrList& theObjects);
 180
 181   //! Show the given features in 3d Viewer
 182   void showObjects(const QObjectPtrList& theList, bool isVisible);
 183
 184   //! Show the given features in 3d Viewer
 185   void showOnlyObjects(const QObjectPtrList& theList);
 186
 187   /// Set display mode for the given onjects
 188   /// \param theList a list of displayed objects
 189   /// \param theMode a mode to set (see \ref XGUI_Displayer)
 190   void setDisplayMode(const QObjectPtrList& theList, int theMode);
 191
 192   /// Returns current module
 193   ModuleBase_IModule* module() const
 194   {
 195     return myModule;
 196   }
 197
 198   /// Returns current directory whic contains data files
 199   QString currentDataDir() const { return myCurrentDir; }
 200
 201   /// Returns current directory whic contains data files
 202   void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
 203
 204   /**
 205   * Save the current document into a directory
 206   * \param theName - path to the directory
 207   * \param theFileNames - returned file names created in this directory
 208   */
 209   void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 210
 211   /**
 212    * If there is an active (uncommited) operation shows a prompt to abort it
 213    * and performs abortion if user agreed. Returns true if
 214    * - operation aborted successfully
 215    * - there is no active operation
 216    */
 217   bool isActiveOperationAborted();
 218
 219   //! Delete features. Delete the referenced features. There can be a question with a list of referenced
 220   //! objects.
 221   //! \param theList an objects to be deleted
 222   //! \param theIgnoredFeatures a list of features to be ignored during delete
 223   //! \param theParent a parent widget for the question message box
 224   //! \param theAskAboutDeleteReferences if true, the message box with a list of references to the
 225   //! objects features appear. If the user chose do not continue, the deletion is not performed
 226   //! \return the success of the delete
 227   bool deleteFeatures(const QObjectPtrList& theList,
 228                       const std::set<FeaturePtr>& theIgnoredFeatures = std::set<FeaturePtr>(),
 229                       QWidget* theParent = 0,
 230                       const bool theAskAboutDeleteReferences = false);
 231
 232   /// Deactivates the object, if it is active and the module returns that the activation
 233   /// of selection for the object is not possible currently(the current operation uses it)
 234   /// \param theObject an object
 235   /// \param theUpdateViewer a boolean flag to update viewer immediately
 236   void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
 237
 238 signals:
 239   /// Emitted when selection happens in Salome viewer
 240   void salomeViewerSelection();
 241
 242   /// Emitted when error in applivation happens
 243   void errorOccurred(const QString&);
 244
 245   //! the signal about the workshop actions states are updated.
 246   void commandStatusUpdated();
 247
 248   //! the application is started
 249   void applicationStarted();
 250
 251   //! Signal to update Undo history list
 252   void updateUndoHistory(const QList<ActionInfo>&);
 253
 254   //! Signal to update Redo history list
 255   void updateRedoHistory(const QList<ActionInfo>&);
 256
 257  public slots:
 258    /// Update of commands status
 259   void updateCommandStatus();
 260
 261   // Update enable state of accept all button. It is enabled if the the parent operation is
 262   // valid and there are modifications in sesstion(undo can be performed).
 263   void updateCompositeActionState();
 264
 265   /// update history list (undo/redo commands)
 266   void updateHistory();
 267
 268   /// Create a new dokument
 269   void onNew();
 270
 271   /// Open document from file
 272   void onOpen();
 273
 274   /// Save current document
 275   bool onSave();
 276
 277   /// Save current document to a file selected by user
 278   bool onSaveAs();
 279
 280   /// Exit application
 281   void onExit();
 282
 283   /// Undo last command
 284   void onUndo(int times = 1);
 285
 286   /// Redo previous command
 287   void onRedo(int times = 1);
 288
 289   /// Rebuild data tree
 290   void onRebuild();
 291
 292   /// Open preferences dialog box
 293   void onPreferences();
 294
 295   /// Show property panel
 296   void showPropertyPanel();
 297
 298   /// Hide property panel
 299   void hidePropertyPanel();
 300
 301   /// Show object Browser
 302   void showObjectBrowser();
 303
 304   /// Hide object Browser
 305   void hideObjectBrowser();
 306
 307   /// Close document
 308   void closeDocument();
 309
 310  protected:
 311   /// Find the nested features and set them into the operation
 312   /// \param theOperation an operation
 313   void setNestedFeatures(ModuleBase_Operation* theOperation);
 314
 315   /// Update the property panel content by the XML description of the operation and set the panel
 316   /// into the operation
 317   /// \param theOperation an operation
 318   void setPropertyPanel(ModuleBase_Operation* theOperation);
 319
 320 private:
 321   /// Display all results
 322   //void displayAllResults();
 323
 324   /// Displau results from document
 325   /// \param theDoc a document
 326   void displayDocumentResults(DocumentPtr theDoc);
 327
 328   /// Display results from a group
 329   void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 330
 331  private slots:
 332   /// SLOT, that is called after the operation is started. Update workshop state according to
 333   /// the started operation, e.g. visualizes the property panel and connect to it.
 334   /// \param theOpertion a started operation
 335   void onOperationStarted(ModuleBase_Operation* theOperation);
 336
 337   /// SLOT, that is called after the operation is resumed. Update workshop state according to
 338   /// the started operation, e.g. visualizes the property panel and connect to it.
 339   /// \param theOpertion a resumed operation
 340   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 341
 342   /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
 343   /// hides the property panel and udpate the command status.
 344   /// \param theOpertion a stopped operation
 345   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 346
 347   /// SLOT, that is called after the operation is committed.
 348   /// \param theOpertion a commmitted operation
 349   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 350
 351   /// SLOT, that is called after the operation is aborted.
 352   /// \param theOpertion an aborted operation
 353   void onOperationAborted(ModuleBase_Operation* theOperation);
 354
 355   /// Slot, which reacts to the context popup menu call
 356   /// \param theId the data value of the clicked action
 357   /// \param isChecked a state of toggle if the action is checkable
 358   void onContextMenuCommand(const QString& theId, bool isChecked);
 359
 360   /// Set waiting cursor
 361   void onStartWaiting();
 362
 363  private:
 364    /// Init menu
 365   void initMenu();
 366
 367   /// Register validators
 368   void registerValidators() const;
 369
 370   /// Load module from external library
 371   /// \param theModule name of the module
 372   ModuleBase_IModule* loadModule(const QString& theModule);
 373
 374   /// Create module
 375   bool createModule();
 376
 377   /// Create object browser widget
 378   /// \param theParent a parent of widget
 379   QDockWidget* createObjectBrowser(QWidget* theParent);
 380
 381   /// Create property panel widget
 382   /// \param theParent a parent of widget
 383   QDockWidget* createPropertyPanel(QWidget* theParent);
 384
 385   // Creates Dock widgets: Object browser and Property panel
 386   void createDockWidgets();
 387
 388   //! Extends undo/redo toolbutton's with history menu
 389   //! \param theObject - in the OpenParts it is a QToolButton by itself,
 390   //! in salome mode - QAction that creates a button.
 391   //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
 392   //! \param theSlot - onUndo(int) or onRedo(int) SLOT
 393   void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
 394
 395   //! Creates list of actions (commands) by given history list from session
 396   QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 397
 398 private:
 399   AppElements_MainWindow* myMainWindow;
 400   ModuleBase_IModule* myModule;
 401   XGUI_ErrorMgr* myErrorMgr;
 402   XGUI_ObjectsBrowser* myObjectBrowser;
 403   XGUI_PropertyPanel* myPropertyPanel;
 404   XGUI_SelectionMgr* mySelector;
 405   XGUI_Displayer* myDisplayer;
 406   XGUI_OperationMgr* myOperationMgr;  ///< manager to manipulate through the operations
 407   XGUI_ActionsMgr* myActionsMgr;
 408   XGUI_SalomeConnector* mySalomeConnector;
 409   XGUI_ErrorDialog* myErrorDlg;
 410   XGUI_ViewerProxy* myViewerProxy;
 411   XGUI_ContextMenuMgr* myContextMenuMgr;
 412   XGUI_ModuleConnector* myModuleConnector;
 413   XGUI_WorkshopListener* myEventsListener;
 414
 415   QString myCurrentDir;
 416 };
 417
 418 #endif