UsdNotice::ObjectsChanged::PathRange Class Reference

An iterable range of paths to objects that have changed. More...

Public Types

using const_iterator = iterator
 

Public Member Functions

 operator SdfPathVector () const
 Explicit conversion to SdfPathVector for convenience. More...
 
bool empty () const
 Return true if this range contains any paths, false otherwise. More...
 
size_t size () const
 Return the number of paths in this range. More...
 
iterator begin () const
 Return iterator to the start of this range. More...
 
const_iterator cbegin () const
 Return iterator to the start of this range. More...
 
iterator end () const
 Return the end iterator for this range. More...
 
const_iterator cend () const
 Return the end iterator for this range. More...
 
const_iterator find (const SdfPath &path) const
 Return an iterator to the specified path in this range if it exists, or end() if it does not. More...
 

Friends

class ObjectsChanged
 

Detailed Description

An iterable range of paths to objects that have changed.

Users may use this object in range-based for loops, or use the iterators to access additional information about each changed object.

Definition at line 146 of file notice.h.

Member Function Documentation

◆ begin()

iterator begin ( ) const
inline

Return iterator to the start of this range.

Definition at line 203 of file notice.h.

◆ cbegin()

const_iterator cbegin ( ) const
inline

Return iterator to the start of this range.

Definition at line 208 of file notice.h.

◆ cend()

const_iterator cend ( ) const
inline

Return the end iterator for this range.

Definition at line 218 of file notice.h.

◆ empty()

bool empty ( ) const
inline

Return true if this range contains any paths, false otherwise.

Definition at line 193 of file notice.h.

◆ end()

iterator end ( ) const
inline

Return the end iterator for this range.

Definition at line 213 of file notice.h.

◆ find()

const_iterator find ( const SdfPath path) const
inline

Return an iterator to the specified path in this range if it exists, or end() if it does not.

This is potentially more efficient than std::find(begin(), end()).

Definition at line 225 of file notice.h.

◆ operator SdfPathVector()

operator SdfPathVector ( ) const
inlineexplicit

Explicit conversion to SdfPathVector for convenience.

Definition at line 188 of file notice.h.

◆ size()

size_t size ( ) const
inline

Return the number of paths in this range.

Definition at line 198 of file notice.h.


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