GeomAPI_WireExplorer Class Reference
This class is used to explore edges of wire in the order of connectivity. More...
Inheritance diagram for GeomAPI_WireExplorer:
Public Member Functions | |
| GEOMAPI_EXPORT | GeomAPI_WireExplorer () |
| Default constructor. Creates an empty explorer, becomes useful after Init. More... | |
| GEOMAPI_EXPORT | GeomAPI_WireExplorer (const std::shared_ptr< GeomAPI_Wire > &theWire) |
| Constructs an iterator on a wire. More... | |
| GEOMAPI_EXPORT void | init (const std::shared_ptr< GeomAPI_Wire > &theWire) |
| Resets this explorer. More... | |
| GEOMAPI_EXPORT bool | more () const |
| GEOMAPI_EXPORT void | next () |
| Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore. More... | |
| GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Edge > | current () |
| GEOMAPI_EXPORT std::shared_ptr< GeomAPI_Vertex > | currentVertex () |
| GEOMAPI_EXPORT void | clear () |
| Clears the content of the explorer. It will return False on more(). More... | |
| template<class T > | |
| T * | implPtr () |
| Returns the pointer to the impl. More... | |
| template<class T > | |
| const T * | implPtr () const |
| Returns the pointer to the impl. More... | |
| template<class T > | |
| const T & | impl () const |
| Returns the reference object of the impl. More... | |
| template<class T > | |
| void | setImpl (T *theImpl) |
| Updates the impl (deletes the old one) More... | |
| GEOMAPI_EXPORT bool | empty () const |
| Returns true if the impl is empty. More... | |
Detailed Description
This class is used to explore edges of wire in the order of connectivity.
Constructor & Destructor Documentation
◆ GeomAPI_WireExplorer() [1/2]
| GeomAPI_WireExplorer::GeomAPI_WireExplorer | ( | ) |
Default constructor. Creates an empty explorer, becomes useful after Init.
◆ GeomAPI_WireExplorer() [2/2]
| GeomAPI_WireExplorer::GeomAPI_WireExplorer | ( | const std::shared_ptr< GeomAPI_Wire > & | theWire | ) |
Constructs an iterator on a wire.
- Parameters
-
[in] theWire a wire to explore.
Member Function Documentation
◆ init()
| void GeomAPI_WireExplorer::init | ( | const std::shared_ptr< GeomAPI_Wire > & | theWire | ) |
Resets this explorer.
- Parameters
-
[in] theWire a wire to explore.
◆ more()
| bool GeomAPI_WireExplorer::more | ( | ) | const |
- Returns
- true if there are more shapes in the exploration.
◆ next()
| void GeomAPI_WireExplorer::next | ( | ) |
Moves to the next Shape in the exploration or do nothing if there are no more shapes to explore.
◆ current()
| std::shared_ptr< GeomAPI_Edge > GeomAPI_WireExplorer::current | ( | ) |
- Returns
- the current edge in the exploration or empty pointer if this explorer has no more shapes to explore.
◆ currentVertex()
| std::shared_ptr< GeomAPI_Vertex > GeomAPI_WireExplorer::currentVertex | ( | ) |
- Returns
- the current vertex in the exploration or empty pointer if this explorer has no more shapes to explore.
◆ clear()
| void GeomAPI_WireExplorer::clear | ( | ) |
Clears the content of the explorer. It will return False on more().
◆ implPtr() [1/2]
template<class T >
|
inlineinherited |
Returns the pointer to the impl.
◆ implPtr() [2/2]
template<class T >
|
inlineinherited |
Returns the pointer to the impl.
◆ impl()
template<class T >
|
inlineinherited |
Returns the reference object of the impl.
◆ setImpl()
template<class T >
|
inlineinherited |
Updates the impl (deletes the old one)
◆ empty()
|
inherited |
Returns true if the impl is empty.
