src/XGUI/XGUI_Workshop.h

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