Allow dumper to set empty user-defined name for features

[modules/shaper.git] / src / ModelAPI / ModelAPI_Result.h

diff --git a/src/ModelAPI/ModelAPI_Result.h b/src/ModelAPI/ModelAPI_Result.h
index 472fe0056924b7b43f3658d172c19469438e9be2..c0958c7c0a025250dd335a04d8f986e7c3d7d563 100644 (file)
--- a/src/ModelAPI/ModelAPI_Result.h
+++ b/src/ModelAPI/ModelAPI_Result.h
@@ -21,33 +21,47 @@ class ModelAPI_Feature;
 class ModelAPI_Result : public ModelAPI_Object
 {
   bool myIsConcealed; ///< the result is concealed from the data tree (referenced by other objects)
+ protected:
+  bool myIsDisabled; ///< the result is disabled: removed for the user, but keeps the general info
  public:
 
-  /// Reference to the color of the result
+  /// Reference to the color of the result.
+  /// The integer array is used. It contains tree values for red green and blue values. The values are in
+  /// [0, 255] range
   inline static const std::string& COLOR_ID()
   {
     static const std::string MY_COLOR_ID("Color");
     return MY_COLOR_ID;
   }
 
-  /// Returns true if the result is concealed from the data tree (referenced by other objects)
-  inline bool isConcealed()
+  /// Reference to the deflection of the result.
+  /// The double value is used. The values is in [0, 1] range
+  inline static const std::string& DEFLECTION_ID()
   {
-    return myIsConcealed;
+    static const std::string MY_DEFLECTION_ID("Deflection");
+    return MY_DEFLECTION_ID;
   }
 
   /// Returns true if the result is concealed from the data tree (referenced by other objects)
-  inline void setIsConcealed(const bool theValue)
-  {
-    myIsConcealed = theValue;
-  }
+  MODELAPI_EXPORT virtual bool isConcealed();
+
+  /// Sets the result as concealed in the data tree (referenced by other objects)
+  MODELAPI_EXPORT virtual void setIsConcealed(const bool theValue);
 
-  // Retuns the parameters of color definition in the resources config manager
-  virtual void colorConfigInfo(std::string& theSection, std::string& theName,
-    std::string& theDefault) {}
+  /// Enables/disables the result. The disabled result does not participate in any calculation
+  /// and visualization: like it was removed. But it keeps the general parameters: colors, 
+  /// visibility, etc.
+  /// \param theThis pointer to this object, needed to generate all events if it is necessary
+  /// \param theFlag makes disabled if it is true
+  /// \returns true if state is really changed
+  MODELAPI_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
+    const bool theFlag);
+
+  /// Returns the result is disabled or not.
+  MODELAPI_EXPORT virtual bool isDisabled();
 
   /// Request for initialization of data model of the result: adding all attributes
-  virtual void initAttributes() {};
+  MODELAPI_EXPORT virtual void initAttributes();
 
   /// To virtually destroy the fields of successors
   MODELAPI_EXPORT virtual ~ModelAPI_Result();
@@ -58,6 +72,13 @@ class ModelAPI_Result : public ModelAPI_Object
   /// On change of attribute of the result update presentation of this result:
   /// for the current moment there are only presentation attributes assigned to results
   MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
+
+protected:
+  /// This method is called just after creation of the object: it must initialize
+  /// all fields, normally initialized in the constructor
+  MODELAPI_EXPORT virtual void init();
+
+friend class Model_Objects;
 };
 
 //! Pointer on feature object