collectionMembershipQuery.h File Reference

#include "pxr/base/tf/declarePtrs.h"
#include "pxr/pxr.h"
#include "pxr/usd/sdf/path.h"
#include "pxr/usd/usd/common.h"
#include "pxr/usd/usd/primFlags.h"
#include <unordered_map>

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	UsdCollectionMembershipQuery
	Represents a flattened view of a collection. For more information about collections, please see UsdCollectionAPI as a way to encode and retrieve a collection from scene description. A UsdCollectionMembershipQuery object can be used to answer queries about membership of paths in the collection efficiently. More...
struct	UsdCollectionMembershipQuery::Hash
	Hash functor. More...

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

Function Documentation

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.

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.