UsdPrimCompositionQuery Class Reference

#include <primCompositionQuery.h>

Classes
struct	Filter

Public Types
enum	ArcTypeFilter {   ArcTypeFilter::All = 0, ArcTypeFilter::Reference, ArcTypeFilter::Payload, ArcTypeFilter::Inherit,   ArcTypeFilter::Specialize, ArcTypeFilter::Variant, ArcTypeFilter::ReferenceOrPayload, ArcTypeFilter::InheritOrSpecialize,   ArcTypeFilter::NotReferenceOrPayload, ArcTypeFilter::NotInheritOrSpecialize, ArcTypeFilter::NotVariant }
	Choices for filtering composition arcs based on arc type. More...
enum	DependencyTypeFilter { DependencyTypeFilter::All = 0, DependencyTypeFilter::Direct, DependencyTypeFilter::Ancestral }
enum	ArcIntroducedFilter { ArcIntroducedFilter::All = 0, ArcIntroducedFilter::IntroducedInRootLayerStack, ArcIntroducedFilter::IntroducedInRootLayerPrimSpec }
enum	HasSpecsFilter { HasSpecsFilter::All = 0, HasSpecsFilter::HasSpecs, HasSpecsFilter::HasNoSpecs }

Public Member Functions
USD_API	UsdPrimCompositionQuery (const UsdPrim &prim, const Filter &filter=Filter())
	~UsdPrimCompositionQuery ()=default
USD_API void	SetFilter (const Filter &filter)
	Change the filter for this query. More...
USD_API Filter	GetFilter () const
	Return a copy of the current filter parameters. More...
USD_API std::vector < UsdPrimCompositionQueryArc >	GetCompositionArcs ()

Static Public Member Functions
static USD_API UsdPrimCompositionQuery	GetDirectReferences (const UsdPrim &prim)
static USD_API UsdPrimCompositionQuery	GetDirectInherits (const UsdPrim &prim)
static USD_API UsdPrimCompositionQuery	GetDirectRootLayerArcs (const UsdPrim &prim)

Detailed Description

Object for making optionally filtered composition queries about a prim. It creates a list of strength ordering UsdPrimCompositionQueryArc that can be filtered by a combination of criteria and returned.

Invalidation

This object does not listen for change notification. If a consumer is holding on to a UsdPrimCompositionQuery, it is their responsibility to dispose of it in response to a resync change to the associated prim. Failing to do so may result in incorrect values or crashes due to dereferencing invalid objects.

Definition at line 260 of file primCompositionQuery.h.

Member Enumeration Documentation

enum UsdPrimCompositionQuery::ArcIntroducedFilter

strong

Choices for filtering composition arcs based on where the arc is introduced.

Enumerator
All
IntroducedInRootLayerStack
IntroducedInRootLayerPrimSpec

Definition at line 298 of file primCompositionQuery.h.

enum UsdPrimCompositionQuery::ArcTypeFilter

strong

Choices for filtering composition arcs based on arc type.

Enumerator
All
Reference
Payload
Inherit
Specialize
Variant
ReferenceOrPayload
InheritOrSpecialize
NotReferenceOrPayload
NotInheritOrSpecialize
NotVariant

Definition at line 264 of file primCompositionQuery.h.

enum UsdPrimCompositionQuery::DependencyTypeFilter

strong

Choices for filtering composition arcs on dependency type. This can be direct (arc introduced at the prim's level in namespace) or ancestral (arc introduced by a namespace parent of the prim).

Enumerator
All
Direct
Ancestral

Definition at line 288 of file primCompositionQuery.h.

enum UsdPrimCompositionQuery::HasSpecsFilter

strong

Choices for filtering composition arcs on whether the node contributes specs to the prim.

Enumerator
All
HasSpecs
HasNoSpecs

Definition at line 313 of file primCompositionQuery.h.

Constructor & Destructor Documentation

USD_API UsdPrimCompositionQuery::UsdPrimCompositionQuery	(	const UsdPrim &	prim,
		const Filter &	filter = Filter()
	)

Create a prim composition query for the with the given option filter.

UsdPrimCompositionQuery::~UsdPrimCompositionQuery ( )

default

Member Function Documentation

USD_API std::vector<UsdPrimCompositionQueryArc> UsdPrimCompositionQuery::GetCompositionArcs

(

)

Return a list of composition arcs for this query's prim using the current query filter. The composition arcs are always returned in order from strongest to weakest regardless of the filter.

static USD_API UsdPrimCompositionQuery UsdPrimCompositionQuery::GetDirectInherits ( const UsdPrim &  prim )

static

Returns a prim composition query for the given prim with a preset filter that only returns inherit arcs that are not ancestral.

static USD_API UsdPrimCompositionQuery UsdPrimCompositionQuery::GetDirectReferences ( const UsdPrim &  prim )

static

Returns a prim composition query for the given prim with a preset filter that only returns reference arcs that are not ancestral.

static USD_API UsdPrimCompositionQuery UsdPrimCompositionQuery::GetDirectRootLayerArcs ( const UsdPrim &  prim )

static

Returns a prim composition query for the given prim with a preset filter that only returns direct arcs that were introduced by opinions defined in a layer in the root layer stack.

USD_API Filter UsdPrimCompositionQuery::GetFilter

(

)

const

Return a copy of the current filter parameters.

USD_API void UsdPrimCompositionQuery::SetFilter

(

const Filter &

filter

)

Change the filter for this query.

---

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

• pxr/usd/usd/primCompositionQuery.h