Loading...
Searching...
No Matches
UsdUITokensType Class Reference

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

#include <tokens.h>

Public Attributes

const TfToken closed
 "closed"
 
const TfToken minimized
 "minimized"
 
const TfToken open
 "open"
 
const TfToken uiDescription
 "ui:description"
 
const TfToken uiDisplayGroup
 "ui:displayGroup"
 
const TfToken uiDisplayName
 "ui:displayName"
 
const TfToken uiNodegraphNodeDisplayColor
 "ui:nodegraph:node:displayColor"
 
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 Backdrop
 "Backdrop"
 
const TfToken NodeGraphNodeAPI
 "NodeGraphNodeAPI"
 
const TfToken SceneGraphPrimAPI
 "SceneGraphPrimAPI"
 
const std::vector< TfTokenallTokens
 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->closed);
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

◆ allTokens

const std::vector<TfToken> allTokens

A vector of all of the tokens listed above.

Definition at line 109 of file tokens.h.

◆ Backdrop

const TfToken Backdrop

"Backdrop"

Schema identifer and family for UsdUIBackdrop

Definition at line 99 of file tokens.h.

◆ closed

const TfToken closed

"closed"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 51 of file tokens.h.

◆ minimized

const TfToken minimized

"minimized"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 55 of file tokens.h.

◆ NodeGraphNodeAPI

const TfToken NodeGraphNodeAPI

"NodeGraphNodeAPI"

Schema identifer and family for UsdUINodeGraphNodeAPI

Definition at line 103 of file tokens.h.

◆ open

const TfToken open

"open"

Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()

Definition at line 59 of file tokens.h.

◆ SceneGraphPrimAPI

const TfToken SceneGraphPrimAPI

"SceneGraphPrimAPI"

Schema identifer and family for UsdUISceneGraphPrimAPI

Definition at line 107 of file tokens.h.

◆ uiDescription

const TfToken uiDescription

"ui:description"

UsdUIBackdrop

Definition at line 63 of file tokens.h.

◆ uiDisplayGroup

const TfToken uiDisplayGroup

"ui:displayGroup"

UsdUISceneGraphPrimAPI

Definition at line 67 of file tokens.h.

◆ uiDisplayName

const TfToken uiDisplayName

"ui:displayName"

UsdUISceneGraphPrimAPI

Definition at line 71 of file tokens.h.

◆ uiNodegraphNodeDisplayColor

const TfToken uiNodegraphNodeDisplayColor

"ui:nodegraph:node:displayColor"

UsdUINodeGraphNodeAPI

Definition at line 75 of file tokens.h.

◆ uiNodegraphNodeExpansionState

const TfToken uiNodegraphNodeExpansionState

"ui:nodegraph:node:expansionState"

UsdUINodeGraphNodeAPI

Definition at line 79 of file tokens.h.

◆ uiNodegraphNodeIcon

const TfToken uiNodegraphNodeIcon

"ui:nodegraph:node:icon"

UsdUINodeGraphNodeAPI

Definition at line 83 of file tokens.h.

◆ uiNodegraphNodePos

const TfToken uiNodegraphNodePos

"ui:nodegraph:node:pos"

UsdUINodeGraphNodeAPI

Definition at line 87 of file tokens.h.

◆ uiNodegraphNodeSize

const TfToken uiNodegraphNodeSize

"ui:nodegraph:node:size"

UsdUINodeGraphNodeAPI

Definition at line 91 of file tokens.h.

◆ uiNodegraphNodeStackingOrder

const TfToken uiNodegraphNodeStackingOrder

"ui:nodegraph:node:stackingOrder"

UsdUINodeGraphNodeAPI

Definition at line 95 of file tokens.h.


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