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

#include <propertyHints.h>

Inheritance diagram for UsdUIPropertyHints:

Public Member Functions
USDUI_API	UsdUIPropertyHints ()
	Default constructor that creates an invalid hints object.

USDUI_API	UsdUIPropertyHints (const UsdProperty &prop)
	Construct a hints object for the given UsdProperty `prop`.

UsdProperty	GetProperty () const
	Return the property that this hints instance is interpreting.

USDUI_API std::string	GetDisplayGroup () const
	Return the property's display group, indicating which group it should appear under in the UI.

USDUI_API bool	SetDisplayGroup (const std::string &group)
	Set the object's display group to `group`.

USDUI_API std::string	GetShownIf () const
	Return the property's "shown if" expression string.

USDUI_API bool	SetShownIf (const std::string &shownIf)
	Set the property's "shown if" expression string.

Public Member Functions inherited from UsdUIObjectHints
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.

Additional Inherited Members
Static Protected Member Functions inherited from UsdUIObjectHints
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 UsdProperty instance.

UsdUIPropertyHints is "schema-like" in that it interprets fields belonging to a core object type (in this case UsdProperty, but see also UsdUIObjectHints, UsdUIPrimHints, 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 31 of file propertyHints.h.

Constructor & Destructor Documentation

◆ UsdUIPropertyHints() [1/2]

USDUI_API UsdUIPropertyHints ( )

Default constructor that creates an invalid hints object.

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

◆ UsdUIPropertyHints() [2/2]

USDUI_API UsdUIPropertyHints ( const UsdProperty & prop )

explicit

Construct a hints object for the given UsdProperty prop.

Member Function Documentation

◆ GetDisplayGroup()

USDUI_API std::string GetDisplayGroup ( ) const

Return the property's display group, indicating which group it should appear under in the UI.

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

◆ GetProperty()

UsdProperty GetProperty ( ) const

inline

Return the property that this hints instance is interpreting.

Definition at line 46 of file propertyHints.h.

◆ GetShownIf()

USDUI_API std::string GetShownIf ( ) const

Return the property's "shown if" expression string.

This expression, when evaluated, determines whether the property should be shown or hidden in the UI.

◆ SetDisplayGroup()

USDUI_API bool SetDisplayGroup ( const std::string & group )

Set the object's display group to group.

Return true if successful.

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

◆ SetShownIf()

USDUI_API bool SetShownIf ( const std::string & shownIf )

Set the property's "shown if" expression string.