src/ModelAPI/ModelAPI_BodyBuilder.h

   1 // Copyright (C) 2014-20xx CEA/DEN, EDF R&D
   2
   3 // File:        ModelAPI_BodyBuilder.hxx
   4 // Created:     07 Jul 2014
   5 // Author:      Mikhail PONIKAROV
   6
   7 #ifndef ModelAPI_BodyBuilder_H_
   8 #define ModelAPI_BodyBuilder_H_
   9
  10 #include <ModelAPI.h>
  11 #include <GeomAPI_Shape.h>
  12 #include <GeomAlgoAPI_MakeShape.h>
  13 #include <GeomAPI_DataMapOfShapeShape.h>
  14 #include <memory>
  15 #include <string>
  16
  17 class ModelAPI_Data;
  18 class ModelAPI_Document;
  19 class ModelAPI_Object;
  20
  21 /**\class ModelAPI_BodyBuilder
  22 * \ingroup DataModel
  23  * \brief Extra API for the ResultBody that allows to work with naming.
  24 */
  25 class ModelAPI_BodyBuilder
  26 {
  27 public:
  28   MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {};
  29
  30   /// Stores the shape (called by the execution method).
  31   virtual void store(const std::shared_ptr<GeomAPI_Shape>& theShape,
  32                      const bool theIsStoreSameShapes = true) = 0;
  33
  34   /// Stores the generated shape (called by the execution method).
  35   virtual void storeGenerated(const std::shared_ptr<GeomAPI_Shape>& theFromShape,
  36                                   const std::shared_ptr<GeomAPI_Shape>& theToShape) = 0;
  37
  38   /// Stores the modified shape (called by the execution method).
  39   virtual void storeModified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  40                                   const std::shared_ptr<GeomAPI_Shape>& theNewShape,
  41                             const int theDecomposeSolidsTag = 0) = 0;
  42
  43   /// Stores the shape without naming support
  44   virtual void storeWithoutNaming(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
  45
  46   /// Returns the shape-result produced by this feature
  47   virtual std::shared_ptr<GeomAPI_Shape> shape() = 0;
  48
  49   /// Records the subshape newShape which was generated during a topological construction.
  50   /// As an example, consider the case of a face generated in construction of a box.
  51   virtual void generated(
  52     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
  53     const int theTag = 1) = 0;
  54
  55   /// Records the shape newShape which was generated from the shape oldShape during a topological
  56   /// construction. As an example, consider the case of a face generated from an edge in
  57   /// construction of a prism.
  58   virtual void generated(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  59     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
  60     const int theTag = 1) = 0;
  61
  62   /// Records the shape newShape which is a modification of the shape oldShape.
  63   /// As an example, consider the case of a face split or merged in a Boolean operation.
  64   virtual void modified(const std::shared_ptr<GeomAPI_Shape>& theOldShape,
  65     const std::shared_ptr<GeomAPI_Shape>& theNewShape, const std::string& theName,
  66     const int theTag = 1) = 0;
  67
  68   /// Records the shape oldShape which was deleted from the current label.
  69   /// As an example, consider the case of a face removed by a Boolean operation.
  70   virtual void deleted(
  71     const std::shared_ptr<GeomAPI_Shape>& theOldShape, const int theTag = 1) = 0;
  72
  73   /// load deleted shapes
  74   virtual void loadDeletedShapes (GeomAlgoAPI_MakeShape* theMS,
  75                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  76                                                const int  theKindOfShape,
  77                                                const int  theTag) = 0;
  78   /// load and orient modified shapes
  79   virtual void loadAndOrientModifiedShapes (
  80                                                    GeomAlgoAPI_MakeShape* theMS,
  81                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  82                                                const int  theKindOfShape,
  83                                                const int  theTag,
  84                                                                                            const std::string& theName,
  85                                                GeomAPI_DataMapOfShapeShape& theSubShapes,
  86                                                const bool theIsStoreSeparate = false) = 0;
  87   /// load and orient generated shapes
  88   virtual void loadAndOrientGeneratedShapes (
  89                                                    GeomAlgoAPI_MakeShape* theMS,
  90                                                std::shared_ptr<GeomAPI_Shape>  theShapeIn,
  91                                                const int  theKindOfShape,
  92                                                const int  theTag,
  93                                                                                            const std::string& theName,
  94                                                GeomAPI_DataMapOfShapeShape& theSubShapes) = 0;
  95
  96   /// load shapes of the first level (to be used during shape import)
  97   virtual void loadFirstLevel(std::shared_ptr<GeomAPI_Shape> theShape,
  98                               const std::string& theName, int&  theTag) = 0;
  99
 100   /// load disconnected edges
 101   virtual void loadDisconnectedEdges(std::shared_ptr<GeomAPI_Shape> theShape,
 102                                      const std::string& theName, int&  theTag) = 0;
 103
 104   /// load disconnected vetexes
 105   virtual void loadDisconnectedVertexes(std::shared_ptr<GeomAPI_Shape> theShape,
 106                                         const std::string& theName,int&  theTag) = 0;
 107
 108   /// Converts evolution of sub-shapes stored in naming structure to selection
 109   /// (theFlag = true) and back (theFlag = false)
 110   virtual void evolutionToSelection(const bool theFlag) = 0;
 111
 112   /// Returns true if the latest modification of this body in the naming history
 113   // is equal to the given shape
 114   virtual bool isLatestEqual(const std::shared_ptr<GeomAPI_Shape>& theShape) = 0;
 115
 116 protected:
 117   /// Returns the data manager of this object: attributes
 118   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
 119
 120   /// Returns document this feature belongs to
 121   MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
 122
 123 protected:
 124   /// Deafult constructor accessible only from Model_Object
 125   MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner);
 126
 127   ModelAPI_Object* myOwner; ///< the owner object this builder belongs to
 128 };
 129
 130 //! Pointer on feature object
 131 typedef std::shared_ptr<ModelAPI_BodyBuilder> BodyBuilderPtr;
 132
 133 #endif