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