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
HdSceneIndexPrimView Class Reference

A range to iterate over all descendants of a given prim (including the prim itself) in a scene index in depth-first order. More...

#include <sceneIndexPrimView.h>

Public Member Functions

HD_API HdSceneIndexPrimView (HdSceneIndexBaseRefPtr const &inputSceneIndex)
 
HD_API HdSceneIndexPrimView (HdSceneIndexBaseRefPtr const &inputSceneIndex, const SdfPath &root)
 
HD_API const const_iterator & begin () const
 
HD_API const const_iterator & end () const
 

Detailed Description

A range to iterate over all descendants of a given prim (including the prim itself) in a scene index in depth-first order.

The descendants of the current prim can be skipped by calling SkipDescendants.

Example:

for (const SdfPath &primPath :
HdSceneIndexPrimView(mySceneIndex, myRootPath)) {
...
}
HdSceneIndexPrimView view(mySceneIndex, myRootPath);
for (auto it = view.begin(); it != view.end(); ++it) {
const SdfPath &primPath = *it;
...
if (_ShouldSkipDescendants(primPath)) {
it.SkipDescendants();
}
}
A range to iterate over all descendants of a given prim (including the prim itself) in a scene index ...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274

Definition at line 47 of file sceneIndexPrimView.h.


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