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 USDHOUDINI_TOKENS_H
25 #define USDHOUDINI_TOKENS_H
26 
27 /// \file usdHoudini/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 "./api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdHoudiniTokensType
46 ///
47 /// \link UsdHoudiniTokens \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 /// UsdHoudiniTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdHoudiniTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdHoudiniTokens->fieldIndex);
62 /// \endcode
64  USDHOUDINI_API UsdHoudiniTokensType();
65  /// \brief "fieldIndex"
66  ///
67  /// UsdHoudiniHoudiniFieldAsset
69  /// \brief "fieldName"
70  ///
71  /// UsdHoudiniHoudiniFieldAsset
73  /// A vector of all of the tokens listed above.
74  const std::vector<TfToken> allTokens;
75 };
76 
77 /// \var UsdHoudiniTokens
78 ///
79 /// A global variable with static, efficient \link TfToken TfTokens\endlink
80 /// for use in all public USD API. \sa UsdHoudiniTokensType
82 
84 
85 #endif
USDHOUDINI_API TfStaticData< UsdHoudiniTokensType > & UsdHoudiniTokens()
Definition: token.h:89
USDHOUDINI_API UsdHoudiniTokensType()
const TfToken fieldIndex
"fieldIndex"
Definition: tokens.h:68
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
const TfToken fieldName
"fieldName"
Definition: tokens.h:72
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:74