HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
tokens.h
Go to the documentation of this file.
1 //
2 // Copyright 2016 Pixar
3 //
4 // Licensed under the Apache License, Version 2.0 (the "Apache License")
5 // with the following modification; you may not use this file except in
6 // compliance with the Apache License and the following modification to it:
7 // Section 6. Trademarks. is deleted and replaced with:
8 //
9 // 6. Trademarks. This License does not grant permission to use the trade
10 // names, trademarks, service marks, or product names of the Licensor
11 // and its affiliates, except as required to comply with Section 4(c) of
12 // the License and to reproduce the content of the NOTICE file.
13 //
14 // You may obtain a copy of the Apache License at
15 //
16 // http://www.apache.org/licenses/LICENSE-2.0
17 //
18 // Unless required by applicable law or agreed to in writing, software
19 // distributed under the Apache License with the above modification is
20 // distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
21 // KIND, either express or implied. See the Apache License for the specific
22 // language governing permissions and limitations under the Apache License.
23 //
24 #ifndef USDUI_TOKENS_H
25 #define USDUI_TOKENS_H
26 
27 /// \file usdUI/tokens.h
28 
29 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
30 //
31 // This is an automatically generated file (by usdGenSchema.py).
32 // Do not hand-edit!
33 //
34 // XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
35 
36 #include "pxr/pxr.h"
37 #include "pxr/usd/usdUI/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdUITokensType
46 ///
47 /// \link UsdUITokens \endlink provides static, efficient
48 /// \link TfToken TfTokens\endlink for use in all public USD API.
49 ///
50 /// These tokens are auto-generated from the module's schema, representing
51 /// property names, for when you need to fetch an attribute or relationship
52 /// directly by name, e.g. UsdPrim::GetAttribute(), in the most efficient
53 /// manner, and allow the compiler to verify that you spelled the name
54 /// correctly.
55 ///
56 /// UsdUITokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdUITokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdUITokens->closed);
62 /// \endcode
65  /// \brief "closed"
66  ///
67  /// Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()
68  const TfToken closed;
69  /// \brief "minimized"
70  ///
71  /// Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()
73  /// \brief "open"
74  ///
75  /// Possible value for UsdUINodeGraphNodeAPI::GetExpansionStateAttr()
76  const TfToken open;
77  /// \brief "ui:description"
78  ///
79  /// UsdUIBackdrop
81  /// \brief "ui:displayGroup"
82  ///
83  /// UsdUISceneGraphPrimAPI
85  /// \brief "ui:displayName"
86  ///
87  /// UsdUISceneGraphPrimAPI
89  /// \brief "ui:nodegraph:node:displayColor"
90  ///
91  /// UsdUINodeGraphNodeAPI
93  /// \brief "ui:nodegraph:node:expansionState"
94  ///
95  /// UsdUINodeGraphNodeAPI
97  /// \brief "ui:nodegraph:node:icon"
98  ///
99  /// UsdUINodeGraphNodeAPI
101  /// \brief "ui:nodegraph:node:pos"
102  ///
103  /// UsdUINodeGraphNodeAPI
105  /// \brief "ui:nodegraph:node:size"
106  ///
107  /// UsdUINodeGraphNodeAPI
109  /// \brief "ui:nodegraph:node:stackingOrder"
110  ///
111  /// UsdUINodeGraphNodeAPI
113  /// A vector of all of the tokens listed above.
114  const std::vector<TfToken> allTokens;
115 };
116 
117 /// \var UsdUITokens
118 ///
119 /// A global variable with static, efficient \link TfToken TfTokens\endlink
120 /// for use in all public USD API. \sa UsdUITokensType
122 
124 
125 #endif
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:114
const TfToken closed
"closed"
Definition: tokens.h:68
const TfToken uiNodegraphNodeDisplayColor
"ui:nodegraph:node:displayColor"
Definition: tokens.h:92
const TfToken uiNodegraphNodeExpansionState
"ui:nodegraph:node:expansionState"
Definition: tokens.h:96
const TfToken uiDisplayName
"ui:displayName"
Definition: tokens.h:88
const TfToken minimized
"minimized"
Definition: tokens.h:72
const TfToken uiNodegraphNodeStackingOrder
"ui:nodegraph:node:stackingOrder"
Definition: tokens.h:112
const TfToken uiNodegraphNodePos
"ui:nodegraph:node:pos"
Definition: tokens.h:104
USDUI_API TfStaticData< UsdUITokensType > UsdUITokens
Definition: token.h:87
const TfToken open
"open"
Definition: tokens.h:76
const TfToken uiNodegraphNodeIcon
"ui:nodegraph:node:icon"
Definition: tokens.h:100
const TfToken uiDescription
"ui:description"
Definition: tokens.h:80
#define USDUI_API
Definition: api.h:40
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
const TfToken uiDisplayGroup
"ui:displayGroup"
Definition: tokens.h:84
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDUI_API UsdUITokensType()
const TfToken uiNodegraphNodeSize
"ui:nodegraph:node:size"
Definition: tokens.h:108