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

#include <resolveInfo.h>

Public Member Functions

 UsdResolveInfo ()
 
UsdResolveInfoSource GetSource () const
 Return the source of the associated attribute's value. More...
 
bool HasAuthoredValueOpinion () const
 
bool HasAuthoredValue () const
 
PcpNodeRef GetNode () const
 
bool ValueIsBlocked () const
 

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 Usd_ValueResolution.

Definition at line 68 of file resolveInfo.h.

Constructor & Destructor Documentation

UsdResolveInfo::UsdResolveInfo ( )
inline

Definition at line 71 of file resolveInfo.h.

Member Function Documentation

PcpNodeRef UsdResolveInfo::GetNode ( ) const
inline

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

Definition at line 106 of file resolveInfo.h.

UsdResolveInfoSource UsdResolveInfo::GetSource ( ) const
inline

Return the source of the associated attribute's value.

Definition at line 78 of file resolveInfo.h.

bool UsdResolveInfo::HasAuthoredValue ( ) const
inline

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

Definition at line 97 of file resolveInfo.h.

bool UsdResolveInfo::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 87 of file resolveInfo.h.

bool UsdResolveInfo::ValueIsBlocked ( ) const
inline

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

See Also
UsdAttribute::Block()

Definition at line 114 of file resolveInfo.h.

Friends And Related Function Documentation

friend class UsdAttribute
friend

Definition at line 169 of file resolveInfo.h.

friend class UsdAttributeQuery
friend

Definition at line 172 of file resolveInfo.h.

friend class UsdStage
friend

Definition at line 170 of file resolveInfo.h.

friend class UsdStage_ResolveInfoAccess
friend

Definition at line 171 of file resolveInfo.h.


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