SHAPER 9.16.0
GeomAPI_WireExplorer.h
1// Copyright (C) 2014-2026 CEA, EDF
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
18//
19
20#ifndef GeomAPI_WireExplorer_H_
21#define GeomAPI_WireExplorer_H_
22
23#include <GeomAPI.h>
24#include <GeomAPI_Interface.h>
25
26class GeomAPI_Edge;
27class GeomAPI_Shape;
28class GeomAPI_Vertex;
29class GeomAPI_Wire;
30
36{
37public:
39 GEOMAPI_EXPORT GeomAPI_WireExplorer();
40
44 GEOMAPI_EXPORT GeomAPI_WireExplorer(const std::shared_ptr<GeomAPI_Wire>& theWire);
45
49 GEOMAPI_EXPORT void init(const std::shared_ptr<GeomAPI_Wire>& theWire);
50
52 GEOMAPI_EXPORT bool more() const;
53
56 GEOMAPI_EXPORT void next();
57
60 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Edge> current();
61
64 GEOMAPI_EXPORT std::shared_ptr<GeomAPI_Vertex> currentVertex();
65
67 GEOMAPI_EXPORT void clear();
68};
69
70#endif
Interface to the edge object.
Definition: GeomAPI_Edge.h:38
General base class for all interfaces in this package.
Definition: GeomAPI_Interface.h:38
Interface to the topological shape object.
Definition: GeomAPI_Shape.h:43
Interface to the vertex object.
Definition: GeomAPI_Vertex.h:31
This class is used to explore edges of wire in the order of connectivity.
Definition: GeomAPI_WireExplorer.h:36
GEOMAPI_EXPORT void next()
Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore.
Definition: GeomAPI_WireExplorer.cpp:50
GEOMAPI_EXPORT void clear()
Clears the content of the explorer. It will return False on more().
Definition: GeomAPI_WireExplorer.cpp:71
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Vertex > currentVertex()
Definition: GeomAPI_WireExplorer.cpp:63
GEOMAPI_EXPORT void init(const std::shared_ptr< GeomAPI_Wire > &theWire)
Resets this explorer.
Definition: GeomAPI_WireExplorer.cpp:40
GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Edge > current()
Definition: GeomAPI_WireExplorer.cpp:55
GEOMAPI_EXPORT GeomAPI_WireExplorer()
Default constructor. Creates an empty explorer, becomes useful after Init.
Definition: GeomAPI_WireExplorer.cpp:30
GEOMAPI_EXPORT bool more() const
Definition: GeomAPI_WireExplorer.cpp:45
Interface to the wire object.
Definition: GeomAPI_Wire.h:31