UsdPrimRange::iterator Class Reference

#include <primRange.h>

Public Types
using	iterator_category = std::forward_iterator_tag
using	value_type = UsdPrim
using	reference = UsdPrim
using	pointer = _PtrProxy
using	difference_type = std::ptrdiff_t

Public Member Functions
	iterator ()=default
	iterator (EndSentinel e)
	Allow implicit conversion from EndSentinel. More...
reference	operator* () const
pointer	operator-> () const
iterator &	operator++ ()
iterator	operator++ (int)
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

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 123 of file primRange.h.

Member Typedef Documentation

using UsdPrimRange::iterator::difference_type = std::ptrdiff_t

Definition at line 138 of file primRange.h.

using UsdPrimRange::iterator::iterator_category = std::forward_iterator_tag

Definition at line 134 of file primRange.h.

using UsdPrimRange::iterator::pointer = _PtrProxy

Definition at line 137 of file primRange.h.

using UsdPrimRange::iterator::reference = UsdPrim

Definition at line 136 of file primRange.h.

using UsdPrimRange::iterator::value_type = UsdPrim

Definition at line 135 of file primRange.h.

Constructor & Destructor Documentation

UsdPrimRange::iterator::iterator ( )

default

UsdPrimRange::iterator::iterator ( EndSentinel  e )

inline

Allow implicit conversion from EndSentinel.

Definition at line 143 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 163 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 187 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 192 of file primRange.h.

reference UsdPrimRange::iterator::operator* ( ) const

inline

Definition at line 147 of file primRange.h.

iterator& UsdPrimRange::iterator::operator++ ( )

inline

Definition at line 150 of file primRange.h.

iterator UsdPrimRange::iterator::operator++ ( int  )

inline

Definition at line 155 of file primRange.h.

pointer UsdPrimRange::iterator::operator-> ( ) const

inline

Definition at line 148 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 171 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 181 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 UsdPrimRange

friend

Definition at line 197 of file primRange.h.

---

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

• pxr/usd/usd/primRange.h