1 // Copyright (C) 2014-2017 CEA/DEN, EDF R&D
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.
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.
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
17 // See http://www.salome-platform.org/ or
18 // email : webmaster.salome@opencascade.com<mailto:webmaster.salome@opencascade.com>
21 #ifndef GeomAlgoAPI_MakeSweep_H_
22 #define GeomAlgoAPI_MakeSweep_H_
24 #include <GeomAlgoAPI.h>
26 #include <GeomAlgoAPI_MakeShapeList.h>
28 /**\class GeomAlgoAPI_MakeSweep
30 * \brief The abstract class MakeSweep is the root class of swept primitives.
31 * Sweeps are objects you obtain by sweeping a profile along a path.
32 * The profile can be any topology and the path is usually a curve or
33 * a wire. The profile generates objects according to the following rules:
34 * - Vertices generate Edges.
35 * - Edges generate Faces.
36 * - Wires generate Shells.
37 * - Faces generate Solids.
38 * - Shells generate Composite Solids.
39 * You are not allowed to sweep Solids and Composite Solids.
41 class GeomAlgoAPI_MakeSweep : public GeomAlgoAPI_MakeShapeList
44 /// \returns the list of from shapes.
45 GEOMALGOAPI_EXPORT const ListOfShape& fromShapes() const;
47 /// \return the list of to shapes.
48 GEOMALGOAPI_EXPORT const ListOfShape& toShapes() const;
50 /// \brief Adds a shape to list of from shape.
51 /// \param[in] theShape a shape to add.
52 GEOMALGOAPI_EXPORT void addFromShape(const std::shared_ptr<GeomAPI_Shape> theShape);
54 /// \brief Sets from shapes
55 /// \param[in] theListOfShapes list of from shapes.
56 GEOMALGOAPI_EXPORT void setFromShapes(const ListOfShape& theListOfShapes);
58 /// \brief Adds a face to list of to shape.
59 /// \param[in] theShape a face to add.
60 GEOMALGOAPI_EXPORT void addToShape(const std::shared_ptr<GeomAPI_Shape> theShape);
62 /// \brief Sets to shapes
63 /// \param[in] theListOfShapes list of to shapes.
64 GEOMALGOAPI_EXPORT void setToShapes(const ListOfShape& theListOfShapes);
67 /// Empty constructor.
68 GeomAlgoAPI_MakeSweep() : GeomAlgoAPI_MakeShapeList() {};
71 ListOfShape myFromShapes;
72 ListOfShape myToShapes;