SHAPER  9.12.0
ModelAPI_BodyBuilder.h
1 // Copyright (C) 2014-2023 CEA, EDF
2 //
3 // This library is free software; you can redistribute it and/or
4 // modify it under the terms of the GNU Lesser General Public
5 // License as published by the Free Software Foundation; either
6 // version 2.1 of the License, or (at your option) any later version.
7 //
8 // This library is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
11 // Lesser General Public License for more details.
12 //
13 // You should have received a copy of the GNU Lesser General Public
14 // License along with this library; if not, write to the Free Software
15 // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
16 //
17 // See http://www.salome-platform.org/ or email : webmaster.salome@opencascade.com
18 //
19 
20 #ifndef ModelAPI_BodyBuilder_H_
21 #define ModelAPI_BodyBuilder_H_
22 
23 #include <ModelAPI.h>
24 #include <GeomAPI_Shape.h>
25 #include <GeomAlgoAPI_MakeShape.h>
26 #include <GeomAPI_DataMapOfShapeShape.h>
27 #include <memory>
28 #include <string>
29 
30 class ModelAPI_Data;
31 class ModelAPI_Document;
32 class ModelAPI_Object;
33 
39 {
40 public:
41  MODELAPI_EXPORT virtual ~ModelAPI_BodyBuilder() {};
42 
44  virtual void store(const GeomShapePtr& theShape,
45  const bool theIsStoreSameShapes = true) = 0;
46 
48  virtual void storeGenerated(const GeomShapePtr& theFromShape,
49  const GeomShapePtr& theToShape,
50  const bool theIsCleanStored = true) = 0;
51 
53  virtual void storeGenerated(const std::list<GeomShapePtr>& theFromShapes,
54  const GeomShapePtr& theToShape, const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape) = 0;
55 
57  virtual void storeModified(const GeomShapePtr& theOldShape,
58  const GeomShapePtr& theNewShape,
59  const bool theIsCleanStored = true) = 0;
60 
62  virtual void storeModified(const std::list<GeomShapePtr>& theOldShapes,
63  const GeomShapePtr& theNewShape, const std::shared_ptr<GeomAlgoAPI_MakeShape> theMakeShape)=0;
64 
66  virtual GeomShapePtr shape() = 0;
67 
71  virtual bool generated(const GeomShapePtr& theNewShape,
72  const std::string& theName, const bool theCheckIsInResult = true) = 0;
73 
77  virtual void generated(const GeomShapePtr& theOldShape,
78  const GeomShapePtr& theNewShape,
79  const std::string& theName = "") = 0;
80 
83  virtual void modified(const GeomShapePtr& theOldShape,
84  const GeomShapePtr& theNewShape,
85  const std::string& theName = "") = 0;
86 
88  virtual void loadDeletedShapes(const GeomMakeShapePtr& theAlgo,
89  const GeomShapePtr& theOldShape,
90  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
91  const GeomShapePtr& theShapesToAvoid = GeomShapePtr()) = 0;
92 
94  virtual void loadModifiedShapes(const GeomMakeShapePtr& theAlgo,
95  const GeomShapePtr& theOldShape,
96  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
97  const std::string& theName = "") = 0;
98 
100  virtual void loadGeneratedShapes(const GeomMakeShapePtr& theAlgo,
101  const GeomShapePtr& theOldShape,
102  const GeomAPI_Shape::ShapeType theShapeTypeToExplore,
103  const std::string& theName = "",
104  const bool theSaveOldIfNotInTree = false) = 0;
105 
107  virtual void loadFirstLevel(GeomShapePtr theShape,
108  const std::string& theName) = 0;
109 
111  MODELAPI_EXPORT virtual void cleanCash() = 0;
112 
113 protected:
115  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Data> data() const;
116 
118  MODELAPI_EXPORT virtual std::shared_ptr<ModelAPI_Document> document() const;
119 
120 protected:
122  MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object* theOwner);
123 
125 };
126 
128 typedef std::shared_ptr<ModelAPI_BodyBuilder> BodyBuilderPtr;
129 
130 #endif
ShapeType
Shape type enum.
Definition: GeomAPI_Shape.h:46
Extra API for the ResultBody that allows to work with naming.
Definition: ModelAPI_BodyBuilder.h:39
virtual void loadFirstLevel(GeomShapePtr theShape, const std::string &theName)=0
load shapes of the first level (to be used during shape import)
virtual bool generated(const GeomShapePtr &theNewShape, const std::string &theName, const bool theCheckIsInResult=true)=0
Records the subshape newShape which was generated during a topological construction.
virtual GeomShapePtr shape()=0
Returns the shape-result produced by this feature.
virtual void storeGenerated(const GeomShapePtr &theFromShape, const GeomShapePtr &theToShape, const bool theIsCleanStored=true)=0
Stores the generated shape (called by the execution method).
virtual void loadDeletedShapes(const GeomMakeShapePtr &theAlgo, const GeomShapePtr &theOldShape, const GeomAPI_Shape::ShapeType theShapeTypeToExplore, const GeomShapePtr &theShapesToAvoid=GeomShapePtr())=0
load deleted shapes
ModelAPI_Object * myOwner
the owner object this builder belongs to
Definition: ModelAPI_BodyBuilder.h:124
virtual void storeGenerated(const std::list< GeomShapePtr > &theFromShapes, const GeomShapePtr &theToShape, const std::shared_ptr< GeomAlgoAPI_MakeShape > theMakeShape)=0
Stores the root generated shapes (called by the execution method).
virtual MODELAPI_EXPORT std::shared_ptr< ModelAPI_Data > data() const
Returns the data manager of this object: attributes.
Definition: ModelAPI_BodyBuilder.cpp:28
virtual void loadModifiedShapes(const GeomMakeShapePtr &theAlgo, const GeomShapePtr &theOldShape, const GeomAPI_Shape::ShapeType theShapeTypeToExplore, const std::string &theName="")=0
load and orient modified shapes
virtual void modified(const GeomShapePtr &theOldShape, const GeomShapePtr &theNewShape, const std::string &theName="")=0
Records the shape newShape which is a modification of the shape oldShape.
virtual void storeModified(const std::list< GeomShapePtr > &theOldShapes, const GeomShapePtr &theNewShape, const std::shared_ptr< GeomAlgoAPI_MakeShape > theMakeShape)=0
Stores the root modified shapes (called by the execution method).
virtual void store(const GeomShapePtr &theShape, const bool theIsStoreSameShapes=true)=0
Stores the shape (called by the execution method).
virtual MODELAPI_EXPORT void cleanCash()=0
Cleans cash related to the already stored elements.
virtual MODELAPI_EXPORT std::shared_ptr< ModelAPI_Document > document() const
Returns document this feature belongs to.
Definition: ModelAPI_BodyBuilder.cpp:33
virtual void storeModified(const GeomShapePtr &theOldShape, const GeomShapePtr &theNewShape, const bool theIsCleanStored=true)=0
Stores the modified shape (called by the execution method).
MODELAPI_EXPORT ModelAPI_BodyBuilder(ModelAPI_Object *theOwner)
Default constructor accessible only from Model_Object.
Definition: ModelAPI_BodyBuilder.cpp:23
virtual void loadGeneratedShapes(const GeomMakeShapePtr &theAlgo, const GeomShapePtr &theOldShape, const GeomAPI_Shape::ShapeType theShapeTypeToExplore, const std::string &theName="", const bool theSaveOldIfNotInTree=false)=0
load and orient generated shapes
virtual void generated(const GeomShapePtr &theOldShape, const GeomShapePtr &theNewShape, const std::string &theName="")=0
Records the shape newShape which was generated from the shape oldShape during a topological construct...
General object of the application that allows to get/set attributes from the document and compute res...
Definition: ModelAPI_Data.h:72
Document for internal data structure of any object storage.
Definition: ModelAPI_Document.h:52
Represents any object in the data model and in the object browser.
Definition: ModelAPI_Object.h:45