src/GeomAlgoAPI/GeomAlgoAPI_MakeShape.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        GeomAlgoAPI_MakeShape.h
   4 // Created:     17 Oct 2014
   5 // Author:      Sergey ZARITCHNY
   6 #ifndef GeomAlgoAPI_MakeShape_H_
   7 #define GeomAlgoAPI_MakeShape_H_
   8
   9 #include <GeomAlgoAPI.h>
  10 #include <GeomAPI_DataMapOfShapeShape.h>
  11
  12 #include <list>
  13 #include <memory>
  14
  15 /** \class GeomAlgoAPI_MakeShape
  16  *  \ingroup DataAlgo
  17  *  \brief Interface to the root class of all topological shapes constructions
  18  */
  19 class GeomAlgoAPI_MakeShape : public GeomAPI_Interface
  20 {
  21 public:
  22   /// Builder type enum
  23   enum BuilderType {
  24     OCCT_BRepBuilderAPI_MakeShape,
  25     OCCT_BOPAlgo_Builder
  26   };
  27
  28 public:
  29   /** \brief Constructor by builder and builder type.
  30    *  \param[in] theBuilder pointer to the builder.
  31    *  \param[in] theBuilderType builder type.
  32    */
  33   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape(void* theBuilder, const BuilderType theBuilderType = OCCT_BRepBuilderAPI_MakeShape);
  34
  35   /// \return status of builder.
  36   GEOMALGOAPI_EXPORT bool isDone() const;
  37
  38   /// \return a shape built by the shape construction algorithm.
  39   GEOMALGOAPI_EXPORT virtual const std::shared_ptr<GeomAPI_Shape> shape() const;
  40
  41   /** \return the list of shapes generated from the shape \a theShape.
  42    *  \param[in] theShape base shape.
  43    *  \param[out] theHistory generated shapes.
  44    */
  45   GEOMALGOAPI_EXPORT virtual void generated(const std::shared_ptr<GeomAPI_Shape> theShape,
  46                                             ListOfShape& theHistory);
  47
  48   /** \return the list of shapes modified from the shape \a theShape.
  49    *  \param[in] theShape base shape.
  50    *  \param[out] theHistory modified shapes.
  51    */
  52   GEOMALGOAPI_EXPORT virtual void modified(const std::shared_ptr<GeomAPI_Shape> theShape,
  53                                            ListOfShape& theHistory);
  54
  55   /** \return true if theShape was deleted.
  56    *  \param[in] theShape base shape.
  57    */
  58   GEOMALGOAPI_EXPORT virtual bool isDeleted(const std::shared_ptr<GeomAPI_Shape> theShape);
  59
  60 protected:
  61   /// \brief Default constructor.
  62   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeShape();
  63
  64   /** \brief Sets builder type.
  65    *  \param[in] theBuilderType new builder type.
  66    */
  67   GEOMALGOAPI_EXPORT void setBuilderType(const BuilderType theBuilderType);
  68
  69   /** \brief Sets status of builder.
  70    *  \param[in] theFlag new status.
  71    */
  72   GEOMALGOAPI_EXPORT void setDone(const bool theFlag);
  73
  74   /** \brief Sets result shape.
  75    *  \param[in] theShape new shape.
  76    */
  77   GEOMALGOAPI_EXPORT void setShape(const std::shared_ptr<GeomAPI_Shape> theShape);
  78
  79 private:
  80   GeomAlgoAPI_MakeShape::BuilderType myBuilderType; ///< Type of make shape builder.
  81   bool myDone; ///< Builder status.
  82   std::shared_ptr<GeomAPI_Shape> myShape; ///< Resulting shape.
  83   std::shared_ptr<GeomAPI_DataMapOfShapeShape> myMap; ///< Data map to keep correct orientation of sub-shapes.
  84 };
  85
  86 typedef std::list<std::shared_ptr<GeomAlgoAPI_MakeShape> > ListOfMakeShape;
  87
  88 #endif