UsdGeomImageable::PurposeInfo Struct Reference

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

Public Member Functions

 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
 The computed purpose. More...
 
bool isInheritable = false
 Whether this purpose should be inherited by namespace children that do not have their own authored purpose value. More...
 

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(), Imageable Purpose

Definition at line 427 of file imageable.h.

Member Function Documentation

◆ GetInheritablePurpose()

const TfToken& GetInheritablePurpose ( ) const
inline

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

Definition at line 453 of file imageable.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

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

Definition at line 442 of file imageable.h.

Member Data Documentation

◆ isInheritable

bool isInheritable = false

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

Definition at line 439 of file imageable.h.

◆ purpose

TfToken purpose

The computed purpose.

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

Definition at line 435 of file imageable.h.


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