utils.h File Reference

#include "pxr/pxr.h"
#include "pxr/imaging/hdsi/api.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/base/tf/declarePtrs.h"
#include "pxr/base/tf/token.h"
#include <optional>

Include dependency graph for utils.h:

Go to the source code of this file.

Functions
PXR_NAMESPACE_OPEN_SCOPE	TF_DECLARE_WEAK_AND_REF_PTRS (HdSceneIndexBase)
HDSI_API void	HdsiUtilsCompileCollection (HdCollectionsSchema &collections, TfToken const &collectionName, HdSceneIndexBaseRefPtr const &sceneIndex, SdfPathExpression *expr, std::optional< HdCollectionExpressionEvaluator > *eval)
HDSI_API bool	HdsiUtilsIsPruned (const SdfPath &primPath, const HdCollectionExpressionEvaluator &eval)
HDSI_API void	HdsiUtilsRemovePrunedChildren (const SdfPath &parentPath, const HdCollectionExpressionEvaluator &eval, SdfPathVector *children)
	Prunes the given list of children using the supplied evaluator. More...
HDSI_API SdfPath	HdsiUtilsGetBoundMaterial (const HdSceneIndexPrim &prim)

Function Documentation

HDSI_API void HdsiUtilsCompileCollection	(	HdCollectionsSchema &	collections,
		TfToken const &	collectionName,
		HdSceneIndexBaseRefPtr const &	sceneIndex,
		SdfPathExpression *	expr,
		std::optional< HdCollectionExpressionEvaluator > *	eval
	)

---

General use collection utilities.

Extracts and compiles the membership expression of the collection with the given collectionName, if it exists.

HDSI_API SdfPath HdsiUtilsGetBoundMaterial

(

const HdSceneIndexPrim &

prim

)

---

Utilities for working with materials

Returns the path of the material bound to prim for the 'full' or 'allPurpose' purposes (whichever is found first).

If no material is bound to this prim for either of those purposes, an empty path is returned.

HDSI_API bool HdsiUtilsIsPruned	(	const SdfPath &	primPath,
		const HdCollectionExpressionEvaluator &	eval
	)

---

Utilities to evaluate membership expressions for collections with pruning

semantics.

Returns whether the prim at primPath is pruned by the suppied evaluator.

HDSI_API void HdsiUtilsRemovePrunedChildren	(	const SdfPath &	parentPath,
		const HdCollectionExpressionEvaluator &	eval,
		SdfPathVector *	children
	)

Prunes the given list of children using the supplied evaluator.

PXR_NAMESPACE_OPEN_SCOPE TF_DECLARE_WEAK_AND_REF_PTRS

(

HdSceneIndexBase

)