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   MODELAPI_EXPORT virtual bool isConcealed();
  39
  40   /// Sets the result as concealed in the data tree (referenced by other objects)
  41   MODELAPI_EXPORT virtual void setIsConcealed(const bool theValue);
  42
  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,
  45   /// visibility, etc.
  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,
  50     const bool theFlag);
  51
  52   /// Returns the result is disabled or not.
  53   MODELAPI_EXPORT virtual bool isDisabled();
  54
  55   /// Request for initialization of data model of the result: adding all attributes
  56   virtual void initAttributes() {};
  57
  58   /// To virtually destroy the fields of successors
  59   MODELAPI_EXPORT virtual ~ModelAPI_Result();
  60
  61   /// Returns the shape-result produced by this feature (or null if no shapes)
  62   MODELAPI_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  63
  64   /// On change of attribute of the result update presentation of this result:
  65   /// for the current moment there are only presentation attributes assigned to results
  66   MODELAPI_EXPORT virtual void attributeChanged(const std::string& theID);
  67
  68 protected:
  69   /// This method is called just after creation of the object: it must initialize
  70   /// all fields, normally initialized in the constructor
  71   MODELAPI_EXPORT virtual void init();
  72
  73 friend class Model_Objects;
  74 };
  75
  76 //! Pointer on feature object
  77 typedef std::shared_ptr<ModelAPI_Result> ResultPtr;
  78
  79 #endif