src/ModuleBase/ModuleBase_Operation.h

   1 /*
   2  * ModuleBase_Operation.h
   3  *
   4  *  Created on: Apr 2, 2014
   5  *      Author: sbh
   6  */
   7
   8 #ifndef ModuleBase_Operation_H
   9 #define ModuleBase_Operation_H
  10
  11 #include <ModuleBase.h>
  12 #include <ModuleBase_ViewerPrs.h>
  13
  14 #include <ModelAPI_CompositeFeature.h>
  15 #include <ModelAPI_Document.h>
  16
  17 #include <QObject>
  18 #include <QString>
  19 #include <QStringList>
  20 #include <List>
  21
  22 class ModuleBase_ModelWidget;
  23 class ModuleBase_OperationDescription;
  24 class ModuleBase_IPropertyPanel;
  25 class ModuleBase_ISelection;
  26
  27 class QKeyEvent;
  28
  29 /*!
  30  \class ModuleBase_Operation
  31  * \brief Base class for all operations
  32  *
  33  *  Base class for all operations. If you perform an action it is reasonable to create
  34  *  operation intended for this. This is a base class for all operations which provides
  35  *  mechanism for correct starting operations, starting operations above already started
  36  *  ones, committing operations and so on. To create own operation it is reasonable to
  37  *  inherit it from this class and redefines virtual methods to provide own behavior
  38  *  Main virtual methods are
  39  *  - virtual bool      isReadyToStart();
  40  *  - virtual void      startOperation();
  41  *  - virtual void      abortOperation();
  42  *  - virtual void      commitOperation();
  43  */
  44
  45 class MODULEBASE_EXPORT ModuleBase_Operation : public QObject
  46 {
  47 Q_OBJECT
  48
  49  public:
  50   /// Constructor
  51   /// \param theId the operation identifier
  52   /// \param theParent the QObject parent
  53   ModuleBase_Operation(const QString& theId = "", QObject* theParent = 0);
  54   /// Destructor
  55   virtual ~ModuleBase_Operation();
  56
  57   /// Returns the operation description
  58   /// /returns the instance of the description class
  59   ModuleBase_OperationDescription* getDescription() const { return myDescription; }
  60
  61   /**
  62   * Must return true if this operation can be launched as nested for any current operation
  63   * and it is not necessary to check this operation on validity. By default
  64   * the operation is not granted.
  65   * The method has to be redefined for granted operations.
  66   */
  67   virtual bool isGranted(ModuleBase_Operation* theOperation) const  { return false; }
  68
  69   /// Sets a list of model widgets, according to the operation feature xml definition
  70   /// \param theXmlRepresentation an xml feature definition
  71   /// \param theWidgets a list of widgets
  72   //void setModelWidgets(const std::string& theXmlRepresentation,
  73   //                     QList<ModuleBase_ModelWidget*> theWidgets);
  74
  75   /// Returns True if data of its feature was modified during operation
  76   virtual bool isModified() const { return myIsModified; }
  77
  78   /// Returns True id the current operation is launched in editing mode
  79   bool isEditOperation() const { return myIsEditing; }
  80
  81   /// Returns list of nested features
  82   QStringList nestedFeatures() const { return myNestedFeatures; }
  83
  84   /// Sets list of nested features
  85   void setNestedFeatures(const QStringList& theList) { myNestedFeatures = theList; }
  86
  87
  88   // Returns operations Id from it's description
  89   QString id() const;
  90
  91   /// Returns the operation feature
  92   /// \return the feature
  93   FeaturePtr feature() const;
  94
  95   /**
  96   * Must return True if the operation's feature is valid.
  97   * Since IOperation does not have any feature returns false.
  98   */
  99   virtual bool isValid() const;
 100
 101   /// Returns whether the nested operations are enabled.
 102   /// The state can depend on the operation current state.
 103   /// \return enabled state
 104   virtual bool isNestedOperationsEnabled() const;
 105
 106   /// Sets the operation feature
 107   void setFeature(FeaturePtr theFeature);
 108
 109   /// Returns True if the current operation works with the given object (feature or result)
 110   virtual bool hasObject(ObjectPtr theObj) const;
 111
 112   virtual void keyReleased(const int theKey) {};
 113
 114   /// If operation needs to redisplay its result during operation
 115   /// then this method has to return True
 116   virtual bool hasPreview() const { return false; }
 117
 118   /// Initialisation of operation with preliminary selection
 119   /// \param theSelected the list of selected presentations
 120   /// \param theHighlighted the list of highlighted presentations
 121   virtual void initSelection(ModuleBase_ISelection* theSelection);
 122
 123   virtual void setPropertyPanel(ModuleBase_IPropertyPanel* theProp);
 124
 125   ModuleBase_IPropertyPanel* propertyPanel() const { return myPropertyPanel; }
 126
 127   /// Activates widgets by preselection if it is accepted
 128   virtual bool activateByPreselection();
 129
 130 signals:
 131   void started();  /// the operation is started
 132   void aborted();  /// the operation is aborted
 133   void committed();  /// the operation is committed
 134   void stopped();  /// the operation is aborted or committed
 135   void resumed();  /// the operation is resumed
 136
 137  public slots:
 138   /// Starts operation
 139   /// Public slot. Verifies whether operation can be started and starts operation.
 140   /// This slot is not virtual and cannot be redefined. Redefine startOperation method
 141   /// to change behavior of operation. There is no point in using this method. It would
 142   /// be better to inherit own operator from base one and redefine startOperation method
 143   /// instead.
 144   void start();
 145   /// Resumes operation
 146   /// Public slot. Verifies whether operation can be started and starts operation.
 147   /// This slot is not virtual and cannot be redefined. Redefine startOperation method
 148   /// to change behavior of operation. There is no point in using this method. It would
 149   /// be better to inherit own operator from base one and redefine startOperation method
 150   /// instead.
 151   void resume();
 152   /// Aborts operation
 153   /// Public slot. Aborts operation. This slot is not virtual and cannot be redefined.
 154   /// Redefine abortOperation method to change behavior of operation instead
 155   void abort();
 156   /// Commits operation
 157   /// Public slot. Commits operation. This slot is not virtual and cannot be redefined.
 158   /// Redefine commitOperation method to change behavior of operation instead
 159   bool commit();
 160
 161   /// Alias for start/abort slots
 162   /// Public slot. Aborts operation if false, else does nothing.
 163   /// Provided for S/S compatibility with QAction's toggle(bool)
 164   /// \param theState th flag to abort, if it is true, do nothing, overwise abort
 165   void setRunning(bool theState);
 166
 167   // Data model methods.
 168   /// Stores a custom value in model.
 169   virtual void storeCustomValue();
 170
 171   /// Slots which listen the mode widget activation
 172   /// \param theWidget the model widget
 173   virtual void onWidgetActivated(ModuleBase_ModelWidget* theWidget);
 174
 175  protected:
 176   /// Virtual method called when operation started (see start() method for more description)
 177   /// Default impl calls corresponding slot and commits immediately.
 178   virtual void startOperation();
 179
 180   /// Virtual method called when operation stopped - committed or aborted.
 181   virtual void stopOperation();
 182
 183   /// Virtual method called when operation aborted (see abort() method for more description)
 184   virtual void abortOperation();
 185
 186   /// Virtual method called when operation committed (see commit() method for more description)
 187   virtual void commitOperation();
 188
 189   /// Virtual method called after operation committed (see commit() method for more description)
 190   virtual void afterCommitOperation();
 191
 192   /// Send update message by loop
 193   void flushUpdated();
 194   /// Send created message by loop
 195   void flushCreated();
 196
 197   /// Creates an operation new feature
 198   /// \param theFlushMessage the flag whether the create message should be flushed
 199   /// \param theCompositeFeature the feature that must be used for adding the created object or null
 200   /// \returns the created
 201   virtual FeaturePtr createFeature(const bool theFlushMessage = true,
 202     CompositeFeaturePtr theCompositeFeature = CompositeFeaturePtr());
 203
 204   /// Verifies whether this operator can be commited.
 205   /// \return Returns TRUE if current operation can be committed, e.g. all parameters are filled
 206   virtual bool canBeCommitted() const;
 207
 208   /// Returns pointer to the root document.
 209   boost::shared_ptr<ModelAPI_Document> document() const;
 210
 211   /// Set value to the active widget
 212   /// \param theFeature the feature
 213   /// \param theX the horizontal coordinate
 214   /// \param theY the vertical coordinate
 215   /// \return true if the point is set
 216   virtual bool setWidgetValue(ObjectPtr theFeature, double theX, double theY);
 217
 218  protected:
 219   FeaturePtr myFeature;  /// the operation feature to be handled
 220
 221   /// the container to have the operation description
 222   ModuleBase_OperationDescription* myDescription;
 223
 224   /// Editing feature flag
 225   bool myIsEditing;
 226
 227   /// Modified feature flag
 228   bool myIsModified;
 229
 230   /// List of nested operations IDs
 231   QStringList myNestedFeatures;
 232
 233   /// List of pre-selected object
 234   QList<ModuleBase_ViewerPrs> myPreSelection;
 235
 236   /// Access to property panel
 237   ModuleBase_IPropertyPanel* myPropertyPanel;
 238 };
 239
 240 #endif