HdSceneIndexPrimView Class Reference

#include <sceneIndexPrimView.h>

Classes
class	const_iterator

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();
     }
}

Definition at line 64 of file sceneIndexPrimView.h.

Constructor & Destructor Documentation

HD_API HdSceneIndexPrimView::HdSceneIndexPrimView

(

HdSceneIndexBaseRefPtr const &

inputSceneIndex

)

HD_API HdSceneIndexPrimView::HdSceneIndexPrimView	(	HdSceneIndexBaseRefPtr const &	inputSceneIndex,
		const SdfPath &	root
	)

Member Function Documentation

HD_API const const_iterator& HdSceneIndexPrimView::begin

(

)

const

HD_API const const_iterator& HdSceneIndexPrimView::end

(

)

const

---

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

• pxr/imaging/hd/sceneIndexPrimView.h