UsdPrimRange::iterator Class Reference

A forward iterator into a UsdPrimRange. More...

Inherits iterator_adaptor< iterator, Usd_PrimDataConstPtr, UsdPrim, boost::forward_traversal_tag, UsdPrim >.

Public Member Functions

 iterator (EndSentinel e)
 Allow implicit conversion from EndSentinel. More...
 
bool IsPostVisit () const
 Return true if the iterator points to a prim visited the second time (in post order) for a pre- and post-order iterator, false otherwise. More...
 
USD_API void PruneChildren ()
 Behave as if the current prim has no children when next advanced. More...
 
bool operator== (iterator const &other) const
 Return true if this iterator is equivalent to other. More...
 
bool operator== (EndSentinel const &other) const
 Return true if this iterator is equivalent to other. More...
 
bool operator!= (iterator const &other) const
 Return true if this iterator is not equivalent to other. More...
 
bool operator!= (EndSentinel const &other) const
 Return true if this iterator is not equivalent to other. More...
 

Friends

class UsdPrimRange
 
class boost::iterator_core_access
 

Detailed Description

A forward iterator into a UsdPrimRange.

Iterators are valid for the range they were obtained from. An iterator i obtained from a range r is not valid for a range c copied from r.

Definition at line 140 of file primRange.h.

Constructor & Destructor Documentation

◆ iterator()

iterator ( EndSentinel  e)
inline

Allow implicit conversion from EndSentinel.

Definition at line 151 of file primRange.h.

Member Function Documentation

◆ IsPostVisit()

bool IsPostVisit ( ) const
inline

Return true if the iterator points to a prim visited the second time (in post order) for a pre- and post-order iterator, false otherwise.

Definition at line 157 of file primRange.h.

◆ operator!=() [1/2]

bool operator!= ( iterator const &  other) const
inline

Return true if this iterator is not equivalent to other.

Definition at line 180 of file primRange.h.

◆ operator!=() [2/2]

bool operator!= ( EndSentinel const &  other) const
inline

Return true if this iterator is not equivalent to other.

Definition at line 185 of file primRange.h.

◆ operator==() [1/2]

bool operator== ( iterator const &  other) const
inline

Return true if this iterator is equivalent to other.

Definition at line 165 of file primRange.h.

◆ operator==() [2/2]

bool operator== ( EndSentinel const &  other) const
inline

Return true if this iterator is equivalent to other.

Definition at line 175 of file primRange.h.

◆ PruneChildren()

USD_API void PruneChildren ( )

Behave as if the current prim has no children when next advanced.

Issue an error if this is a pre- and post-order iterator that IsPostVisit().


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