objectHints.h File Reference

#include "pxr/usd/usd/object.h"
#include "pxr/usd/usdUI/api.h"
#include "pxr/base/tf/envSetting.h"
#include "pxr/base/tf/staticTokens.h"
#include <string>

Include dependency graph for objectHints.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
class	UsdUIObjectHints

Macros
#define	USDUI_HINT_KEYS

Functions
	TF_DECLARE_PUBLIC_TOKENS (UsdUIHintKeys, USDUI_API, USDUI_HINT_KEYS)

Variables
PXR_NAMESPACE_OPEN_SCOPE USDUI_API TfEnvSetting< bool >	USDUI_WRITE_LEGACY_UI_HINTS

Macro Definition Documentation

#define USDUI_HINT_KEYS

Definition at line 27 of file objectHints.h.

Function Documentation

TF_DECLARE_PUBLIC_TOKENS	(	UsdUIHintKeys	,
		USDUI_API	,
		USDUI_HINT_KEYS
	)

UsdUIHintKeys provides tokens for the various entries in the uiHints dictionary metadata field. Named API corresponding to these entries is provided by the hint access classes UsdUIObjectHints, UsdUIPrimHints, UsdUIPropertyHints, and UsdUIAttributeHints. See documentation there for field descriptions.

Variable Documentation

PXR_NAMESPACE_OPEN_SCOPE USDUI_API TfEnvSetting<bool> USDUI_WRITE_LEGACY_UI_HINTS