Salome HOME
Merge branch 'V9_9_BR'
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_MakeVolume.h
1 // Copyright (C) 2014-2022  CEA/DEN, EDF R&D
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 GeomAlgoAPI_MakeVolume_H_
21 #define GeomAlgoAPI_MakeVolume_H_
22
23 #include <GeomAlgoAPI.h>
24 #include <GeomAlgoAPI_MakeShape.h>
25
26 #include <GeomAPI_Shape.h>
27
28 /// \class GeomAlgoAPI_MakeVolume
29 /// \ingroup DataAlgo
30 /// \brief Perform building solid (compsolid) from a list of faces.
31 class GeomAlgoAPI_MakeVolume : public GeomAlgoAPI_MakeShape
32 {
33   bool myAvoidInternal; // to remove internal faces from the result
34 public:
35   /// \brief Perform making volume.
36   /// \param[in] theObjects list of faces.
37   /// \return a solid or a compsolid as result of operation.
38   GEOMALGOAPI_EXPORT static std::shared_ptr<GeomAPI_Shape> make(const ListOfShape& theFaces);
39
40   /// Constructor.
41   /// \param theFaces faces that will construct a solid
42   /// \param theAvoidInternal to remove internal faces from the result
43   GEOMALGOAPI_EXPORT GeomAlgoAPI_MakeVolume(const ListOfShape& theFaces,
44     const bool theAvoidInternal);
45
46   /// \return the list of shapes modified from the shape \a theShape.
47   /// \param[in] theOldShape base shape.
48   /// \param[out] theNewShapes shapes modified from \a theShape. Does not cleared!
49   GEOMALGOAPI_EXPORT virtual void modified(const GeomShapePtr theOldShape,
50                                            ListOfShape& theNewShapes);
51
52 private:
53   /// Builds resulting shape.
54   void build(const ListOfShape& theFaces);
55 };
56
57 #endif