src/Model/Model_ResultConstruction.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_ResultConstruction.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef Model_ResultConstruction_H_
   8 #define Model_ResultConstruction_H_
   9
  10 #include "Model.h"
  11 #include <ModelAPI_ResultConstruction.h>
  12
  13 /**\class ModelAPI_ResultConstruction
  14  * \ingroup DataModel
  15  * \brief The construction element result of a feature.
  16  *
  17  * Provides a shape that may be displayed in the viewer.
  18  * Intermediate, light result that in many cases produces a result on the fly.
  19  */
  20 class Model_ResultConstruction : public ModelAPI_ResultConstruction
  21 {
  22   std::shared_ptr<ModelAPI_Feature> myOwner;  ///< owner of this result
  23   std::shared_ptr<GeomAPI_Shape> myShape;  ///< shape of this result created "on the fly"
  24   bool myIsInHistory;
  25  public:
  26   /// By default object is displayed in the object browser.
  27   MODEL_EXPORT virtual bool isInHistory()
  28   {
  29     return myIsInHistory;
  30   }
  31
  32   /// Sets the result
  33   MODEL_EXPORT virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape);
  34   /// Returns the shape-result produced by this feature
  35   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  36
  37   /// Sets the flag that it must be displayed in history (default is true)
  38   MODEL_EXPORT virtual void setIsInHistory(const bool myIsInHistory);
  39
  40  protected:
  41   /// Makes a body on the given feature
  42   Model_ResultConstruction();
  43
  44   friend class Model_Document;
  45 };
  46
  47 #endif