Salome HOME
Add copyright header according to request of CEA from 06.06.2017
[modules/shaper.git] / src / GeomAlgoAPI / GeomAlgoAPI_CompoundBuilder.h
1 // Copyright (C) 2014-2017  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<mailto:webmaster.salome@opencascade.com>
18 //
19
20 #ifndef GeomAlgoAPI_CompoundBuilder_H_
21 #define GeomAlgoAPI_CompoundBuilder_H_
22
23 #include <GeomAlgoAPI.h>
24 #include <GeomAPI_Shape.h>
25 #include <GeomAPI_Pnt.h>
26 #include <GeomAPI_Dir.h>
27 #include <memory>
28
29 #include <list>
30
31 /**\class GeomAlgoAPI_CompoundBuilder
32  * \ingroup DataAlgo
33  * \brief Allows to create face-shapes by different parameters
34  */
35
36 class GEOMALGOAPI_EXPORT GeomAlgoAPI_CompoundBuilder
37 {
38  public:
39   /// Creates compund of the given shapes
40   /// \param theShapes a list of shapes
41   static std::shared_ptr<GeomAPI_Shape> compound(
42       std::list<std::shared_ptr<GeomAPI_Shape> > theShapes);
43
44   /// Produces the integerr identifier of the shape theSub in theContext (needed for
45   /// groups export to old GEOM)
46   /// \returns zero if theSub not found in theContext
47   static int id(
48       std::shared_ptr<GeomAPI_Shape> theContext, std::shared_ptr<GeomAPI_Shape> theSub);
49 };
50
51 #endif