src/ModuleBase/ModuleBase_OperationFeature.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 /*
   4  * ModuleBase_OperationFeature.h
   5  *
   6  *  Created on: Apr 2, 2014
   7  *      Author: sbh
   8  */
   9
  10 #ifndef ModuleBase_OperationFeature_H
  11 #define ModuleBase_OperationFeature_H
  12
  13 #include <ModuleBase.h>
  14 #include <ModuleBase_Operation.h>
  15 #include <ModuleBase_ViewerPrs.h>
  16
  17 #include <ModelAPI_Object.h>
  18 #include <ModelAPI_CompositeFeature.h>
  19
  20 #include <QObject>
  21 #include <QString>
  22 #include <QStringList>
  23
  24 #include <set>
  25
  26 class ModuleBase_ModelWidget;
  27 class ModuleBase_ISelection;
  28 class ModuleBase_IViewer;
  29 class ModuleBase_IWorkshop;
  30
  31 class QKeyEvent;
  32
  33 /*!
  34  * \class ModuleBase_OperationFeature
  35  * \ingroup GUI
  36  * \brief Base class for all operations
  37  *
  38  *  Base class for all operations. If you perform an action it is reasonable to create
  39  *  operation intended for this. This is a base class for all operations which provides
  40  *  mechanism for correct starting operations, starting operations above already started
  41  *  ones, committing operations and so on. To create own operation it is reasonable to
  42  *  inherit it from this class and redefines virtual methods to provide own behavior
  43  *  Main virtual methods are
  44  *  - virtual bool      isReadyToStart();
  45  *  - virtual void      startOperation();
  46  *  - virtual void      abortOperation();
  47  *  - virtual void      commitOperation();
  48  */
  49
  50 class MODULEBASE_EXPORT ModuleBase_OperationFeature : public ModuleBase_Operation
  51 {
  52 Q_OBJECT
  53
  54  public:
  55
  56   /// Appends to operation's history id, if it is an "edit" operation (myIsEditing == true)
  57   static QString EditSuffix() { return "_E"; }
  58   /// Constructor
  59   /// \param theId the operation identifier
  60   /// \param theParent the QObject parent
  61   ModuleBase_OperationFeature(const QString& theId = "", QObject* theParent = 0);
  62   /// Destructor
  63   virtual ~ModuleBase_OperationFeature();
  64
  65   /// Returns True id the current operation is launched in editing mode
  66   bool isEditOperation() const { return myIsEditing; }
  67
  68   /// Change the operation mode from create to edit.
  69   /// The transaction and the operation name in the model history of transaction are the same.
  70   /// It updates the edit state in the widgets of property panel
  71   /// \param isEditState boolean state whether the operation should become editing or creating
  72   // \param theRestartTransaction if true, the current model transaction is committed and
  73   /// the new one is started
  74   void setEditOperation(const bool& isEditState/*const bool theRestartTransaction*/);
  75
  76   /// Returns the operation feature
  77   /// \return the feature
  78   FeaturePtr feature() const;
  79
  80   /// Must return True if the operation's feature is valid.
  81   /// Since IOperation does not have any feature returns false.
  82   virtual bool isValid() const;
  83
  84   /// Sets the operation feature
  85   void setFeature(FeaturePtr theFeature);
  86
  87   /// Returns True if the current operation works with the given object (feature or result)
  88   virtual bool hasObject(ObjectPtr theObj) const;
  89
  90   /// Returns true if the object is displayed when the operation was started
  91   /// \param theObject a feature or result of the operation feature
  92   /// \return boolean value whether the object display state was changed
  93   virtual bool isDisplayedOnStart(ObjectPtr theObject);
  94
  95   /// Initialisation of operation with preliminary selection
  96   /// \param theSelection an instance of Selection class
  97   /// \param theViewer a viewer to have the viewer the eye position
  98   virtual void initSelection(ModuleBase_ISelection* theSelection,
  99                              ModuleBase_IViewer* theViewer);
 100
 101   /// Fill internal map by preselection
 102   /// \param theValues a list of preselection
 103   void setPreselection(const QList<ModuleBase_ViewerPrs>& theValues);
 104
 105   /// \brief Set property pane to the operation
 106   /// \param theProp a property panel instance
 107   virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
 108
 109   /// \return Currently installed property panel
 110   //ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
 111
 112   /// Activates widgets by preselection if it is accepted.
 113   /// \param theGreeAttributeId a greed attribute id if there is in the current feature
 114   /// \return last filled widget
 115   virtual ModuleBase_ModelWidget* activateByPreselection(const std::string& theGreedAttributeId);
 116
 117   /// If the operation works with feature which is sub-feature of another one
 118   /// then this variable has to be initialised by parent feature
 119   /// before operation feature creating
 120   void setParentFeature(CompositeFeaturePtr theParent);
 121
 122   /// \return Installed parent feature (can be NULL)
 123   CompositeFeaturePtr parentFeature() const;
 124
 125   /// Stores the previous to the operation current feature
 126   /// \param theFeature a feature
 127   void setPreviousCurrentFeature(const FeaturePtr& theFeature);
 128
 129   /// Returns the previous to the operation current feature
 130   /// \return theFeature a feature
 131   FeaturePtr previousCurrentFeature();
 132
 133  public slots:
 134   /// Starts operation
 135   /// Public slot. Verifies whether operation can be started and starts operation.
 136   /// This slot is not virtual and cannot be redefined. Redefine startOperation method
 137   /// to change behavior of operation. There is no point in using this method. It would
 138   /// be better to inherit own operator from base one and redefine startOperation method
 139   /// instead.
 140   /// \return true if the start is successful
 141   virtual bool start();
 142
 143   /// Aborts operation
 144   /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined.
 145   /// Redefine abortOperation method to change behavior of operation instead
 146   void abort();
 147
 148   /// Commits operation
 149   /// Public slot. Commits operation. This slot is not virtual and cannot be redefined.
 150   /// Redefine commitOperation method to change behavior of operation instead
 151   bool commit();
 152
 153  protected:
 154   /// Displays the feature/results if it is hidden. It will be hided in stopOperation
 155   virtual void startOperation();
 156
 157   /// Hide feature/results if they were hided on start
 158   virtual void stopOperation();
 159
 160   /// Creates an operation new feature
 161   /// \param theFlushMessage the flag whether the create message should be flushed
 162   /// \returns the created feature
 163   virtual FeaturePtr createFeature(const bool theFlushMessage = true);
 164
 165   /// Removes the preselection information and clears the map of preselection
 166   void clearPreselection();
 167
 168  protected:
 169    /// The operation feature to be handled
 170   FeaturePtr myFeature;
 171
 172   /// a list of hidden objects, whic are diplayed by operation start
 173   /// and should be hidden by operation stop
 174   std::set<ObjectPtr> myVisualizedObjects;
 175
 176   /// Editing feature flag
 177   bool myIsEditing;
 178
 179   /// List of pre-selected object
 180   QList<ModuleBase_ViewerPrs> myPreSelection;
 181
 182   /// If the operation works with feature which is sub-feature of another one
 183   /// then this variable has to be initialised by parent feature
 184   /// before operation feature creating
 185   CompositeFeaturePtr myParentFeature;
 186
 187   /// Last current feature before editing operation. It is cashed when Edit operation is started
 188   /// in order to restore the document current feature on commit/abort this operation.
 189   FeaturePtr myPreviousCurrentFeature;
 190 };
 191
 192 #endif