Open CASCADE Technology 7.8.2.dev
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:

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.
 
Standard_Integer 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 ()
 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.
 
Standard_Boolean More () const
 Returns True if there are more shapes in the exploration.
 
void Next ()
 Moves to the next Shape in the exploration. Exceptions Standard_NoMoreObject if there are no more shapes to explore.
 
const TopoDS_ShapeValue () const
 Returns the current shape in the exploration. Exceptions Standard_NoSuchObject if this explorer has no more shapes to explore.
 
const TopoDS_ShapeCurrent () const
 Returns the current shape in the exploration. Exceptions Standard_NoSuchObject if this explorer has no more shapes to explore.
 
void ReInit ()
 Reinitialize the exploration with the original arguments.
 
const TopoDS_ShapeExploredShape () const
 Return explored shape.
 
Standard_Integer Depth () const
 Returns the current depth of the exploration. 0 is the shape to explore itself.
 
void Clear ()
 Clears the content of the explorer. It will return False on More().
 
 ~TopExp_Explorer ()
 Destructor.
 

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()

Standard_Integer 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: