UsdPrimRange::iterator Class Reference

#include <primRange.h>

Inheritance diagram for UsdPrimRange::iterator:

Public Member Functions
	iterator ()
	iterator (EndSentinel e)
	Allow implicit conversion from EndSentinel. More...
bool	IsPostVisit () const
USD_API void	PruneChildren ()
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	hboost::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

UsdPrimRange::iterator::iterator ( void  )

inline

Definition at line 148 of file primRange.h.

UsdPrimRange::iterator::iterator ( EndSentinel  e )

inline

Allow implicit conversion from EndSentinel.

Definition at line 151 of file primRange.h.

Member Function Documentation

bool UsdPrimRange::iterator::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.

bool UsdPrimRange::iterator::operator!= ( iterator const &  other ) const

inline

Return true if this iterator is not equivalent to other.

Definition at line 180 of file primRange.h.

bool UsdPrimRange::iterator::operator!= ( EndSentinel const &  other ) const

inline

Return true if this iterator is not equivalent to other.

Definition at line 185 of file primRange.h.

bool UsdPrimRange::iterator::operator== ( iterator const &  other ) const

inline

Return true if this iterator is equivalent to other.

Definition at line 165 of file primRange.h.

bool UsdPrimRange::iterator::operator== ( EndSentinel const &  other ) const

inline

Return true if this iterator is equivalent to other.

Definition at line 175 of file primRange.h.

USD_API void UsdPrimRange::iterator::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().

Friends And Related Function Documentation

friend class hboost::iterator_core_access

friend

Definition at line 191 of file primRange.h.

friend class UsdPrimRange

friend

Definition at line 190 of file primRange.h.

---

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

• pxr/usd/usd/primRange.h