UsdUITokensType Class Reference

#include <tokens.h>

Public Member Functions
USDUI_API	UsdUITokensType ()

Public Attributes
const TfToken	accessibility
	"accessibility" More...
const TfToken	accessibility_MultipleApplyTemplate_Description
	"accessibility:__INSTANCE_NAME__:description" More...
const TfToken	accessibility_MultipleApplyTemplate_Label
	"accessibility:__INSTANCE_NAME__:label" More...
const TfToken	accessibility_MultipleApplyTemplate_Priority
	"accessibility:__INSTANCE_NAME__:priority" More...
const TfToken	closed
	"closed" More...
const TfToken	default_
	"default" More...
const TfToken	description
	"description" More...
const TfToken	high
	"high" More...
const TfToken	label
	"label" More...
const TfToken	low
	"low" More...
const TfToken	minimized
	"minimized" More...
const TfToken	open
	"open" More...
const TfToken	priority
	"priority" More...
const TfToken	standard
	"standard" 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	uiNodegraphNodeDocURI
	"ui:nodegraph:node:docURI" 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	AccessibilityAPI
	"AccessibilityAPI" 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->accessibility);

Definition at line 46 of file tokens.h.

Constructor & Destructor Documentation

USDUI_API UsdUITokensType::UsdUITokensType

(

)

Member Data Documentation

const TfToken UsdUITokensType::accessibility

"accessibility"

Property namespace prefix for the UsdUIAccessibilityAPI schema.

Definition at line 51 of file tokens.h.

const TfToken UsdUITokensType::accessibility_MultipleApplyTemplate_Description

"accessibility:__INSTANCE_NAME__:description"

UsdUIAccessibilityAPI

Definition at line 55 of file tokens.h.

const TfToken UsdUITokensType::accessibility_MultipleApplyTemplate_Label

"accessibility:__INSTANCE_NAME__:label"

UsdUIAccessibilityAPI

Definition at line 59 of file tokens.h.

const TfToken UsdUITokensType::accessibility_MultipleApplyTemplate_Priority

"accessibility:__INSTANCE_NAME__:priority"

UsdUIAccessibilityAPI

Definition at line 63 of file tokens.h.

const TfToken UsdUITokensType::AccessibilityAPI

"AccessibilityAPI"

Schema identifer and family for UsdUIAccessibilityAPI

Definition at line 147 of file tokens.h.

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

A vector of all of the tokens listed above.

Definition at line 161 of file tokens.h.

const TfToken UsdUITokensType::Backdrop

"Backdrop"

Schema identifer and family for UsdUIBackdrop

Definition at line 151 of file tokens.h.

const TfToken UsdUITokensType::closed

"closed"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 67 of file tokens.h.

const TfToken UsdUITokensType::default_

"default"

Name of the anonymous instance name for the schema

Definition at line 71 of file tokens.h.

const TfToken UsdUITokensType::description

"description"

Name of the description attribute

Definition at line 75 of file tokens.h.

const TfToken UsdUITokensType::high

"high"

Possible value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 79 of file tokens.h.

const TfToken UsdUITokensType::label

"label"

Name of the label attribute

Definition at line 83 of file tokens.h.

const TfToken UsdUITokensType::low

"low"

Possible value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 87 of file tokens.h.

const TfToken UsdUITokensType::minimized

"minimized"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 91 of file tokens.h.

const TfToken UsdUITokensType::NodeGraphNodeAPI

"NodeGraphNodeAPI"

Schema identifer and family for UsdUINodeGraphNodeAPI

Definition at line 155 of file tokens.h.

const TfToken UsdUITokensType::open

"open"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 95 of file tokens.h.

const TfToken UsdUITokensType::priority

"priority"

Name of the priority attribute

Definition at line 99 of file tokens.h.

const TfToken UsdUITokensType::SceneGraphPrimAPI

"SceneGraphPrimAPI"

Schema identifer and family for UsdUISceneGraphPrimAPI

Definition at line 159 of file tokens.h.

const TfToken UsdUITokensType::standard

"standard"

Fallback value for UsdUIAccessibilityAPI::GetPriorityAttr()

Definition at line 103 of file tokens.h.

const TfToken UsdUITokensType::uiDescription

"ui:description"

UsdUIBackdrop

Definition at line 107 of file tokens.h.

const TfToken UsdUITokensType::uiDisplayGroup

"ui:displayGroup"

UsdUISceneGraphPrimAPI

Definition at line 111 of file tokens.h.

const TfToken UsdUITokensType::uiDisplayName

"ui:displayName"

UsdUISceneGraphPrimAPI

Definition at line 115 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeDisplayColor

"ui:nodegraph:node:displayColor"

UsdUINodeGraphNodeAPI

Definition at line 119 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeDocURI

"ui:nodegraph:node:docURI"

UsdUINodeGraphNodeAPI

Definition at line 123 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeExpansionState

"ui:nodegraph:node:expansionState"

UsdUINodeGraphNodeAPI

Definition at line 127 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeIcon

"ui:nodegraph:node:icon"

UsdUINodeGraphNodeAPI

Definition at line 131 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodePos

"ui:nodegraph:node:pos"

UsdUINodeGraphNodeAPI

Definition at line 135 of file tokens.h.

const TfToken UsdUITokensType::uiNodegraphNodeSize

"ui:nodegraph:node:size"

UsdUINodeGraphNodeAPI

Definition at line 139 of file tokens.h.

const TfToken UsdUITokensType::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