src/ModuleBase/ModuleBase_IWorkshop.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 ModuleBase_IWorkshop_H
  22 #define ModuleBase_IWorkshop_H
  23
  24 #include "ModuleBase.h"
  25 #include "ModuleBase_Definitions.h"
  26 #include <ModuleBase_FilterValidated.h>
  27
  28 #include <ModelAPI_Object.h>
  29 #include <GeomAPI_AISObject.h>
  30 #include <Config_FeatureMessage.h>
  31
  32 #include <QObject>
  33
  34 class ModuleBase_IModule;
  35 class ModuleBase_ISelection;
  36 class ModuleBase_IViewer;
  37 class ModuleBase_IPropertyPanel;
  38 class ModuleBase_IErrorMgr;
  39 class ModuleBase_Operation;
  40 class ModuleBase_ViewerPrs;
  41 class QMainWindow;
  42
  43 /**
  44  * \ingroup GUI
  45  * Class which provides access to Workshop object services
  46  */
  47 class MODULEBASE_EXPORT ModuleBase_IWorkshop : public QObject
  48 {
  49 Q_OBJECT
  50  public:
  51    /// Constructor
  52    /// \param theParent parent object
  53   ModuleBase_IWorkshop(QObject* theParent);
  54
  55   virtual ~ModuleBase_IWorkshop()
  56   {}
  57
  58   /// Return current selection instance
  59   virtual ModuleBase_ISelection* selection() const = 0;
  60
  61   /// Activate sub-shapes selection (opens local context)
  62   /// Types has to be defined according to TopAbs_ShapeEnum
  63   virtual void activateSubShapesSelection(const QIntList& theTypes) = 0;
  64
  65   /// Activate objects in the module selection modes(opens local context)
  66   virtual void activateModuleSelectionModes() = 0;
  67
  68   /// Deactivate sub-shapes selection (closes local context)
  69   virtual void deactivateSubShapesSelection() = 0;
  70
  71   //! Returns instance of loaded module
  72   virtual ModuleBase_IModule* module() const = 0;
  73
  74   //! Returns current viewer
  75   virtual ModuleBase_IViewer* viewer() const = 0;
  76
  77   //! Returns property panel
  78   virtual ModuleBase_IPropertyPanel* propertyPanel() const = 0;
  79
  80   //! Returns error manager
  81   virtual ModuleBase_IErrorMgr* errorMgr() const = 0;
  82
  83   /// A filter to process an attribute validators
  84   /// \return a filter
  85   Handle(ModuleBase_FilterValidated) validatorFilter();
  86
  87   //! Returns currently active operation
  88   virtual ModuleBase_Operation* currentOperation() const = 0;
  89
  90   //! Returns true if the operation with id theId can be started
  91   virtual bool canStartOperation(QString theId, bool& isCommitted) = 0;
  92
  93   //! Performs the operation launch
  94   //! \param theOperation an operation to be launched
  95   virtual void processLaunchOperation(ModuleBase_Operation* theOperation) = 0;
  96
  97   //! Returns started operation by the operation identifier
  98   //! \param theId an operation id
  99   //! \return an operation instance or NULL
 100   virtual ModuleBase_Operation* findStartedOperation(const QString& theId) = 0;
 101
 102   //! Returns true if the operation with id theId can be stopped
 103   //! \param theOperation a stopped operation
 104   //! \return boolean result
 105   virtual bool canStopOperation(ModuleBase_Operation* theOperation) = 0;
 106
 107   //! Commits if possible or aborts the given operation.
 108   //! \param theOperation an aborted operation
 109   /// \param isCommitted boolean value if the operation was committed otherwise it was aborted
 110   virtual void stopOperation(ModuleBase_Operation* theOperation,
 111                              bool& isCommitted) = 0;
 112
 113   //! Returns AIS object by data object
 114   //! \param theObject a data object
 115   virtual AISObjectPtr findPresentation(const ObjectPtr& theObject) const = 0;
 116
 117   //! Returns data object by AIS
 118   //! \param theAIS a presentation
 119   virtual ObjectPtr findPresentedObject(const AISObjectPtr& theAIS) const = 0;
 120
 121   //! Select features clearing previous selection.
 122   //! If the list is empty then selection will be cleared
 123   //! \param theValues a list of presentations
 124   virtual void setSelected(const QList<std::shared_ptr<ModuleBase_ViewerPrs>>& theValues) = 0;
 125
 126   //! Shows the message in the status bar
 127   //! \param theMessage a message
 128   virtual void setStatusBarMessage(const QString& theMessage) = 0;
 129
 130    /// Update of commands status
 131   virtual void updateCommandStatus() = 0;
 132
 133   /// Returns feature info according to given feature ID
 134   /// \param theId a feature Id
 135   virtual std::shared_ptr<Config_FeatureMessage> featureInfo(const QString& theId) const = 0;
 136
 137   /// Returns main window of the application
 138   virtual QMainWindow* desktop() const = 0;
 139
 140
 141 signals:
 142   /// Signal selection changed.
 143   void selectionChanged();
 144
 145   /// Signal which is emited after activation of property panel
 146   void propertyPanelActivated();
 147
 148 protected:
 149   /// A filter to process an attribute validators
 150   Handle(ModuleBase_FilterValidated) myValidatorFilter;
 151 };
 152
 153 #endif