UsdUITokensType Class Reference

#include <tokens.h>

Public Member Functions
USDUI_API	UsdUITokensType ()

Public Attributes
const TfToken	closed
	"closed" More...
const TfToken	minimized
	"minimized" More...
const TfToken	open
	"open" More...
const TfToken	uiDescription
	"ui:description" More...
const TfToken	uiDisplayGroup
	"ui:displayGroup" More...
const TfToken	uiDisplayName
	"ui:displayName" More...
const TfToken	uiNodegraphNodeDisplayColor
	"ui:nodegraph:node:displayColor" More...
const TfToken	uiNodegraphNodeExpansionState
	"ui:nodegraph:node:expansionState" More...
const TfToken	uiNodegraphNodeIcon
	"ui:nodegraph:node:icon" More...
const TfToken	uiNodegraphNodePos
	"ui:nodegraph:node:pos" More...
const TfToken	uiNodegraphNodeSize
	"ui:nodegraph:node:size" More...
const TfToken	uiNodegraphNodeStackingOrder
	"ui:nodegraph:node:stackingOrder" More...
const TfToken	Backdrop
	"Backdrop" More...
const TfToken	NodeGraphNodeAPI
	"NodeGraphNodeAPI" More...
const TfToken	SceneGraphPrimAPI
	"SceneGraphPrimAPI" More...
const std::vector< TfToken >	allTokens
	A vector of all of the tokens listed above. More...

Detailed Description

UsdUITokens provides static, efficient TfTokens for use in all public USD API.

These tokens are auto-generated from the module's schema, representing property names, for when you need to fetch an attribute or relationship directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient manner, and allow the compiler to verify that you spelled the name correctly.

UsdUITokens also contains all of the allowedTokens values declared for schema builtin attributes of 'token' scene description type. Use UsdUITokens like so:

gprim.GetMyTokenValuedAttr().Set(UsdUITokens->closed);

Definition at line 63 of file tokens.h.

Constructor & Destructor Documentation

USDUI_API UsdUITokensType::UsdUITokensType

(

)

Member Data Documentation

const std::vector<TfToken> UsdUITokensType::allTokens

A vector of all of the tokens listed above.

Definition at line 126 of file tokens.h.

const TfToken UsdUITokensType::Backdrop

"Backdrop"

Schema identifer and family for UsdUIBackdrop

Definition at line 116 of file tokens.h.

const TfToken UsdUITokensType::closed

"closed"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 68 of file tokens.h.

const TfToken UsdUITokensType::minimized

"minimized"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 72 of file tokens.h.

const TfToken UsdUITokensType::NodeGraphNodeAPI

"NodeGraphNodeAPI"

Schema identifer and family for UsdUINodeGraphNodeAPI

Definition at line 120 of file tokens.h.

const TfToken UsdUITokensType::open

"open"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 76 of file tokens.h.

const TfToken UsdUITokensType::SceneGraphPrimAPI

"SceneGraphPrimAPI"

Schema identifer and family for UsdUISceneGraphPrimAPI

Definition at line 124 of file tokens.h.

const TfToken UsdUITokensType::uiDescription

"ui:description"

UsdUIBackdrop

Definition at line 80 of file tokens.h.

const TfToken UsdUITokensType::uiDisplayGroup

"ui:displayGroup"

UsdUISceneGraphPrimAPI

Definition at line 84 of file tokens.h.

const TfToken UsdUITokensType::uiDisplayName

"ui:displayName"

UsdUISceneGraphPrimAPI

Definition at line 88 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeDisplayColor

"ui:nodegraph:node:displayColor"

UsdUINodeGraphNodeAPI

Definition at line 92 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeExpansionState

"ui:nodegraph:node:expansionState"

UsdUINodeGraphNodeAPI

Definition at line 96 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeIcon

"ui:nodegraph:node:icon"

UsdUINodeGraphNodeAPI

Definition at line 100 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodePos

"ui:nodegraph:node:pos"

UsdUINodeGraphNodeAPI

Definition at line 104 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeSize

"ui:nodegraph:node:size"

UsdUINodeGraphNodeAPI

Definition at line 108 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeStackingOrder

"ui:nodegraph:node:stackingOrder"

UsdUINodeGraphNodeAPI

Definition at line 112 of file tokens.h.

---

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

• pxr/usd/usdUI/tokens.h