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 <Events_Listener.h>
   9 #include <ModuleBase_Definitions.h>
  10 #include <ModelAPI_Document.h>
  11 #include <ModelAPI_Feature.h>
  12
  13 #include <ModuleBase_ActionInfo.h>
  14
  15 #include <QObject>
  16 #include <QMap>
  17 #include <QKeySequence>
  18 #include <QIcon>
  19
  20 class AppElements_MainWindow;
  21 class AppElements_Command;
  22 class AppElements_Workbench;
  23
  24 class XGUI_SelectionMgr;
  25 class XGUI_Displayer;
  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;
  36
  37 class ModuleBase_Operation;
  38 class ModuleBase_IModule;
  39 class ModuleBase_IViewer;
  40
  41 class Config_FeatureMessage;
  42 class Config_PointerMessage;
  43
  44 class QWidget;
  45 class QDockWidget;
  46 class QMainWindow;
  47
  48 class ModelAPI_ObjectUpdatedMessage;
  49 class ModelAPI_ObjectDeletedMessage;
  50 class ModelAPI_ResultPart;
  51 class QAction;
  52
  53 /**\class XGUI_Workshop
  54  * \ingroup GUI
  55  * \brief Class which defines a configuration of the application (Workshop) and launches it.
  56  */
  57 class XGUI_EXPORT XGUI_Workshop : public QObject, public Events_Listener
  58 {
  59 Q_OBJECT
  60  public:
  61   /// Constructor
  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();
  66
  67   //! Starting of the application
  68   void startApplication();
  69
  70   //! Returns main window (Desktop) of the application
  71   AppElements_MainWindow* mainWindow() const
  72   {
  73     return myMainWindow;
  74   }
  75
  76   //! Returns selection manager object
  77   XGUI_SelectionMgr* selector() const
  78   {
  79     return mySelector;
  80   }
  81
  82   //! Returns displayer
  83   XGUI_Displayer* displayer() const
  84   {
  85     return myDisplayer;
  86   }
  87
  88   //! ! Returns operation manager.
  89   XGUI_OperationMgr* operationMgr() const
  90   {
  91     return myOperationMgr;
  92   }
  93
  94   //! ! Returns an actions manager
  95   XGUI_ActionsMgr* actionsMgr() const
  96   {
  97     return myActionsMgr;
  98   }
  99
 100   //! Returns property panel widget
 101   XGUI_PropertyPanel* propertyPanel() const
 102   {
 103     return myPropertyPanel;
 104   }
 105
 106   //! Returns context menu manager object
 107   XGUI_ContextMenuMgr* contextMenuMgr() const
 108   {
 109     return myContextMenuMgr;
 110   }
 111
 112   //! Creates and adds a new workbench (menu group) with the given name and returns it
 113   AppElements_Workbench* addWorkbench(const QString& theName);
 114
 115   //! Redefinition of Events_Listener method
 116   virtual void processEvent(const std::shared_ptr<Events_Message>& theMessage);
 117
 118   //! Returns an object which provides interface to Salome Module (LightApp_Module)
 119   XGUI_SalomeConnector* salomeConnector() const
 120   {
 121     return mySalomeConnector;
 122   }
 123
 124   //! Provides an object which provides interface to Salome Viewer
 125   ModuleBase_IViewer* salomeViewer() const;
 126
 127   //! Returns true if the application works as SALOME module
 128   bool isSalomeMode() const
 129   {
 130     return mySalomeConnector != 0;
 131   }
 132
 133   //! Returns Object browser
 134   XGUI_ObjectsBrowser* objectBrowser() const
 135   {
 136     return myObjectBrowser;
 137   }
 138
 139   /// This method is called by Salome module when selection is changed
 140   void salomeViewerSelectionChanged();
 141
 142   /// Returns viewer which unifies access as to Salome viewer as to standalone viewer
 143   XGUI_ViewerProxy* viewer() const
 144   {
 145     return myViewerProxy;
 146   }
 147
 148   /// Returns the module connectory
 149   /// \returns the instance of connector
 150   XGUI_ModuleConnector* moduleConnector() const
 151   {
 152     return myModuleConnector;
 153   }
 154
 155   /// Returns a desktop
 156   /// \return a desktop instance
 157   QMainWindow* desktop() const;
 158
 159   //! Delete features
 160   void deleteObjects();
 161
 162   //! Returns true if there is at least one selected body/construction/group result
 163   //! \return boolean value
 164   bool canChangeColor() const;
 165
 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);
 170
 171   //! Show the given features in 3d Viewer
 172   void showObjects(const QObjectPtrList& theList, bool isVisible);
 173
 174   //! Show the given features in 3d Viewer
 175   void showOnlyObjects(const QObjectPtrList& theList);
 176
 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);
 181
 182   /// Returns current module
 183   ModuleBase_IModule* module() const
 184   {
 185     return myModule;
 186   }
 187
 188   /// Returns current directory whic contains data files
 189   QString currentDataDir() const { return myCurrentDir; }
 190
 191   /// Returns current directory whic contains data files
 192   void setCurrentDataDir(const QString& theDir) { myCurrentDir = theDir; }
 193
 194   /**
 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
 198   */
 199   void saveDocument(const QString& theName, std::list<std::string>& theFileNames);
 200
 201   /**
 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
 206    */
 207   bool isActiveOperationAborted();
 208
 209   //! Delete features. Delete the referenced features. There can be a question with a list of referenced
 210   //! objects.
 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);
 221
 222 signals:
 223   /// Emitted when selection happens in Salome viewer
 224   void salomeViewerSelection();
 225
 226   /// Emitted when error in applivation happens
 227   void errorOccurred(const QString&);
 228
 229   //! the signal about the workshop actions states are updated.
 230   void commandStatusUpdated();
 231
 232   //! the application is started
 233   void applicationStarted();
 234
 235   //! Signal to update Undo history list
 236   void updateUndoHistory(const QList<ActionInfo>&);
 237
 238   //! Signal to update Redo history list
 239   void updateRedoHistory(const QList<ActionInfo>&);
 240
 241  public slots:
 242    /// Update of commands status
 243   void updateCommandStatus();
 244
 245   /// update history list (undo/redo commands)
 246   void updateHistory();
 247
 248   /// Create a new dokument
 249   void onNew();
 250
 251   /// Open document from file
 252   void onOpen();
 253
 254   /// Save current document
 255   bool onSave();
 256
 257   /// Save current document to a file selected by user
 258   bool onSaveAs();
 259
 260   /// Exit application
 261   void onExit();
 262
 263   /// Undo last command
 264   void onUndo(int times = 1);
 265
 266   /// Redo previous command
 267   void onRedo(int times = 1);
 268
 269   /// Rebuild data tree
 270   void onRebuild();
 271
 272   /// Open preferences dialog box
 273   void onPreferences();
 274
 275   /// Show property panel
 276   void showPropertyPanel();
 277
 278   /// Hide property panel
 279   void hidePropertyPanel();
 280
 281   /// Show object Browser
 282   void showObjectBrowser();
 283
 284   /// Hide object Browser
 285   void hideObjectBrowser();
 286
 287   /// Reaction on command call
 288   //void onFeatureTriggered();
 289
 290   /// Close document
 291   void closeDocument();
 292
 293  protected:
 294   /// Find the nested features and set them into the operation
 295   /// \param theOperation an operation
 296   void setNestedFeatures(ModuleBase_Operation* theOperation);
 297
 298   /// Update the property panel content by the XML description of the operation and set the panel
 299   /// into the operation
 300   /// \param theOperation an operation
 301   void setPropertyPanel(ModuleBase_Operation* theOperation);
 302
 303   /// Procedure to process postponed events
 304   bool event(QEvent * theEvent);
 305
 306   //Event-loop processing methods:
 307
 308   /// Process event "Add a feature"
 309   void addFeature(const std::shared_ptr<Config_FeatureMessage>&);
 310
 311   /// Connect to operation signals
 312   /// \param theOperation an operation
 313   void connectWithOperation(ModuleBase_Operation* theOperation);
 314
 315   /// Process feature update message
 316   void onFeatureUpdatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
 317
 318   /// Process feature created message
 319   void onFeatureCreatedMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
 320
 321   /// Process feature redisplay message
 322   void onFeatureRedisplayMsg(const std::shared_ptr<ModelAPI_ObjectUpdatedMessage>& );
 323
 324   /// Deactivates the object, if it is active and the module returns that the activation
 325   /// of selection for the object is not possible currently(the current operation uses it)
 326   /// \param theObject an object
 327   /// \param theUpdateViewer a boolean flag to update viewer immediately
 328   void deactivateActiveObject(const ObjectPtr& theObject, const bool theUpdateViewer);
 329
 330   /// Display all results
 331   //void displayAllResults();
 332
 333   /// Displau results from document
 334   /// \param theDoc a document
 335   void displayDocumentResults(DocumentPtr theDoc);
 336
 337   /// Display results from a group
 338   void displayGroupResults(DocumentPtr theDoc, std::string theGroup);
 339
 340  private slots:
 341   /// SLOT, that is called after the operation is started. Update workshop state according to
 342   /// the started operation, e.g. visualizes the property panel and connect to it.
 343   /// \param theOpertion a started operation
 344   void onOperationStarted(ModuleBase_Operation* theOperation);
 345
 346   /// SLOT, that is called after the operation is resumed. Update workshop state according to
 347   /// the started operation, e.g. visualizes the property panel and connect to it.
 348   /// \param theOpertion a resumed operation
 349   virtual void onOperationResumed(ModuleBase_Operation* theOperation);
 350
 351   /// SLOT, that is called after the operation is stopped. Update workshop state, e.g.
 352   /// hides the property panel and udpate the command status.
 353   /// \param theOpertion a stopped operation
 354   virtual void onOperationStopped(ModuleBase_Operation* theOperation);
 355
 356   /// SLOT, that is called after the operation is committed.
 357   /// \param theOpertion a commmitted operation
 358   virtual void onOperationCommitted(ModuleBase_Operation* theOperation);
 359
 360   /// SLOT, that is called after the operation is aborted.
 361   /// \param theOpertion an aborted operation
 362   void onOperationAborted(ModuleBase_Operation* theOperation);
 363
 364   /// Slot, which reacts to the context popup menu call
 365   /// \param theId the data value of the clicked action
 366   /// \param isChecked a state of toggle if the action is checkable
 367   void onContextMenuCommand(const QString& theId, bool isChecked);
 368
 369   /// Set waiting cursor
 370   void onStartWaiting();
 371
 372  private:
 373    /// Init menu
 374   void initMenu();
 375
 376   /// Register validators
 377   void registerValidators() const;
 378
 379   /// Load module from external library
 380   /// \param theModule name of the module
 381   ModuleBase_IModule* loadModule(const QString& theModule);
 382
 383   /// Activate module
 384   bool activateModule();
 385
 386   /// Create object browser widget
 387   /// \param theParent a parent of widget
 388   QDockWidget* createObjectBrowser(QWidget* theParent);
 389
 390   /// Create property panel widget
 391   /// \param theParent a parent of widget
 392   QDockWidget* createPropertyPanel(QWidget* theParent);
 393
 394   // Creates Dock widgets: Object browser and Property panel
 395   void createDockWidgets();
 396
 397   /// Displaus object and fit all viewer if the object is first (update viewer will not be called)
 398   /// Asks the module whether the object can be displayed
 399   /// \param theObj an object
 400   /// \return true if the object is displayed
 401   bool displayObject(ObjectPtr theObj);
 402
 403   //! Extends undo/redo toolbutton's with history menu
 404   //! \param theObject - in the OpenParts it is a QToolButton by itself,
 405   //! in salome mode - QAction that creates a button.
 406   //! \param theSignal - void "updateUndoHistory" or "updateRedoHistory" SIGNAL;
 407   //! \param theSlot - onUndo(int) or onRedo(int) SLOT
 408   void addHistoryMenu(QObject* theObject, const char* theSignal, const char* theSlot);
 409
 410   //! Creates list of actions (commands) by given history list from session
 411   QList<ActionInfo> processHistoryList(const std::list<std::string>&) const;
 412
 413 private:
 414   AppElements_MainWindow* myMainWindow;
 415   ModuleBase_IModule* myModule;
 416   XGUI_ObjectsBrowser* myObjectBrowser;
 417   XGUI_PropertyPanel* myPropertyPanel;
 418   XGUI_SelectionMgr* mySelector;
 419   XGUI_Displayer* myDisplayer;
 420   XGUI_OperationMgr* myOperationMgr;  ///< manager to manipulate through the operations
 421   XGUI_ActionsMgr* myActionsMgr;
 422   XGUI_SalomeConnector* mySalomeConnector;
 423   XGUI_ErrorDialog* myErrorDlg;
 424   XGUI_ViewerProxy* myViewerProxy;
 425   XGUI_ContextMenuMgr* myContextMenuMgr;
 426   XGUI_ModuleConnector* myModuleConnector;
 427
 428   QString myCurrentDir;
 429
 430   bool myUpdatePrefs;
 431
 432   // Flag to check that part document is in process of activating
 433   bool myPartActivating;
 434
 435   /// The flag is true when we loading a document
 436   bool myIsLoadingData;
 437 };
 438
 439 #endif