Open CASCADE Technology Reference Manual 8.0.0
Loading...
Searching...
No Matches
Public Member Functions
TopOpeBRepTool_ShapeExplorer Class Reference

Extends TopExp_Explorer by counting index of current item (for tracing and debug) More...

#include <TopOpeBRepTool_ShapeExplorer.hxx>

Inheritance diagram for TopOpeBRepTool_ShapeExplorer:
Inheritance graph
[legend]

Public Member Functions

 TopOpeBRepTool_ShapeExplorer ()
 Creates an empty explorer, becomes useful after Init.
 
 TopOpeBRepTool_ShapeExplorer (const TopoDS_Shape &S, const TopAbs_ShapeEnum ToFind, const TopAbs_ShapeEnum ToAvoid=TopAbs_SHAPE)
 Creates an Explorer on the Shape .
 
void Init (const TopoDS_Shape &S, const TopAbs_ShapeEnum ToFind, const TopAbs_ShapeEnum ToAvoid=TopAbs_SHAPE)
 
void Next ()
 Moves to the next Shape in the exploration.
 
int Index () const
 Index of current sub-shape.
 
Standard_OStreamDumpCurrent (Standard_OStream &OS) const
 Dump info on current shape to stream.
 
- Public Member Functions inherited from TopExp_Explorer
 TopExp_Explorer () noexcept
 Creates an empty explorer, becomes useful after Init.
 
 TopExp_Explorer (const TopoDS_Shape &S, const TopAbs_ShapeEnum ToFind, const TopAbs_ShapeEnum ToAvoid=TopAbs_SHAPE)
 Creates an Explorer on the Shape .
 
void Init (const TopoDS_Shape &S, const TopAbs_ShapeEnum ToFind, const TopAbs_ShapeEnum ToAvoid=TopAbs_SHAPE)
 Resets this explorer on the shape S. It is initialized to search the shape S, for shapes of type ToFind, that are not part of a shape ToAvoid. If the shape ToAvoid is equal to TopAbs_SHAPE, or if it is the same as, or less complex than, the shape ToFind it has no effect on the search.
 
bool More () const noexcept
 Returns True if there are more shapes in the exploration.
 
void Next ()
 Moves to the next Shape in the exploration.
 
const TopoDS_ShapeValue () const noexcept
 Returns the current shape in the exploration.
 
const TopoDS_ShapeCurrent () const noexcept
 Returns the current shape in the exploration.
 
void ReInit ()
 Reinitialize the exploration with the original arguments.
 
const TopoDS_ShapeExploredShape () const noexcept
 Return explored shape.
 
int Depth () const noexcept
 Returns the current depth of the exploration. 0 is the shape to explore itself.
 
void Clear ()
 Clears the content of the explorer.
 
 ~TopExp_Explorer ()
 Destructor.
 
NCollection_ForwardRangeIterator< TopExp_Explorerbegin ()
 Returns an STL-compatible iterator for range-based for loops.
 
NCollection_ForwardRangeSentinel end () const
 Returns a sentinel marking the end of iteration.
 

Detailed Description

Extends TopExp_Explorer by counting index of current item (for tracing and debug)

Constructor & Destructor Documentation

◆ TopOpeBRepTool_ShapeExplorer() [1/2]

TopOpeBRepTool_ShapeExplorer::TopOpeBRepTool_ShapeExplorer ( )
inline

Creates an empty explorer, becomes useful after Init.

◆ TopOpeBRepTool_ShapeExplorer() [2/2]

TopOpeBRepTool_ShapeExplorer::TopOpeBRepTool_ShapeExplorer ( const TopoDS_Shape & S,
const TopAbs_ShapeEnum ToFind,
const TopAbs_ShapeEnum ToAvoid = TopAbs_SHAPE )
inline

Creates an Explorer on the Shape .

<ToFind> is the type of shapes to search. TopAbs_VERTEX, TopAbs_EDGE, ...

<ToAvoid> is the type of shape to skip in the exploration. If <ToAvoid> is equal or less complex than <ToFind> or if <ToAVoid> is SHAPE it has no effect on the exploration.

Member Function Documentation

◆ DumpCurrent()

Standard_OStream & TopOpeBRepTool_ShapeExplorer::DumpCurrent ( Standard_OStream & OS) const
inline

Dump info on current shape to stream.

◆ Index()

int TopOpeBRepTool_ShapeExplorer::Index ( ) const
inline

Index of current sub-shape.

◆ Init()

void TopOpeBRepTool_ShapeExplorer::Init ( const TopoDS_Shape & S,
const TopAbs_ShapeEnum ToFind,
const TopAbs_ShapeEnum ToAvoid = TopAbs_SHAPE )
inline

◆ Next()

void TopOpeBRepTool_ShapeExplorer::Next ( )
inline

Moves to the next Shape in the exploration.


The documentation for this class was generated from the following file: