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

#include <tokens.h>

Public Attributes
const TfToken	accessibility
	"accessibility"

const TfToken	accessibility_MultipleApplyTemplate_Description
	"accessibility:__INSTANCE_NAME__:description"

const TfToken	accessibility_MultipleApplyTemplate_Label
	"accessibility:__INSTANCE_NAME__:label"

const TfToken	accessibility_MultipleApplyTemplate_Priority
	"accessibility:__INSTANCE_NAME__:priority"

const TfToken	closed
	"closed"

const TfToken	default_
	"default"

const TfToken	description
	"description"

const TfToken	high
	"high"

const TfToken	label
	"label"

const TfToken	low
	"low"

const TfToken	minimized
	"minimized"

const TfToken	open
	"open"

const TfToken	priority
	"priority"

const TfToken	standard
	"standard"

const TfToken	uiDescription
	"ui:description"

const TfToken	uiDisplayGroup
	"ui:displayGroup"

const TfToken	uiDisplayName
	"ui:displayName"

const TfToken	uiNodegraphNodeDisplayColor
	"ui:nodegraph:node:displayColor"

const TfToken	uiNodegraphNodeDocURI
	"ui:nodegraph:node:docURI"

const TfToken	uiNodegraphNodeExpansionState
	"ui:nodegraph:node:expansionState"

const TfToken	uiNodegraphNodeIcon
	"ui:nodegraph:node:icon"

const TfToken	uiNodegraphNodePos
	"ui:nodegraph:node:pos"

const TfToken	uiNodegraphNodeSize
	"ui:nodegraph:node:size"

const TfToken	uiNodegraphNodeStackingOrder
	"ui:nodegraph:node:stackingOrder"

const TfToken	AccessibilityAPI
	"AccessibilityAPI"

const TfToken	Backdrop
	"Backdrop"

const TfToken	NodeGraphNodeAPI
	"NodeGraphNodeAPI"

const TfToken	SceneGraphPrimAPI
	"SceneGraphPrimAPI"

const std::vector< TfToken >	allTokens
	A vector of all of the tokens listed above.

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->accessibility);

UsdUITokens

USDUI_API TfStaticData< UsdUITokensType > UsdUITokens

A global variable with static, efficient TfTokens for use in all public USD API.

Definition at line 46 of file tokens.h.

Member Data Documentation

◆ accessibility

const TfToken accessibility

"accessibility"

Property namespace prefix for the UsdUIAccessibilityAPI schema.

Definition at line 51 of file tokens.h.

◆ accessibility_MultipleApplyTemplate_Description

const TfToken accessibility_MultipleApplyTemplate_Description

"accessibility:__INSTANCE_NAME__:description"

UsdUIAccessibilityAPI

Definition at line 55 of file tokens.h.

◆ accessibility_MultipleApplyTemplate_Label

const TfToken accessibility_MultipleApplyTemplate_Label

"accessibility:__INSTANCE_NAME__:label"

UsdUIAccessibilityAPI

Definition at line 59 of file tokens.h.

◆ accessibility_MultipleApplyTemplate_Priority

const TfToken accessibility_MultipleApplyTemplate_Priority

"accessibility:__INSTANCE_NAME__:priority"

UsdUIAccessibilityAPI

Definition at line 63 of file tokens.h.

◆ AccessibilityAPI

const TfToken AccessibilityAPI

"AccessibilityAPI"

Schema identifer and family for UsdUIAccessibilityAPI

Definition at line 147 of file tokens.h.

◆ allTokens

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 161 of file tokens.h.

◆ Backdrop

const TfToken Backdrop

"Backdrop"

Schema identifer and family for UsdUIBackdrop

Definition at line 151 of file tokens.h.

◆ closed

const TfToken closed

"closed"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 67 of file tokens.h.

◆ default_

const TfToken default_

"default"

Name of the anonymous instance name for the schema

Definition at line 71 of file tokens.h.

◆ description

const TfToken description

"description"

Name of the description attribute

Definition at line 75 of file tokens.h.

◆ high

const TfToken high

"high"

Possible value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 79 of file tokens.h.

