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   bool myIsInfinite;
  29  public:
  30   /// Retuns the parameters of color definition in the resources config manager
  31   MODEL_EXPORT virtual void colorConfigInfo(std::string& theSection, std::string& theName,
  32                                             std::string& theDefault);
  33
  34   /// By default object is displayed in the object browser.
  35   MODEL_EXPORT virtual bool isInHistory()
  36   {
  37     return myIsInHistory;
  38   }
  39
  40   /// Sets the result
  41   MODEL_EXPORT virtual void setShape(std::shared_ptr<GeomAPI_Shape> theShape);
  42   /// Returns the shape-result produced by this feature
  43   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Shape> shape();
  44
  45   /// Sets the flag that it must be displayed in history (default is true)
  46   MODEL_EXPORT virtual void setIsInHistory(const bool myIsInHistory);
  47
  48   /// if the construction result may be used as faces, this method returns not zero number of faces
  49   MODEL_EXPORT virtual int facesNum();
  50   /// if the construction result may be used as faces, this method returns face by zero based index
  51   MODEL_EXPORT virtual std::shared_ptr<GeomAPI_Face> face(const int theIndex);
  52
  53   /// By default object is not infinite.
  54   MODEL_EXPORT virtual bool isInfinite();
  55   /// Sets the flag that it is infinite
  56   MODEL_EXPORT virtual void setInfinite(const bool theInfinite);
  57   /// The construction element is never concealed
  58   MODEL_EXPORT virtual void setIsConcealed(const bool theValue);
  59
  60  protected:
  61   /// Makes a body on the given feature
  62   Model_ResultConstruction();
  63
  64   friend class Model_Objects;
  65 };
  66
  67 #endif