1 // Copyright (C) 2014-2019 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 GeomAPI_WireExplorer_H_
21 #define GeomAPI_WireExplorer_H_
24 #include <GeomAPI_Interface.h>
29 /** \class GeomAPI_WireExplorer
31 * \brief This class is used to explore edges of wire in the order of connectivity.
33 class GeomAPI_WireExplorer : public GeomAPI_Interface
36 /// Default constructor. Creates an empty explorer, becomes usefull after Init.
37 GEOMAPI_EXPORT GeomAPI_WireExplorer();
39 /** \brief Constructs an iterator on a wire.
40 * \param[in] theWire a wire to explore.
42 GEOMAPI_EXPORT GeomAPI_WireExplorer(const std::shared_ptr<GeomAPI_Wire>& theWire);
44 /** \brief Resets this explorer.
45 * \param[in] theWire a wire to explore.
47 GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Wire>& theWire);
49 /// \return true if there are more shapes in the exploration.
50 GEOMAPI_EXPORT bool more() const;
52 /// Moves to the next Shape in the exploration or do nothing
53 /// if there are no more shapes to explore.
54 GEOMAPI_EXPORT void next();
56 /// \return the current shape in the exploration or empty pointer
57 /// if this explorer has no more shapes to explore.
58 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Shape> current();
60 /// Clears the content of the explorer. It will return False on more().
61 GEOMAPI_EXPORT void clear();