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 USD_TOKENS_H
25 #define USD_TOKENS_H
26 
27 /// \file usd/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/usd/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdTokensType
46 ///
47 /// \link UsdTokens \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 /// UsdTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdTokens->apiSchemas);
62 /// \endcode
63 struct UsdTokensType {
65  /// \brief "apiSchemas"
66  ///
67  /// A listop metadata containing the API schemas which have been applied to this prim, using the Apply() method on the particular schema class.
69  /// \brief "clips"
70  ///
71  /// Dictionary that contains the definition of the clip sets on this prim. See \ref UsdClipsAPI::GetClips.
72  const TfToken clips;
73  /// \brief "clipSets"
74  ///
75  /// ListOp that may be used to affect how opinions from clip sets are applied during value resolution. See \ref UsdClipsAPI::GetClipSets.
77  /// \brief "collection"
78  ///
79  /// Property namespace prefix for the UsdCollectionAPI schema.
81  /// \brief "exclude"
82  ///
83  /// This is the token used to exclude a path from a collection. Although it is not a possible value for the "expansionRule" attribute, it is used as the expansionRule for excluded paths in UsdCollectionAPI::MembershipQuery::IsPathIncluded.
85  /// \brief "excludes"
86  ///
87  /// UsdCollectionAPI
89  /// \brief "expandPrims"
90  ///
91  /// Possible value for UsdCollectionAPI::GetExpansionRuleAttr(), Default value for UsdCollectionAPI::GetExpansionRuleAttr()
93  /// \brief "expandPrimsAndProperties"
94  ///
95  /// Possible value for UsdCollectionAPI::GetExpansionRuleAttr()
97  /// \brief "expansionRule"
98  ///
99  /// UsdCollectionAPI
101  /// \brief "explicitOnly"
102  ///
103  /// Possible value for UsdCollectionAPI::GetExpansionRuleAttr()
105  /// \brief "fallbackPrimTypes"
106  ///
107  /// A dictionary metadata that maps the name of a concrete schema prim type to an ordered list of schema prim types to use instead if the schema prim type doesn't exist in version of USD being used.
109  /// \brief "includeRoot"
110  ///
111  /// UsdCollectionAPI
113  /// \brief "includes"
114  ///
115  /// UsdCollectionAPI
117  /// A vector of all of the tokens listed above.
118  const std::vector<TfToken> allTokens;
119 };
120 
121 /// \var UsdTokens
122 ///
123 /// A global variable with static, efficient \link TfToken TfTokens\endlink
124 /// for use in all public USD API. \sa UsdTokensType
126 
128 
129 #endif
const TfToken excludes
"excludes"
Definition: tokens.h:88
#define USD_API
Definition: api.h:40
const TfToken includes
"includes"
Definition: tokens.h:116
const TfToken expansionRule
"expansionRule"
Definition: tokens.h:100
const TfToken collection
"collection"
Definition: tokens.h:80
const TfToken apiSchemas
"apiSchemas"
Definition: tokens.h:68
USD_API UsdTokensType()
Definition: token.h:87
const TfToken clips
"clips"
Definition: tokens.h:72
const TfToken expandPrims
"expandPrims"
Definition: tokens.h:92
const TfToken fallbackPrimTypes
"fallbackPrimTypes"
Definition: tokens.h:108
USD_API TfStaticData< UsdTokensType > UsdTokens
const TfToken exclude
"exclude"
Definition: tokens.h:84
const TfToken includeRoot
"includeRoot"
Definition: tokens.h:112
const TfToken expandPrimsAndProperties
"expandPrimsAndProperties"
Definition: tokens.h:96
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:118
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken explicitOnly
"explicitOnly"
Definition: tokens.h:104
const TfToken clipSets
"clipSets"
Definition: tokens.h:76