HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdGeomImageable::PurposeInfo Struct Reference

#include <imageable.h>

Public Member Functions

constexpr PurposeInfo ()=default
 
 PurposeInfo (const TfToken &purpose_, bool isInheritable_)
 
 operator bool () const
 Returns true if this represents a purpose that has been computed. More...
 
bool operator== (const PurposeInfo &rhs)
 
bool operator!= (const PurposeInfo &rhs)
 
const TfTokenGetInheritablePurpose () const
 Returns the purpose if it's inheritable, returns empty if it is not. More...
 

Public Attributes

TfToken purpose
 
bool isInheritable = false
 

Detailed Description

Value type containing information about a prim's computed effective purpose as well as storing whether the prim's purpose value can be inherited by namespace children if necessary. This provides the purpose information necessary for efficiently computing and caching the purposes of a hierarchy of prims.

See Also
GetPurposeAttr(), UsdGeom_ImageablePurpose

Definition at line 391 of file imageable.h.

Constructor & Destructor Documentation

constexpr UsdGeomImageable::PurposeInfo::PurposeInfo ( )
default
UsdGeomImageable::PurposeInfo::PurposeInfo ( const TfToken purpose_,
bool  isInheritable_ 
)
inline

Definition at line 394 of file imageable.h.

Member Function Documentation

const TfToken& UsdGeomImageable::PurposeInfo::GetInheritablePurpose ( ) const
inline

Returns the purpose if it's inheritable, returns empty if it is not.

Definition at line 417 of file imageable.h.

UsdGeomImageable::PurposeInfo::operator bool ( ) const
inlineexplicit

Returns true if this represents a purpose that has been computed.

Definition at line 406 of file imageable.h.

Definition at line 412 of file imageable.h.

bool UsdGeomImageable::PurposeInfo::operator== ( const PurposeInfo rhs)
inline

Definition at line 408 of file imageable.h.

Member Data Documentation

bool UsdGeomImageable::PurposeInfo::isInheritable = false

Whether this purpose should be inherited by namespace children that do not have their own authored purpose value.

Definition at line 403 of file imageable.h.

TfToken UsdGeomImageable::PurposeInfo::purpose

The computed purpose. An empty purpose indicates that this represents a purpose that hasn't been computed yet.

Definition at line 399 of file imageable.h.


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