Loading...
Searching...
No Matches
Public Member Functions | Friends | List of all members
UsdResolveInfo Class Reference

Container for information about the source of an attribute's value, i.e. More...

#include <resolveInfo.h>

Public Member Functions

UsdResolveInfoSource GetSource () const
 Return the source of the associated attribute's value.
 
bool HasAuthoredValueOpinion () const
 Return true if this UsdResolveInfo represents an attribute that has an authored value opinion.
 
bool HasAuthoredValue () const
 Return true if this UsdResolveInfo represents an attribute that has an authored value that is not blocked.
 
PcpNodeRef GetNode () const
 Return the node within the containing PcpPrimIndex that provided the resolved value opinion.
 
bool ValueIsBlocked () const
 Return true if this UsdResolveInfo represents an attribute whose value is blocked.
 
bool ValueSourceMightBeTimeVarying () const
 Returns true if the resolve info source might be time-varying; false otherwise.
 

Friends

class UsdAttribute
 
class UsdStage
 
class UsdStage_ResolveInfoAccess
 
class UsdAttributeQuery
 

Detailed Description

Container for information about the source of an attribute's value, i.e.

the 'resolved' location of the attribute.

For more details, see TimeSamples, Defaults, and Value Resolution.

Definition at line 54 of file resolveInfo.h.

Constructor & Destructor Documentation

◆ UsdResolveInfo()

UsdResolveInfo ( )
inline

Definition at line 57 of file resolveInfo.h.

Member Function Documentation

◆ GetNode()

PcpNodeRef GetNode ( ) const
inline

Return the node within the containing PcpPrimIndex that provided the resolved value opinion.

Definition at line 94 of file resolveInfo.h.

◆ GetSource()

UsdResolveInfoSource GetSource ( ) const
inline

Return the source of the associated attribute's value.

Definition at line 64 of file resolveInfo.h.

◆ HasAuthoredValue()

bool HasAuthoredValue ( ) const
inline

Return true if this UsdResolveInfo represents an attribute that has an authored value that is not blocked.

Definition at line 84 of file resolveInfo.h.

◆ HasAuthoredValueOpinion()

bool HasAuthoredValueOpinion ( ) const
inline

Return true if this UsdResolveInfo represents an attribute that has an authored value opinion.

This will return true if there is any authored value opinion, including a block

This is equivalent to HasAuthoredValue() || ValueIsBlocked()

Definition at line 73 of file resolveInfo.h.

◆ ValueIsBlocked()

bool ValueIsBlocked ( ) const
inline

Return true if this UsdResolveInfo represents an attribute whose value is blocked.

See also
UsdAttribute::Block()

Definition at line 102 of file resolveInfo.h.

◆ ValueSourceMightBeTimeVarying()

bool ValueSourceMightBeTimeVarying ( ) const
inline

Returns true if the resolve info source might be time-varying; false otherwise.

Note that this is different from UsdAttribute::ValueMightBeTimeVarying() which provides more granular answer since it has additional context from the attribute itself.

Definition at line 112 of file resolveInfo.h.

Friends And Related Function Documentation

◆ UsdAttribute

friend class UsdAttribute
friend

Definition at line 174 of file resolveInfo.h.

◆ UsdAttributeQuery

friend class UsdAttributeQuery
friend

Definition at line 177 of file resolveInfo.h.

◆ UsdStage

friend class UsdStage
friend

Definition at line 175 of file resolveInfo.h.

◆ UsdStage_ResolveInfoAccess

friend class UsdStage_ResolveInfoAccess
friend

Definition at line 176 of file resolveInfo.h.

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