Loading...
Searching...
No Matches
UsdPrimRange::iterator Class Reference

A forward iterator into a UsdPrimRange. More...

#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 (EndSentinel e)
 Allow implicit conversion from EndSentinel.
 
reference operator* () const
 
pointer operator-> () const
 
iteratoroperator++ ()
 
iterator operator++ (int)
 
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.
 
USD_API void PruneChildren ()
 Behave as if the current prim has no children when next advanced.
 
bool operator== (iterator const &other) const
 Return true if this iterator is equivalent to other.
 
bool operator== (EndSentinel const &other) const
 Return true if this iterator is equivalent to other.
 
bool operator!= (iterator const &other) const
 Return true if this iterator is not equivalent to other.
 
bool operator!= (EndSentinel const &other) const
 Return true if this iterator is not equivalent to other.
 

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

Member Typedef Documentation

◆ difference_type

using difference_type = std::ptrdiff_t

Definition at line 155 of file primRange.h.

◆ iterator_category

using iterator_category = std::forward_iterator_tag

Definition at line 151 of file primRange.h.

◆ pointer

using pointer = _PtrProxy

Definition at line 154 of file primRange.h.

◆ reference

using reference = UsdPrim

Definition at line 153 of file primRange.h.

◆ value_type

Definition at line 152 of file primRange.h.

Constructor & Destructor Documentation

◆ iterator()

iterator ( EndSentinel  e)
inline

Allow implicit conversion from EndSentinel.

Definition at line 160 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 180 of file primRange.h.

◆ operator!=() [1/2]

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

Return true if this iterator is not equivalent to other.

Definition at line 209 of file primRange.h.

◆ operator!=() [2/2]

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

Return true if this iterator is not equivalent to other.

Definition at line 204 of file primRange.h.

◆ operator*()

reference operator* ( ) const
inline

Definition at line 164 of file primRange.h.

◆ operator++() [1/2]

iterator & operator++ ( )
inline

Definition at line 167 of file primRange.h.

◆ operator++() [2/2]

iterator operator++ ( int  )
inline

Definition at line 172 of file primRange.h.

◆ operator->()

pointer operator-> ( ) const
inline

Definition at line 165 of file primRange.h.

◆ operator==() [1/2]

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

Return true if this iterator is equivalent to other.

Definition at line 198 of file primRange.h.

◆ operator==() [2/2]

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

Return true if this iterator is equivalent to other.

Definition at line 188 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().

Friends And Related Function Documentation

◆ UsdPrimRange

friend class UsdPrimRange
friend

Definition at line 214 of file primRange.h.


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