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

#include <imageable.h>

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

Public Attributes
TfToken	purpose
	The computed purpose.
bool	isInheritable = false
	Whether this purpose should be inherited by namespace children that do not have their own authored purpose value.

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 400 of file imageable.h.

Constructor & Destructor Documentation

PurposeInfo()

PurposeInfo ( const TfToken &  purpose_, bool  isInheritable_  )

inline

Definition at line 403 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 426 of file imageable.h.

operator bool()

operator bool ( ) const

inlineexplicit

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

Definition at line 415 of file imageable.h.

operator!=()

bool operator!= ( const PurposeInfo &  rhs )

inline

Definition at line 421 of file imageable.h.

operator==()

bool operator== ( const PurposeInfo &  rhs )

inline

Definition at line 417 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 412 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 408 of file imageable.h.

---

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

• pxr/usd/usdGeom/imageable.h