This document is for a version of USD that is under development. See this page for the current release.
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
PcpNodeIterator Class Reference

Object used to iterate over nodes in the prim index graph in strong-to-weak order. More...

#include <iterator.h>

Public Types

using iterator_category = std::random_access_iterator_tag
 
using value_type = PcpNodeRef
 
using reference = PcpNodeRef
 
using pointer = _PtrProxy
 
using difference_type = std::ptrdiff_t
 

Public Member Functions

 PcpNodeIterator ()=default
 Constructs an invalid iterator.
 
Pcp_CompressedSdSite GetCompressedSdSite (size_t layerIndex) const
 
reference operator* () const
 
pointer operator-> () const
 
reference operator[] (const difference_type index) const
 
difference_type operator- (const PcpNodeIterator &other) const
 
PcpNodeIteratoroperator++ ()
 
PcpNodeIteratoroperator-- ()
 
PcpNodeIterator operator++ (int)
 
PcpNodeIterator operator-- (int)
 
PcpNodeIterator operator+ (const difference_type increment) const
 
PcpNodeIterator operator- (const difference_type decrement) const
 
PcpNodeIteratoroperator+= (const difference_type increment)
 
PcpNodeIteratoroperator-= (const difference_type decrement)
 
bool operator== (const PcpNodeIterator &other) const
 
bool operator!= (const PcpNodeIterator &other) const
 
bool operator< (const PcpNodeIterator &other) const
 
bool operator<= (const PcpNodeIterator &other) const
 
bool operator> (const PcpNodeIterator &other) const
 
bool operator>= (const PcpNodeIterator &other) const
 

Friends

class PcpPrimIndex
 

Detailed Description

Object used to iterate over nodes in the prim index graph in strong-to-weak order.

Definition at line 33 of file iterator.h.

Member Typedef Documentation

◆ difference_type

using difference_type = std::ptrdiff_t

Definition at line 48 of file iterator.h.

◆ iterator_category

using iterator_category = std::random_access_iterator_tag

Definition at line 44 of file iterator.h.

◆ pointer

using pointer = _PtrProxy

Definition at line 47 of file iterator.h.

◆ reference

Definition at line 46 of file iterator.h.

◆ value_type

Definition at line 45 of file iterator.h.

Constructor & Destructor Documentation

◆ PcpNodeIterator()

PcpNodeIterator ( )
default

Constructs an invalid iterator.

Member Function Documentation

◆ GetCompressedSdSite()

Pcp_CompressedSdSite GetCompressedSdSite ( size_t  layerIndex) const
inline

Definition at line 54 of file iterator.h.

◆ operator!=()

bool operator!= ( const PcpNodeIterator other) const
inline

Definition at line 119 of file iterator.h.

◆ operator*()

reference operator* ( ) const
inline

Definition at line 59 of file iterator.h.

◆ operator+()

PcpNodeIterator operator+ ( const difference_type  increment) const
inline

Definition at line 93 of file iterator.h.

◆ operator++() [1/2]

PcpNodeIterator & operator++ ( )
inline

Definition at line 71 of file iterator.h.

◆ operator++() [2/2]

PcpNodeIterator operator++ ( int  )
inline

Definition at line 81 of file iterator.h.

◆ operator+=()

PcpNodeIterator & operator+= ( const difference_type  increment)
inline

Definition at line 105 of file iterator.h.

◆ operator-() [1/2]

PcpNodeIterator operator- ( const difference_type  decrement) const
inline

Definition at line 99 of file iterator.h.

◆ operator-() [2/2]

difference_type operator- ( const PcpNodeIterator other) const
inline

Definition at line 67 of file iterator.h.

◆ operator--() [1/2]

PcpNodeIterator & operator-- ( )
inline

Definition at line 76 of file iterator.h.

◆ operator--() [2/2]

PcpNodeIterator operator-- ( int  )
inline

Definition at line 87 of file iterator.h.

◆ operator-=()

PcpNodeIterator & operator-= ( const difference_type  decrement)
inline

Definition at line 110 of file iterator.h.

◆ operator->()

pointer operator-> ( ) const
inline

Definition at line 60 of file iterator.h.

◆ operator<()

bool operator< ( const PcpNodeIterator other) const
inline

Definition at line 123 of file iterator.h.

◆ operator<=()

bool operator<= ( const PcpNodeIterator other) const
inline

Definition at line 128 of file iterator.h.

◆ operator==()

bool operator== ( const PcpNodeIterator other) const
inline

Definition at line 115 of file iterator.h.

◆ operator>()

bool operator> ( const PcpNodeIterator other) const
inline

Definition at line 133 of file iterator.h.

◆ operator>=()

bool operator>= ( const PcpNodeIterator other) const
inline

Definition at line 138 of file iterator.h.

◆ operator[]()

reference operator[] ( const difference_type  index) const
inline

Definition at line 61 of file iterator.h.

Friends And Related Function Documentation

◆ PcpPrimIndex

friend class PcpPrimIndex
friend

Definition at line 144 of file iterator.h.


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