Loading...
Searching...
No Matches
Public Member Functions | Static Protected Member Functions | List of all members
UsdUIObjectHints Class Reference

A "schema-like" wrapper that provides API for retrieving and authoring UI hint values within the uiHints dictionary field on a UsdObject instance. More...

#include <objectHints.h>

+ Inheritance diagram for UsdUIObjectHints:

Public Member Functions

USDUI_API UsdUIObjectHints ()
 Default constructor that creates an invalid hints object.
 
USDUI_API UsdUIObjectHints (const UsdObject &obj)
 Construct a hints object for the given UsdObject obj.
 
UsdObject GetObject () const
 Return the object that this hints intance is interpreting.
 
USDUI_API std::string GetDisplayName () const
 Return the object's display name, indicating how it should appear in the UI.
 
USDUI_API bool SetDisplayName (const std::string &name)
 Set the object's display name to name.
 
USDUI_API bool GetHidden () const
 Return the object's hidden status, indicating whether or not it should be hidden from the UI.
 
USDUI_API bool SetHidden (bool hidden)
 Set the object's hidden status to hidden.
 
 operator bool () const
 Return true if this hints object is valid.
 
bool operator== (const UsdUIObjectHints &rhs) const
 Equality operator.
 
bool operator!= (const UsdUIObjectHints &rhs) const
 Inequality operator.
 

Static Protected Member Functions

static USDUI_API TfToken _MakeKeyPath (const TfToken &key1, const TfToken &key2)
 Combine key1 and key2 into a single token, separated by the namespace delimiter ':'.
 

Detailed Description

A "schema-like" wrapper that provides API for retrieving and authoring UI hint values within the uiHints dictionary field on a UsdObject instance.

UsdUIObjectHints is "schema-like" in that it interprets fields belonging to a core object type (in this case UsdObject, but see also UsdUIPrimHints, UsdUIPropertyHints, and UsdUIAttributeHints), and provides convenient API for using those fields. However, it is not formally a schema and does not derive from UsdSchemaBase.

See UI Hints for an overview of UI hints.

Definition at line 59 of file objectHints.h.

Constructor & Destructor Documentation

◆ UsdUIObjectHints() [1/2]

USDUI_API UsdUIObjectHints ( )

Default constructor that creates an invalid hints object.

Calling "set" operations on this object will post errors. "Get" operations will return fallback values.

◆ UsdUIObjectHints() [2/2]

USDUI_API UsdUIObjectHints ( const UsdObject &  obj)
explicit

Construct a hints object for the given UsdObject obj.

Member Function Documentation

◆ _MakeKeyPath()

static USDUI_API TfToken _MakeKeyPath ( const TfToken &  key1,
const TfToken &  key2 
)
staticprotected

Combine key1 and key2 into a single token, separated by the namespace delimiter ':'.

◆ GetDisplayName()

USDUI_API std::string GetDisplayName ( ) const

Return the object's display name, indicating how it should appear in the UI.

Backwards compatibility note: If no display name is stored in the object's uiHints dictionary, the value of UsdObject::GetDisplayName (which has been deprecated) will be returned. This fallback behavior is temporary, and will be removed in a future release.

◆ GetHidden()

USDUI_API bool GetHidden ( ) const

Return the object's hidden status, indicating whether or not it should be hidden from the UI.

Backwards compatibility note: If no hidden status is stored in the object's uiHints dictionary, the value of UsdObject::GetHidden (which has been deprecated) will be returned. This fallback behavior is temporary, and will be removed in a future release.

◆ GetObject()

UsdObject GetObject ( ) const
inline

Return the object that this hints intance is interpreting.

Definition at line 74 of file objectHints.h.

◆ operator bool()

operator bool ( ) const
inlineexplicit

Return true if this hints object is valid.

Definition at line 114 of file objectHints.h.

◆ operator!=()

bool operator!= ( const UsdUIObjectHints &  rhs) const
inline

Inequality operator.

Definition at line 124 of file objectHints.h.

◆ operator==()

bool operator== ( const UsdUIObjectHints &  rhs) const
inline

Equality operator.

Definition at line 119 of file objectHints.h.

◆ SetDisplayName()

USDUI_API bool SetDisplayName ( const std::string &  name)

Set the object's display name to name.

Return true if successful.

Backwards compatibility note: this function always writes to the uiHints dictionary. It does not call UsdObject::SetDisplayName, which has been deprecated.

◆ SetHidden()

USDUI_API bool SetHidden ( bool  hidden)

Set the object's hidden status to hidden.

Return true if successful.

Backwards compatibility note: this function always writes to the uiHints dictionary. It does not call UsdObject::SetHidden, which has been deprecated.

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