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 USDSHADE_TOKENS_H
25 #define USDSHADE_TOKENS_H
26 
27 /// \file usdShade/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/usdShade/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdShadeTokensType
46 ///
47 /// \link UsdShadeTokens \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 /// UsdShadeTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdShadeTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdShadeTokens->allPurpose);
62 /// \endcode
65  /// \brief ""
66  ///
67  /// Possible value for the 'materialPurpose' parameter in the various methods available in UsdShadeMaterialBindingAPI. Its value is empty and its purpose is to represent a general purpose material-binding that applies in the absence of a specific-purpose binding.
69  /// \brief "bindMaterialAs"
70  ///
71  /// Token valued metadata key authored on a material binding relationship to indicate the strength of the binding relative to bindings authored on descendants.
73  /// \brief "coordSys:"
74  ///
75  /// Namespace prefix for relationships that bind coordinate systems.
77  /// \brief "displacement"
78  ///
79  /// Describes the <i>displacement</i> output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the displacement of a UsdShadeMaterial.
81  /// \brief "fallbackStrength"
82  ///
83  /// Sentinal value to be used for 'bindMaterialAs' metadata's default value. Clients should pass this in for the 'bindingStrength' argument to UsdShadeMaterialBindingAPI::Bind(), if they want to author the default value (weakerThanDescendants) sparsely. The value "fallbackStrength" never gets authored into scene description.
85  /// \brief "full"
86  ///
87  /// Possible value for 'connectability' metadata on a UsdShadeInput. When connectability of an input is set to "full", it implies that it can be connected to any input or output. , Possible value for the 'materialPurpose' parameter in UsdShadeMaterialBindingAPI, to be used when the purpose of the render is entirely about visualizing the truest representation of a scene, considering all lighting and material information, at highest fidelity.
88  const TfToken full;
89  /// \brief "id"
90  ///
91  /// Possible value for UsdShadeShader::GetInfoImplementationSourceAttr(), Default value for UsdShadeShader::GetInfoImplementationSourceAttr()
92  const TfToken id;
93  /// \brief "info:id"
94  ///
95  /// UsdShadeShader
96  const TfToken infoId;
97  /// \brief "info:implementationSource"
98  ///
99  /// UsdShadeShader
101  /// \brief "inputs:"
102  ///
103  /// The prefix on shading attributes denoting an input.
105  /// \brief "interfaceOnly"
106  ///
107  /// Possible value for 'connectability' metadata on a UsdShadeInput. It implies that the input can only connect to a NodeGraph Input (which represents an interface override, not a render-time dataflow connection), or another Input whose connectability is also 'interfaceOnly'.
109  /// \brief "materialBind"
110  ///
111  /// The name of the GeomSubset family used to identify face subsets defined for the purpose of binding materials to facesets.
113  /// \brief "material:binding"
114  ///
115  /// The relationship name on non-shading prims to denote a binding to a UsdShadeMaterial.
117  /// \brief "material:binding:collection"
118  ///
119  /// The relationship name on non-shading prims to denote a collection-based binding to a UsdShadeMaterial.
121  /// \brief "materialVariant"
122  ///
123  /// The variant name of material variation described on a UsdShadeMaterial.
125  /// \brief "outputs:"
126  ///
127  /// The prefix on shading attributes denoting an output.
129  /// \brief "outputs:displacement"
130  ///
131  /// UsdShadeMaterial
133  /// \brief "outputs:surface"
134  ///
135  /// UsdShadeMaterial
137  /// \brief "outputs:volume"
138  ///
139  /// UsdShadeMaterial
141  /// \brief "preview"
142  ///
143  /// Possible value for the 'materialPurpose' parameter in UsdShadeMaterialBindingAPI, to be used when the render is in service of a goal other than a high fidelity "full" render (such as scene manipulation, modeling, or realtime playback). Latency and speed are generally of greater concern for preview renders, therefore preview materials are generally designed to be "lighterweight" compared to full materials.
145  /// \brief "sdrMetadata"
146  ///
147  /// Dictionary valued metadata key authored on Shader prims with implementationSource value of sourceAsset or sourceCode to pass along metadata to the shader parser or compiler. It is also used to author metadata on shader properties in a UsdShade-based shader definition file.
149  /// \brief "sourceAsset"
150  ///
151  /// Possible value for UsdShadeShader::GetInfoImplementationSourceAttr()
153  /// \brief "sourceCode"
154  ///
155  /// Possible value for UsdShadeShader::GetInfoImplementationSourceAttr()
157  /// \brief "strongerThanDescendants"
158  ///
159  /// Possible value for 'bindMaterialAs' metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is stronger than any bindings authored on the descendants.
161  /// \brief "subIdentifier"
162  ///
163  /// This identifier is used in conjunction with a specific source asset to indicate a particular definition within the source asset, if the source asset specifies more than one shader node definition.
165  /// \brief "surface"
166  ///
167  /// Describes the <i>surface</i> output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the surface of a UsdShadeMaterial.
169  /// \brief ""
170  ///
171  /// Possible value for the "renderContext" parameter in \ref UsdShadeMaterial_Outputs API. Represents the universal renderContext. An output with a universal renderContext is applicable to all possible rendering contexts.
173  /// \brief ""
174  ///
175  /// Possible value for the "sourceType" parameter in \ref UsdShadeShader_ImplementationSource API. Represents the universal or fallback source type.
177  /// \brief "volume"
178  ///
179  /// Describes the <i>volume</i> output terminal on a UsdShadeMaterial. It is used to define the terminal UsdShadeShader describing the volume of a UsdShadeMaterial.
181  /// \brief "weakerThanDescendants"
182  ///
183  /// Possible value for 'bindMaterialAs' metadata on the collection-based material binding relationship. Indicates that the binding represented by the relationship is weaker than any bindings authored on the descendants.
185  /// A vector of all of the tokens listed above.
186  const std::vector<TfToken> allTokens;
187 };
188 
189 /// \var UsdShadeTokens
190 ///
191 /// A global variable with static, efficient \link TfToken TfTokens\endlink
192 /// for use in all public USD API. \sa UsdShadeTokensType
194 
196 
197 #endif
const TfToken materialBindingCollection
"material:binding:collection"
Definition: tokens.h:120
const TfToken preview
"preview"
Definition: tokens.h:144
#define USDSHADE_API
Definition: api.h:40
USDSHADE_API TfStaticData< UsdShadeTokensType > UsdShadeTokens
const TfToken bindMaterialAs
"bindMaterialAs"
Definition: tokens.h:72
const TfToken fallbackStrength
"fallbackStrength"
Definition: tokens.h:84
const TfToken infoId
"info:id"
Definition: tokens.h:96
const TfToken materialBinding
"material:binding"
Definition: tokens.h:116
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:186
const TfToken weakerThanDescendants
"weakerThanDescendants"
Definition: tokens.h:184
const TfToken volume
"volume"
Definition: tokens.h:180
const TfToken outputs
"outputs:"
Definition: tokens.h:128
const TfToken materialVariant
"materialVariant"
Definition: tokens.h:124
const TfToken coordSys
"coordSys:"
Definition: tokens.h:76
const TfToken universalRenderContext
""
Definition: tokens.h:172
Definition: token.h:87
const TfToken interfaceOnly
"interfaceOnly"
Definition: tokens.h:108
const TfToken outputsDisplacement
"outputs:displacement"
Definition: tokens.h:132
const TfToken subIdentifier
"subIdentifier"
Definition: tokens.h:164
const TfToken displacement
"displacement"
Definition: tokens.h:80
const TfToken sdrMetadata
"sdrMetadata"
Definition: tokens.h:148
const TfToken universalSourceType
""
Definition: tokens.h:176
const TfToken surface
"surface"
Definition: tokens.h:168
const TfToken materialBind
"materialBind"
Definition: tokens.h:112
const TfToken sourceAsset
"sourceAsset"
Definition: tokens.h:152
const TfToken outputsSurface
"outputs:surface"
Definition: tokens.h:136
const TfToken id
"id"
Definition: tokens.h:92
const TfToken infoImplementationSource
"info:implementationSource"
Definition: tokens.h:100
const TfToken full
"full"
Definition: tokens.h:88
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
const TfToken allPurpose
""
Definition: tokens.h:68
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDSHADE_API UsdShadeTokensType()
const TfToken sourceCode
"sourceCode"
Definition: tokens.h:156
const TfToken strongerThanDescendants
"strongerThanDescendants"
Definition: tokens.h:160
const TfToken outputsVolume
"outputs:volume"
Definition: tokens.h:140
const TfToken inputs
"inputs:"
Definition: tokens.h:104