Evaluates SdfPathExpressions with objects from a given UsdStage. More...

#include <collectionMembershipQuery.h>

Public Types
using	PathExprEval = SdfPathExpressionEval< UsdObject >

using	IncrementalSearcher = typename PathExprEval::IncrementalSearcher< PathToObj >

Public Member Functions
	UsdObjectCollectionExpressionEvaluator ()=default
	Construct an empty evaluator.

USD_API	UsdObjectCollectionExpressionEvaluator (UsdStageWeakPtr const &stage, SdfPathExpression const &expr)
	Construct an evaluator that evalutates `expr` on objects from `stage`.

bool	IsEmpty () const
	Return true if this evaluator has an invalid stage or an empty underlying SdfPathExpressionEval object.

UsdStageWeakPtr const &	GetStage () const
	Return the stage this object was constructed with, or nullptr if it was default constructed.

USD_API SdfPredicateFunctionResult	Match (SdfPath const &path) const
	Return the result of evaluating the expression against `path`.

USD_API SdfPredicateFunctionResult	Match (UsdObject const &object) const
	Return the result of evaluating the expression against `object`.

USD_API IncrementalSearcher	MakeIncrementalSearcher () const
	Create an incremental searcher from this evaluator.

Detailed Description

Evaluates SdfPathExpressions with objects from a given UsdStage.

Definition at line 352 of file collectionMembershipQuery.h.

Member Typedef Documentation

◆ IncrementalSearcher

using IncrementalSearcher = typename PathExprEval::IncrementalSearcher<PathToObj>

Definition at line 362 of file collectionMembershipQuery.h.

◆ PathExprEval

using PathExprEval = SdfPathExpressionEval<UsdObject>

Definition at line 361 of file collectionMembershipQuery.h.

Constructor & Destructor Documentation

◆ UsdObjectCollectionExpressionEvaluator() [1/2]

UsdObjectCollectionExpressionEvaluator ( )

default

Construct an empty evaluator.

◆ UsdObjectCollectionExpressionEvaluator() [2/2]

USD_API UsdObjectCollectionExpressionEvaluator	(	UsdStageWeakPtr const &	stage,
		SdfPathExpression const &	expr
	)

Construct an evaluator that evalutates expr on objects from stage.

The expr must be "complete" (see SdfPathExpression::IsComplete()).

Typically these objects are not constructed directly, but instead are created by UsdCollectionAPI::ComputeMembershipQuery() for Usd_CollectionMembershipQuery's use. However it is possible to construct them directly if one wishes. Consider calling UsdCollectionAPI::ResolveCompleteMembershipExpression() to produce an approprate expression.

Member Function Documentation

◆ GetStage()

UsdStageWeakPtr const & GetStage ( ) const

inline

Return the stage this object was constructed with, or nullptr if it was default constructed.

Definition at line 390 of file collectionMembershipQuery.h.

◆ IsEmpty()

bool IsEmpty ( ) const

inline

Return true if this evaluator has an invalid stage or an empty underlying SdfPathExpressionEval object.

Definition at line 384 of file collectionMembershipQuery.h.

◆ MakeIncrementalSearcher()

USD_API IncrementalSearcher MakeIncrementalSearcher ( ) const

Create an incremental searcher from this evaluator.

See SdfPathExpressionEval::IncrementalSearcher for more info and API.

The returned IncrementalSearcher refers to the evaluator object owned by this UsdObjectCollectionExpressionEvaluator object. This means that the IncrementalSearcher must not be used after this UsdObjectCollectionExpressionEvaluator object's lifetime ends.

◆ Match() [1/2]

USD_API SdfPredicateFunctionResult Match ( SdfPath const & path ) const

Return the result of evaluating the expression against path.

◆ Match() [2/2]

USD_API SdfPredicateFunctionResult Match ( UsdObject const & object ) const

Return the result of evaluating the expression against object.

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

pxr/usd/usd/collectionMembershipQuery.h

Public Types

Public Member Functions