src/ModelAPI/ModelAPI_Result.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_Result.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_Result_H_
   8 #define ModelAPI_Result_H_
   9
  10 #include "ModelAPI_Object.h"
  11 #include <GeomAPI_Shape.h>
  12
  13 class ModelAPI_Feature;
  14
  15 /**\class ModelAPI_Result
  16  * \ingroup DataModel
  17  * \brief The result of a feature.
  18  *
  19  * A generic class that .
  20  */
  21 class ModelAPI_Result : public ModelAPI_Object
  22 {
  23   bool myIsConcealed; ///< the result is concealed from the data tree (referenced by other objects)
  24  protected:
  25   bool myIsDisabled; ///< the result is disabled: removed for the user, but keeps the general info
  26  public:
  27
  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
  30   /// [0, 255] range
  31   inline static const std::string& COLOR_ID()
  32   {
  33     static const std::string MY_COLOR_ID("Color");
  34     return MY_COLOR_ID;
  35   }
  36
  37   /// Returns true if the result is concealed from the data tree (referenced by other objects)
  38   inline bool isConcealed()
  39   {
  40     return myIsConcealed;
  41   }
  42
  43   /// Returns true if the result is concealed from the data tree (referenced by other objects)
  44   MODELAPI_EXPORT void setIsConcealed(const bool theValue);
  45
  46   /// Enables/disables the result. The disabled result does not participate in any calculation
  47   /// and visualization: like it was removed. But it keeps the general parameters: colors,
  48   /// visibility, etc.
  49   /// \param theThis pointer to this object, needed to generate all events if it is neccessary
  50   /// \param theFlag makes disabled if it is true
  51   /// \returns true if state is really changed
  52   MODELAPI_EXPORT virtual bool setDisabled(std::shared_ptr<ModelAPI_Result> theThis,
  53     const bool theFlag);
  54
  55   /// Returns the result is disabled or not.
  56   MODELAPI_EXPORT virtual bool isDisabled() const;
  57
  58   // Retuns the parameters of color definition in the resources config manager
  59   virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  60     std::string& theDefault) {}
  61
  62   /// Request for initialization of data model of the result: adding all attributes
  63   virtual void initAttributes() {};
  64
  65   /// To virtually destroy the fields of successors
  66   MODELAPI_EXPORT virtual ~ModelAPI_Result();
  67
  68   /// Returns the shape-result produced by this feature (or null if no shapes)
  69   MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  70
  71   /// On change of attribute of the result update presentation of this result:
  72   /// for the current moment there are only presentation attributes assigned to results
  73   MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
  74 };
  75
  76 //! Pointer on feature object
  77 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;
  78
  79 #endif