1 // Copyright (C) 2014-2022 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 email : webmaster.salome@opencascade.com
20 #ifndef GeomAlgoAPI_WireBuilder_H_
21 #define GeomAlgoAPI_WireBuilder_H_
23 #include "GeomAlgoAPI.h"
24 #include "GeomAlgoAPI_MakeShapeCustom.h"
26 #include <GeomAPI_Shape.h>
28 /// \class GeomAlgoAPI_WireBuilder
30 /// \brief Allows to create wire-shapes by different parameters.
31 class GeomAlgoAPI_WireBuilder : public GeomAlgoAPI_MakeShapeCustom
34 /// \brief Creates a wire from edges and wires.
35 /// \param[in] theShapes list of shapes. Only edges and wires allowed.
36 /// \param[in] theForceOpenWire indicates the necessity to split wire
37 /// in the first vertex if it becomes closed.
38 /// The edges are not to be consecutive.
39 /// But they are to be all connected geometrically or topologically.
40 GEOMALGOAPI_EXPORT GeomAlgoAPI_WireBuilder(const ListOfShape& theShapes,
41 const bool theForceOpenWire = false);
43 /// \brief Creates a wire from edges and wires.
44 /// \param[in] theShapes list of shapes. Only edges and wires allowed.
45 /// The edges are not to be consecutive.
46 /// But they are to be all connected geometrically or topologically.
47 /// \return wire created from theShapes. Empty in case of error or bad input.
48 GEOMALGOAPI_EXPORT static GeomShapePtr wire(const ListOfShape& theShapes);
50 /// \brief Checks if the wire is self-intersected.
51 /// \param[in] theWire the wire to be checked
52 /// \return true if the wire is self-intersected, otherwise - false.
53 GEOMALGOAPI_EXPORT static bool isSelfIntersected(const GeomShapePtr& theWire);