1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
3 // File: ModelAPI_Result.hxx
4 // Created: 07 Jul 2014
5 // Author: Mikhail PONIKAROV
7 #ifndef ModelAPI_Result_H_
8 #define ModelAPI_Result_H_
10 #include "ModelAPI_Object.h"
11 #include <GeomAPI_Shape.h>
13 class ModelAPI_Feature;
15 /**\class ModelAPI_Result
17 * \brief The result of a feature.
19 * A generic class that .
21 class ModelAPI_Result : public ModelAPI_Object
23 bool myIsConcealed; ///< the result is concealed from the data tree (referenced by other objects)
25 bool myIsDisabled; ///< the result is disabled: removed for the user, but keeps the general info
28 /// Reference to the color of the result.
29 /// The integer array is used. It contains tree values for red green and blue values. The values are in
31 inline static const std::string& COLOR_ID()
33 static const std::string MY_COLOR_ID("Color");
37 /// Returns true if the result is concealed from the data tree (referenced by other objects)
38 MODELAPI_EXPORT virtual bool isConcealed();
40 /// Sets the result as concealed in the data tree (referenced by other objects)
41 MODELAPI_EXPORT virtual void setIsConcealed(const bool theValue);
43 /// Enables/disables the result. The disabled result does not participate in any calculation
44 /// and visualization: like it was removed. But it keeps the general parameters: colors,
46 /// \param theThis pointer to this object, needed to generate all events if it is necessary
47 /// \param theFlag makes disabled if it is true
48 /// \returns true if state is really changed
49 MODELAPI_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
52 /// Returns the result is disabled or not.
53 MODELAPI_EXPORT virtual bool isDisabled();
55 /// Returns the parameters of color definition in the resources config manager
56 virtual void colorConfigInfo(std::string& theSection, std::string& theName,
57 std::string& theDefault) {}
59 /// Request for initialization of data model of the result: adding all attributes
60 virtual void initAttributes() {};
62 /// To virtually destroy the fields of successors
63 MODELAPI_EXPORT virtual ~ModelAPI_Result();
65 /// Returns the shape-result produced by this feature (or null if no shapes)
66 MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
68 /// On change of attribute of the result update presentation of this result:
69 /// for the current moment there are only presentation attributes assigned to results
70 MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
73 /// This method is called just after creation of the object: it must initialize
74 /// all fields, normally initialized in the constructor
75 MODELAPI_EXPORT virtual void init();
77 friend class Model_Objects;
80 //! Pointer on feature object
81 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;