◆ label

const TfToken label

"label"

Name of the label attribute

Definition at line 83 of file tokens.h.

◆ low

const TfToken low

"low"

Possible value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 87 of file tokens.h.

◆ minimized

const TfToken minimized

"minimized"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 91 of file tokens.h.

◆ NodeGraphNodeAPI

const TfToken NodeGraphNodeAPI

"NodeGraphNodeAPI"

Schema identifer and family for UsdUINodeGraphNodeAPI

Definition at line 155 of file tokens.h.

◆ open

const TfToken open

"open"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 95 of file tokens.h.

◆ priority

const TfToken priority

"priority"

Name of the priority attribute

Definition at line 99 of file tokens.h.

◆ SceneGraphPrimAPI

const TfToken SceneGraphPrimAPI

"SceneGraphPrimAPI"

Schema identifer and family for UsdUISceneGraphPrimAPI

Definition at line 159 of file tokens.h.

◆ standard

const TfToken standard

"standard"

Fallback value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 103 of file tokens.h.

◆ uiDescription

const TfToken uiDescription

"ui:description"

UsdUIBackdrop

Definition at line 107 of file tokens.h.

◆ uiDisplayGroup

const TfToken uiDisplayGroup

"ui:displayGroup"

UsdUISceneGraphPrimAPI

Definition at line 111 of file tokens.h.

◆ uiDisplayName

const TfToken uiDisplayName

"ui:displayName"

UsdUISceneGraphPrimAPI

Definition at line 115 of file tokens.h.

◆ uiNodegraphNodeDisplayColor

const TfToken uiNodegraphNodeDisplayColor

"ui:nodegraph:node:displayColor"

UsdUINodeGraphNodeAPI

Definition at line 119 of file tokens.h.

◆ uiNodegraphNodeDocURI

const TfToken uiNodegraphNodeDocURI

"ui:nodegraph:node:docURI"

UsdUINodeGraphNodeAPI

Definition at line 123 of file tokens.h.

◆ uiNodegraphNodeExpansionState

const TfToken uiNodegraphNodeExpansionState

"ui:nodegraph:node:expansionState"

UsdUINodeGraphNodeAPI

Definition at line 127 of file tokens.h.

◆ uiNodegraphNodeIcon

const TfToken uiNodegraphNodeIcon

"ui:nodegraph:node:icon"

UsdUINodeGraphNodeAPI

Definition at line 131 of file tokens.h.

◆ uiNodegraphNodePos

const TfToken uiNodegraphNodePos

"ui:nodegraph:node:pos"

UsdUINodeGraphNodeAPI

Definition at line 135 of file tokens.h.

◆ uiNodegraphNodeSize

const TfToken uiNodegraphNodeSize

"ui:nodegraph:node:size"

UsdUINodeGraphNodeAPI

Definition at line 139 of file tokens.h.

◆ uiNodegraphNodeStackingOrder

const TfToken uiNodegraphNodeStackingOrder

"ui:nodegraph:node:stackingOrder"

UsdUINodeGraphNodeAPI

Definition at line 143 of file tokens.h.

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

pxr/usd/usdUI/tokens.h

Public Attributes

Detailed Description

Member Data Documentation

◆ accessibility

◆ accessibility_MultipleApplyTemplate_Description

◆ accessibility_MultipleApplyTemplate_Label

◆ accessibility_MultipleApplyTemplate_Priority

◆ AccessibilityAPI

◆ allTokens

◆ Backdrop

◆ closed

◆ default_

◆ description

◆ high

◆ label

◆ low

◆ minimized

◆ NodeGraphNodeAPI

◆ open

◆ priority

◆ SceneGraphPrimAPI

◆ standard

◆ uiDescription

◆ uiDisplayGroup

◆ uiDisplayName

◆ uiNodegraphNodeDisplayColor

◆ uiNodegraphNodeDocURI

◆ uiNodegraphNodeExpansionState

◆ uiNodegraphNodeIcon

◆ uiNodegraphNodePos

◆ uiNodegraphNodeSize

◆ uiNodegraphNodeStackingOrder