sceneIndexUtil.h File Reference

#include "pxr/pxr.h"
#include "pxr/imaging/hd/sceneIndex.h"
#include "pxr/base/tf/envSetting.h"

Include dependency graph for sceneIndexUtil.h:

Go to the source code of this file.

Functions
HD_API HdSceneIndexBaseRefPtr	HdMakeEncapsulatingSceneIndex (const std::vector< HdSceneIndexBaseRefPtr > &inputScenes, HdSceneIndexBaseRefPtr const &encapsulatedScene)

Variables
PXR_NAMESPACE_OPEN_SCOPE HD_API TfEnvSetting< bool >	HD_USE_ENCAPSULATING_SCENE_INDICES

Function Documentation

HD_API HdSceneIndexBaseRefPtr HdMakeEncapsulatingSceneIndex	(	const std::vector< HdSceneIndexBaseRefPtr > &	inputScenes,
		HdSceneIndexBaseRefPtr const &	encapsulatedScene
	)

Make a scene index that encapsulates the given scene and (recursively) all its inputs until a given input scene is hit.

The resulting scene index is simply forwarding any calls to the given encapsulated scene index.

See HdEncapsulatingSceneIndexBase and HdFilteringSceneIndexBase for details.

The resulting scene index should be thought of one node in the nested scene index graph. The inputs of this node are the given input scenes. The terminal node in the graph internal to the resulting scene index is the given encapsulated scene index.

Variable Documentation

PXR_NAMESPACE_OPEN_SCOPE HD_API TfEnvSetting<bool> HD_USE_ENCAPSULATING_SCENE_INDICES

The open-source version of the Hydra Scene Browser cannot descend into HdEncapsulatingSceneIndexBase. Thus, we have an environment variable to disable the use HdEncapsulatingSceneIndexBase.