Salome HOME
Issue #2052: Modification of parameters don't work (sketch, extrusion)
[modules/shaper.git] / src / ModelAPI / ModelAPI_Feature.h
index 2508e6a2ea9f726e3d789a208c2d4e5b15c257e6..71bd251d8802d78f6717193f34659fa367ddac7a 100644 (file)
@@ -28,6 +28,9 @@ class ModelAPI_Feature : public ModelAPI_Object
   std::list<std::shared_ptr<ModelAPI_Result> > myResults;
   ///< is feature disabled or not
   bool myIsDisabled;
+  ///< is feature is stable (not editing)
+  bool myIsStable;
+
  public:
   /// Returns the unique kind of a feature (like "Point")
   virtual const std::string& getKind() = 0;
@@ -60,9 +63,9 @@ class ModelAPI_Feature : public ModelAPI_Object
   virtual bool compute(const std::string& theAttributeId) { return false; };
 
   /// Registers error during the execution, causes the ExecutionFailed state
-  virtual void setError(const std::string& theError, bool isSend = true) {
-    data()->setError(theError, isSend);
-  }
+  MODELAPI_EXPORT virtual void setError(const std::string& theError,
+                                        bool isSend = true,
+                                        bool isTranslate = true);
 
   /// Returns error, arose during the execution
   virtual std::string error() const {
@@ -82,7 +85,7 @@ class ModelAPI_Feature : public ModelAPI_Object
                                  const int theIndex);
   /// removes the result from the feature
   MODELAPI_EXPORT void removeResult(const std::shared_ptr<ModelAPI_Result>& theResult);
-  /// removes all results starting from the gived index (zero-based)
+  /// removes all results starting from the given index (zero-based)
   /// \param theSinceIndex - index of the deleted result and all after also will be deleted
   /// \param theFlush - if it is false, REDISPLAY message is not flushed
   MODELAPI_EXPORT void removeResults(const int theSinceIndex, const bool theFlush = true);
@@ -132,6 +135,18 @@ class ModelAPI_Feature : public ModelAPI_Object
   /// Returns the feature by the object (result).
   MODELAPI_EXPORT static std::shared_ptr<ModelAPI_Feature> feature(ObjectPtr theObject);
 
+  /// Set the stable feature flag. If feature is currently editing then it is not stable.
+  /// \returns true if state is really changed
+  MODELAPI_EXPORT virtual bool setStable(const bool theFlag);
+
+  /// Returns the feature is stable or not.
+  MODELAPI_EXPORT virtual bool isStable();
+
+  /// Performs some custom feature specific functionality (normally called by some GUI button)
+  /// \param theActionId an action key
+  /// \return a boolean value about it is performed
+  MODELAPI_EXPORT virtual bool customAction(const std::string& theActionId);
+
  //
  // Helper methods, aliases for data()->method()
  // -----------------------------------------------------------------------------------------------
@@ -160,6 +175,11 @@ class ModelAPI_Feature : public ModelAPI_Object
   {
     return data()->integer(theID);
   }
+  /// Returns the integer array attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeIntArray> intArray(const std::string& theID)
+  {
+    return data()->intArray(theID);
+  }
   /// Returns the reference attribute by the identifier
   inline std::shared_ptr<ModelAPI_AttributeRefAttr> refattr(const std::string& theID)
   {
@@ -190,6 +210,16 @@ class ModelAPI_Feature : public ModelAPI_Object
   {
     return data()->string(theID);
   }
+  /// Returns the string array attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeStringArray> stringArray(const std::string& theID)
+  {
+    return data()->stringArray(theID);
+  }
+  /// Returns the tables attribute by the identifier
+  inline std::shared_ptr<ModelAPI_AttributeTables> tables(const std::string& theID)
+  {
+    return data()->tables(theID);
+  }
   /// Returns the attribute by the identifier
   inline std::shared_ptr<ModelAPI_Attribute> attribute(const std::string& theID)
   {