Open CASCADE Technology  7.4.1.dev
Public Member Functions
TopoDS_Iterator Class Reference

Iterates on the underlying shape underlying a given TopoDS_Shape object, providing access to its component sub-shapes. Each component shape is returned as a TopoDS_Shape with an orientation, and a compound of the original values and the relative values. More...

#include <TopoDS_Iterator.hxx>

Public Member Functions

 TopoDS_Iterator ()
 Creates an empty Iterator. More...
 
 TopoDS_Iterator (const TopoDS_Shape &S, const Standard_Boolean cumOri=Standard_True, const Standard_Boolean cumLoc=Standard_True)
 Creates an Iterator on <S> sub-shapes. Note: More...
 
void Initialize (const TopoDS_Shape &S, const Standard_Boolean cumOri=Standard_True, const Standard_Boolean cumLoc=Standard_True)
 Initializes this iterator with shape S. Note: More...
 
Standard_Boolean More () const
 Returns true if there is another sub-shape in the shape which this iterator is scanning. More...
 
void Next ()
 Moves on to the next sub-shape in the shape which this iterator is scanning. Exceptions Standard_NoMoreObject if there are no more sub-shapes in the shape. More...
 
const TopoDS_ShapeValue () const
 Returns the current sub-shape in the shape which this iterator is scanning. Exceptions Standard_NoSuchObject if there is no current sub-shape. More...
 

Detailed Description

Iterates on the underlying shape underlying a given TopoDS_Shape object, providing access to its component sub-shapes. Each component shape is returned as a TopoDS_Shape with an orientation, and a compound of the original values and the relative values.

Constructor & Destructor Documentation

◆ TopoDS_Iterator() [1/2]

TopoDS_Iterator::TopoDS_Iterator ( )

Creates an empty Iterator.

◆ TopoDS_Iterator() [2/2]

TopoDS_Iterator::TopoDS_Iterator ( const TopoDS_Shape S,
const Standard_Boolean  cumOri = Standard_True,
const Standard_Boolean  cumLoc = Standard_True 
)

Creates an Iterator on <S> sub-shapes. Note:

  • If cumOri is true, the function composes all sub-shapes with the orientation of S.
  • If cumLoc is true, the function multiplies all sub-shapes by the location of S, i.e. it applies to each sub-shape the transformation that is associated with S.

Member Function Documentation

◆ Initialize()

void TopoDS_Iterator::Initialize ( const TopoDS_Shape S,
const Standard_Boolean  cumOri = Standard_True,
const Standard_Boolean  cumLoc = Standard_True 
)

Initializes this iterator with shape S. Note:

  • If cumOri is true, the function composes all sub-shapes with the orientation of S.
  • If cumLoc is true, the function multiplies all sub-shapes by the location of S, i.e. it applies to each sub-shape the transformation that is associated with S.

◆ More()

Standard_Boolean TopoDS_Iterator::More ( ) const

Returns true if there is another sub-shape in the shape which this iterator is scanning.

◆ Next()

void TopoDS_Iterator::Next ( )

Moves on to the next sub-shape in the shape which this iterator is scanning. Exceptions Standard_NoMoreObject if there are no more sub-shapes in the shape.

◆ Value()

const TopoDS_Shape& TopoDS_Iterator::Value ( ) const

Returns the current sub-shape in the shape which this iterator is scanning. Exceptions Standard_NoSuchObject if there is no current sub-shape.


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