UsdResolveTarget Class Reference

#include <resolveTarget.h>

Public Member Functions
	UsdResolveTarget ()=default
const PcpPrimIndex *	GetPrimIndex () const
	Get the prim index of the resolve target. More...
USD_API PcpNodeRef	GetStartNode () const
USD_API SdfLayerHandle	GetStartLayer () const
USD_API PcpNodeRef	GetStopNode () const
USD_API SdfLayerHandle	GetStopLayer () const
bool	IsNull () const
	Returns true if this is a null resolve target. More...

Friends
class	UsdPrim
class	UsdPrimCompositionQueryArc
class	Usd_Resolver

Detailed Description

Defines a subrange of nodes and layers within a prim's prim index to consider when performing value resolution for the prim's attributes. A resolve target can then be passed to UsdAttributeQuery during its construction to have all of the queries made by the UsdAttributeQuery use the resolve target's subrange for their value resolution.

Resolve targets can be created via methods on UsdPrimCompositionQueryArc to to limit value resolution to a subrange of the prim's composed specs that are no stronger that arc, or a subrange of specs that is strictly stronger than that arc (optionally providing a particular layer within the arc's layer stack to further limit the range of specs).

Alternatively, resolve targets can also be created via methods on UsdPrim that can limit value resolution to either up to or stronger than the spec that would be edited when setting a value for the prim using the given UsdEditTarget.

Unlike UsdEditTarget, a UsdResolveTarget is only relevant to the prim it is created for and can only be used in a UsdAttributeQuery for attributes on this prim.

Invalidation

This object does not listen for change notification. If a consumer is holding on to a UsdResolveTarget, 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 73 of file resolveTarget.h.

Constructor & Destructor Documentation

UsdResolveTarget::UsdResolveTarget ( )

default

Member Function Documentation

const PcpPrimIndex* UsdResolveTarget::GetPrimIndex ( ) const

inline

Get the prim index of the resolve target.

Definition at line 79 of file resolveTarget.h.

USD_API SdfLayerHandle UsdResolveTarget::GetStartLayer

(

)

const

Returns the layer in the layer stack of the start node that value resolution with this resolve target will start at.

USD_API PcpNodeRef UsdResolveTarget::GetStartNode

(

)

const

Returns the node that value resolution with this resolve target will start at.

USD_API SdfLayerHandle UsdResolveTarget::GetStopLayer

(

)

const

Returns the layer in the layer stack of the stop node that value resolution with this resolve target will stop at.

USD_API PcpNodeRef UsdResolveTarget::GetStopNode

(

)

const

Returns the node that value resolution with this resolve target will stop at when the "stop at" layer is reached.

bool UsdResolveTarget::IsNull ( ) const

inline

Returns true if this is a null resolve target.

Definition at line 104 of file resolveTarget.h.

Friends And Related Function Documentation

friend class Usd_Resolver

friend

Definition at line 115 of file resolveTarget.h.

friend class UsdPrim

friend

Definition at line 111 of file resolveTarget.h.

friend class UsdPrimCompositionQueryArc

friend

Definition at line 112 of file resolveTarget.h.

---

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

• pxr/usd/usd/resolveTarget.h