All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
collectionMembershipQuery.h File Reference
+ Include dependency graph for collectionMembershipQuery.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes

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

Macros

#define USD_COLLECTION_MEMBERSHIP_QUERY_TOKENS
 

Typedefs

using UsdCollectionMembershipQuery = Usd_CollectionMembershipQuery< UsdObjectCollectionExpressionEvaluator >
 

Functions

 TF_DECLARE_PUBLIC_TOKENS (UsdCollectionMembershipQueryTokens, USD_API, USD_COLLECTION_MEMBERSHIP_QUERY_TOKENS)
 
USD_API SdfPathExpression UsdComputePathExpressionFromCollectionMembershipQueryRuleMap (Usd_CollectionMembershipQueryBase::PathExpansionRuleMap const &ruleMap)
 Compute an SdfPathExpression that matches the same paths as ruleMap.
 
USD_API std::set< UsdObjectUsdComputeIncludedObjectsFromCollection (const UsdCollectionMembershipQuery &query, const UsdStageWeakPtr &stage, const Usd_PrimFlagsPredicate &pred=UsdPrimDefaultPredicate)
 Returns all the usd objects that satisfy the predicate, pred in the collection represented by the UsdCollectionMembershipQuery object, query.
 
USD_API SdfPathSet UsdComputeIncludedPathsFromCollection (const UsdCollectionMembershipQuery &query, const UsdStageWeakPtr &stage, const Usd_PrimFlagsPredicate &pred=UsdPrimDefaultPredicate)
 Returns all the paths that satisfy the predicate, pred in the collection represented by the UsdCollectionMembershipQuery object, query.
 

Macro Definition Documentation

◆ USD_COLLECTION_MEMBERSHIP_QUERY_TOKENS

#define USD_COLLECTION_MEMBERSHIP_QUERY_TOKENS
Value:
(IncludedByMembershipExpression) \
(ExcludedByMembershipExpression)

Definition at line 29 of file collectionMembershipQuery.h.

Typedef Documentation

◆ UsdCollectionMembershipQuery

Definition at line 400 of file collectionMembershipQuery.h.

Function Documentation

◆ UsdComputeIncludedObjectsFromCollection()

USD_API std::set< UsdObject > UsdComputeIncludedObjectsFromCollection ( const UsdCollectionMembershipQuery query,
const UsdStageWeakPtr &  stage,
const Usd_PrimFlagsPredicate &  pred = UsdPrimDefaultPredicate 
)

Returns all the usd objects that satisfy the predicate, pred in the collection represented by the UsdCollectionMembershipQuery object, query.

The results depends on the load state of the UsdStage, stage.

◆ UsdComputeIncludedPathsFromCollection()

USD_API SdfPathSet UsdComputeIncludedPathsFromCollection ( const UsdCollectionMembershipQuery query,
const UsdStageWeakPtr &  stage,
const Usd_PrimFlagsPredicate &  pred = UsdPrimDefaultPredicate 
)

Returns all the paths that satisfy the predicate, pred in the collection represented by the UsdCollectionMembershipQuery object, query.

The result depends on the load state of the UsdStage, stage.

◆ UsdComputePathExpressionFromCollectionMembershipQueryRuleMap()

USD_API SdfPathExpression UsdComputePathExpressionFromCollectionMembershipQueryRuleMap ( Usd_CollectionMembershipQueryBase::PathExpansionRuleMap const &  ruleMap)

Compute an SdfPathExpression that matches the same paths as ruleMap.

The resulting SdfPathExpression is always complete (see SdfPathExpression::IsComplete()) and never contains predicates.