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 USDVOL_TOKENS_H
25 #define USDVOL_TOKENS_H
26 
27 /// \file usdVol/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/usdVol/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdVolTokensType
46 ///
47 /// \link UsdVolTokens \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 /// UsdVolTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdVolTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdVolTokens->bool_);
62 /// \endcode
65  /// \brief "bool"
66  ///
67  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
68  const TfToken bool_;
69  /// \brief "Color"
70  ///
71  /// Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()
72  const TfToken color;
73  /// \brief "double2"
74  ///
75  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
77  /// \brief "double3"
78  ///
79  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
81  /// \brief "double"
82  ///
83  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
85  /// \brief "field"
86  ///
87  /// This is the namespace prefix used to specify the fields that make up a volume primitive.
88  const TfToken field;
89  /// \brief "fieldClass"
90  ///
91  /// UsdVolOpenVDBAsset
93  /// \brief "fieldDataType"
94  ///
95  /// UsdVolOpenVDBAsset, UsdVolField3DAsset, UsdVolFieldAsset
97  /// \brief "fieldIndex"
98  ///
99  /// UsdVolFieldAsset
101  /// \brief "fieldName"
102  ///
103  /// UsdVolFieldAsset
105  /// \brief "fieldPurpose"
106  ///
107  /// UsdVolField3DAsset
109  /// \brief "filePath"
110  ///
111  /// UsdVolFieldAsset
113  /// \brief "float2"
114  ///
115  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
117  /// \brief "float3"
118  ///
119  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
121  /// \brief "float"
122  ///
123  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
125  /// \brief "fogVolume"
126  ///
127  /// Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()
129  /// \brief "half"
130  ///
131  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
132  const TfToken half;
133  /// \brief "half2"
134  ///
135  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
136  const TfToken half2;
137  /// \brief "half3"
138  ///
139  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr(), Possible value for UsdVolField3DAsset::GetFieldDataTypeAttr()
140  const TfToken half3;
141  /// \brief "int2"
142  ///
143  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
144  const TfToken int2;
145  /// \brief "int3"
146  ///
147  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
148  const TfToken int3;
149  /// \brief "int64"
150  ///
151  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
152  const TfToken int64;
153  /// \brief "int"
154  ///
155  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
156  const TfToken int_;
157  /// \brief "levelSet"
158  ///
159  /// Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()
161  /// \brief "mask"
162  ///
163  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
164  const TfToken mask;
165  /// \brief "matrix3d"
166  ///
167  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
169  /// \brief "matrix4d"
170  ///
171  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
173  /// \brief "None"
174  ///
175  /// Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr(), Default value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()
176  const TfToken none_;
177  /// \brief "Normal"
178  ///
179  /// Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()
181  /// \brief "Point"
182  ///
183  /// Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()
184  const TfToken point;
185  /// \brief "quatd"
186  ///
187  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
188  const TfToken quatd;
189  /// \brief "staggered"
190  ///
191  /// Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()
193  /// \brief "string"
194  ///
195  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
197  /// \brief "uint"
198  ///
199  /// Possible value for UsdVolOpenVDBAsset::GetFieldDataTypeAttr()
200  const TfToken uint;
201  /// \brief "unknown"
202  ///
203  /// Possible value for UsdVolOpenVDBAsset::GetFieldClassAttr()
205  /// \brief "Vector"
206  ///
207  /// Possible value for UsdVolFieldAsset::GetVectorDataRoleHintAttr()
209  /// \brief "vectorDataRoleHint"
210  ///
211  /// UsdVolFieldAsset
213  /// A vector of all of the tokens listed above.
214  const std::vector<TfToken> allTokens;
215 };
216 
217 /// \var UsdVolTokens
218 ///
219 /// A global variable with static, efficient \link TfToken TfTokens\endlink
220 /// for use in all public USD API. \sa UsdVolTokensType
222 
224 
225 #endif
const TfToken mask
"mask"
Definition: tokens.h:164
const TfToken half3
"half3"
Definition: tokens.h:140
const TfToken half
"half"
Definition: tokens.h:132
const TfToken fogVolume
"fogVolume"
Definition: tokens.h:128
const TfToken point
"Point"
Definition: tokens.h:184
const TfToken int_
"int"
Definition: tokens.h:156
const TfToken matrix3d
"matrix3d"
Definition: tokens.h:168
const TfToken float2
"float2"
Definition: tokens.h:116
const TfToken bool_
"bool"
Definition: tokens.h:68
const TfToken matrix4d
"matrix4d"
Definition: tokens.h:172
const TfToken half2
"half2"
Definition: tokens.h:136
const TfToken normal
"Normal"
Definition: tokens.h:180
const TfToken double3
"double3"
Definition: tokens.h:80
const TfToken vectorDataRoleHint
"vectorDataRoleHint"
Definition: tokens.h:212
USDVOL_API TfStaticData< UsdVolTokensType > UsdVolTokens
const TfToken double2
"double2"
Definition: tokens.h:76
Definition: token.h:87
const TfToken int3
"int3"
Definition: tokens.h:148
const TfToken vector
"Vector"
Definition: tokens.h:208
const TfToken levelSet
"levelSet"
Definition: tokens.h:160
const TfToken staggered
"staggered"
Definition: tokens.h:192
const TfToken int64
"int64"
Definition: tokens.h:152
const TfToken string
"string"
Definition: tokens.h:196
const TfToken fieldDataType
"fieldDataType"
Definition: tokens.h:96
const TfToken float3
"float3"
Definition: tokens.h:120
const TfToken fieldName
"fieldName"
Definition: tokens.h:104
const TfToken float_
"float"
Definition: tokens.h:124
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:214
const TfToken color
"Color"
Definition: tokens.h:72
const TfToken fieldClass
"fieldClass"
Definition: tokens.h:92
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const TfToken filePath
"filePath"
Definition: tokens.h:112
USDVOL_API UsdVolTokensType()
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken uint
"uint"
Definition: tokens.h:200
const TfToken quatd
"quatd"
Definition: tokens.h:188
const TfToken double_
"double"
Definition: tokens.h:84
const TfToken fieldIndex
"fieldIndex"
Definition: tokens.h:100
#define USDVOL_API
Definition: api.h:40
const TfToken none_
"None"
Definition: tokens.h:176
const TfToken unknown
"unknown"
Definition: tokens.h:204
const TfToken int2
"int2"
Definition: tokens.h:144
const TfToken fieldPurpose
"fieldPurpose"
Definition: tokens.h:108
const TfToken field
"field"
Definition: tokens.h:88