All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdResolveInfo Class Reference

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

Public Member Functions

UsdResolveInfoSource GetSource () const
 Return the source of the associated attribute's value. More...
 
bool HasAuthoredValueOpinion () const
 Return true if this UsdResolveInfo represents an attribute that has an authored value opinion. More...
 
bool HasAuthoredValue () const
 Return true if this UsdResolveInfo represents an attribute that has an authored value that is not blocked. More...
 
PcpNodeRef GetNode () const
 Return the node within the containing PcpPrimIndex that provided the resolved value opinion. More...
 
bool ValueIsBlocked () const
 Return true if this UsdResolveInfo represents an attribute whose value is blocked. More...
 

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 69 of file resolveInfo.h.

Member Function Documentation

PcpNodeRef GetNode ( ) const
inline

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

Definition at line 110 of file resolveInfo.h.

UsdResolveInfoSource GetSource ( ) const
inline

Return the source of the associated attribute's value.

Definition at line 80 of file resolveInfo.h.

bool HasAuthoredValue ( ) const
inline

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

Definition at line 100 of file resolveInfo.h.

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 89 of file resolveInfo.h.

bool ValueIsBlocked ( ) const
inline

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

See Also
UsdAttribute::Block()

Definition at line 118 of file resolveInfo.h.


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