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 #include <vector>
  13
  14 /**\class Model_ResultConstruction
  15  * \ingroup DataModel
  16  * \brief The construction element result of a feature.
  17  *
  18  * Provides a shape that may be displayed in the viewer.
  19  * Intermediate, light result that in many cases produces a result on the fly.
  20  */
  21 class Model_ResultConstruction : public ModelAPI_ResultConstruction
  22 {
  23   std::shared_ptr<ModelAPI_Feature> myOwner;  ///< owner of this result
  24   std::shared_ptr<GeomAPI_Shape> myShape;  ///< shape of this result created "on the fly"
  25   bool myFacesUpToDate; ///< is true if faces in myuFaces are computed and up to date
  26   std::vector<std::shared_ptr<GeomAPI_Face> > myFaces; ///< stores the up to date faces if they exist
  27   bool myIsInHistory;
  28  public:
  29   /// default color for a result construction
  30   inline static const std::string& DEFAULT_COLOR()
  31   {
  32     static const std::string RESULT_CONSTRUCTION_COLOR("#000000");
  33     return RESULT_CONSTRUCTION_COLOR;
  34   }
  35
  36   /// Request for initialization of data model of the result: adding all attributes
  37   virtual void initAttributes();
  38
  39   // Retuns the parameters of color definition in the resources config manager
  40   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  41                                             std::string& theDefault);
  42
  43   /// By default object is displayed in the object browser.
  44   MODEL_EXPORT virtual bool isInHistory()
  45   {
  46     return myIsInHistory;
  47   }
  48
  49   /// Sets the result
  50   MODEL_EXPORT virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape);
  51   /// Returns the shape-result produced by this feature
  52   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  53
  54   /// Sets the flag that it must be displayed in history (default is true)
  55   MODEL_EXPORT virtual void setIsInHistory(const bool myIsInHistory);
  56
  57   /// if the construction result may be used as faces, this method returns not zero number of faces
  58   MODEL_EXPORT virtual int facesNum();
  59   /// if the construction result may be used as faces, this method returns face by zero based index
  60   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex);
  61
  62  protected:
  63   /// Makes a body on the given feature
  64   Model_ResultConstruction();
  65
  66   friend class Model_Document;
  67 };
  68
  69 #endif