24 #ifndef PXR_USD_USD_PRIM_COMPOSITION_QUERY_H
25 #define PXR_USD_USD_PRIM_COMPOSITION_QUERY_H
30 #include "pxr/usd/usd/api.h"
33 #include "pxr/usd/pcp/node.h"
34 #include "pxr/usd/pcp/primIndex.h"
36 PXR_NAMESPACE_OPEN_SCOPE
157 std::string *name)
const;
244 NotReferenceOrPayload,
245 NotInheritOrSpecialize,
268 IntroducedInRootLayerStack,
272 IntroducedInRootLayerPrimSpec
303 bool operator==(
const Filter &rhs) {
310 bool operator!=(
const Filter &rhs) {
311 return !(*
this == rhs);
335 const Filter &filter = Filter());
357 std::vector<UsdPrimCompositionQueryArc> _unfilteredArcs;
361 PXR_NAMESPACE_CLOSE_SCOPE
363 #endif // PXR_USD_USD_PRIM_COMPOSITION_QUERY_H
This represents a composition arc that is returned by a UsdPrimCompositionQuery.
USD_API bool GetIntroducingListEditor(SdfReferenceEditorProxy *editor, SdfReference *ref) const
Gets the list editor and authored SdfReference value that introduces this arc to the composition grap...
PcpPrimIndex is an index of the all sites of scene description that contribute opinions to a specific...
Represents a set of list editing operations.
PcpNode represents a node in an expression tree for compositing scene description.
USD_API PcpArcType GetArcType() const
Returns the arc type.
HasSpecsFilter
Choices for filtering composition arcs on whether the node contributes specs to the prim...
DependencyTypeFilter dependencyTypeFilter
Filters by dependency type, direct or ancestral.
USD_API void SetFilter(const Filter &filter)
Change the filter for this query.
USD_API PcpNodeRef GetIntroducingNode() const
Returns the node that introduces this arc into composition graph.
static USD_API UsdPrimCompositionQuery GetDirectReferences(const UsdPrim &prim)
Returns a prim composition query for the given prim with a preset filter that only returns reference ...
ArcTypeFilter
Choices for filtering composition arcs based on arc type.
static USD_API UsdPrimCompositionQuery GetDirectInherits(const UsdPrim &prim)
Returns a prim composition query for the given prim with a preset filter that only returns inherit ar...
USD_API bool IsAncestral() const
Returns whether this arc is ancestral, i.e.
USD_API std::vector< UsdPrimCompositionQueryArc > GetCompositionArcs()
Return a list of composition arcs for this query's prim using the current query filter.
USD_API bool IsImplicit() const
Returns whether this arc was implicitly added to this prim meaning it exists because of the introduct...
Represents a payload and all its meta data.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
ArcIntroducedFilter
Choices for filtering composition arcs based on where the arc is introduced.
ArcTypeFilter arcTypeFilter
Filters by arc type.
USD_API SdfPath GetIntroducingPrimPath() const
Returns the path of the prim that introduces this arc to the composition graph within the layer in wh...
A path value used to locate objects in layers or scenegraphs.
DependencyTypeFilter
Choices for filtering composition arcs on dependency type.
USD_API bool IsIntroducedInRootLayerPrimSpec() const
Returns whether the composition opinion that introduces this arc is authored directly on the prim's p...
Object for making optionally filtered composition queries about a prim.
Represents a reference and all its meta data.
Aggregate filter for filtering composition arcs by the previously defined criteria.
USD_API bool HasSpecs() const
Returns whether the target node of this arc contributes any local spec opinions that are composed for...
static USD_API UsdPrimCompositionQuery GetDirectRootLayerArcs(const UsdPrim &prim)
Returns a prim composition query for the given prim with a preset filter that only returns direct arc...
HasSpecsFilter hasSpecsFilter
Filters by whether the arc provides specs for the prim.
USD_API bool IsIntroducedInRootLayerStack() const
Returns whether the composition opinion that introduces this arc is authored in the root layer stack...
ArcIntroducedFilter arcIntroducedFilter
Filters by where the arc is introduced.
USD_API SdfLayerHandle GetIntroducingLayer() const
Returns the specific layer in the layer stack that adds this arc to the composition graph...
USD_API Filter GetFilter() const
Return a copy of the current filter parameters.
USD_API UsdPrimCompositionQuery(const UsdPrim &prim, const Filter &filter=Filter())
Create a prim composition query for the with the given option filter.
USD_API PcpNodeRef GetTargetNode() const
Returns the targeted node of this composition arc.
PcpArcType
Describes the type of arc connecting two nodes in the prim index.