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 USDLUX_TOKENS_H
25 #define USDLUX_TOKENS_H
26 
27 /// \file usdLux/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/usdLux/api.h"
38 #include "pxr/base/tf/staticData.h"
39 #include "pxr/base/tf/token.h"
40 #include <vector>
41 
43 
44 
45 /// \class UsdLuxTokensType
46 ///
47 /// \link UsdLuxTokens \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 /// UsdLuxTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use UsdLuxTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(UsdLuxTokens->angular);
62 /// \endcode
65  /// \brief "angular"
66  ///
67  /// Possible value for UsdLuxDomeLight::GetTextureFormatAttr()
69  /// \brief "automatic"
70  ///
71  /// Possible value for UsdLuxDomeLight::GetTextureFormatAttr(), Default value for UsdLuxDomeLight::GetTextureFormatAttr()
73  /// \brief "collection:filterLink:includeRoot"
74  ///
75  /// UsdLuxLightFilter
77  /// \brief "collection:lightLink:includeRoot"
78  ///
79  /// UsdLuxLightAPI
81  /// \brief "collection:shadowLink:includeRoot"
82  ///
83  /// UsdLuxLightAPI
85  /// \brief "consumeAndContinue"
86  ///
87  /// Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr()
89  /// \brief "consumeAndHalt"
90  ///
91  /// Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr()
93  /// \brief "cubeMapVerticalCross"
94  ///
95  /// Possible value for UsdLuxDomeLight::GetTextureFormatAttr()
97  /// \brief "CylinderLight"
98  ///
99  /// Default value for UsdLuxCylinderLight schema attribute light:shaderId
101  /// \brief "DiskLight"
102  ///
103  /// Default value for UsdLuxDiskLight schema attribute light:shaderId
105  /// \brief "DistantLight"
106  ///
107  /// Default value for UsdLuxDistantLight schema attribute light:shaderId
109  /// \brief "DomeLight"
110  ///
111  /// Default value for UsdLuxDomeLight schema attribute light:shaderId
113  /// \brief "extent"
114  ///
115  /// UsdLuxPortalLight
117  /// \brief "filterLink"
118  ///
119  /// This token represents the collection name to use with UsdCollectionAPI to represent filter-linking of a UsdLuxLightFilter prim.
121  /// \brief "geometry"
122  ///
123  /// UsdLuxGeometryLight
125  /// \brief "GeometryLight"
126  ///
127  /// Default value for UsdLuxGeometryLight schema attribute light:shaderId
129  /// \brief "guideRadius"
130  ///
131  /// UsdLuxDomeLight
133  /// \brief "ignore"
134  ///
135  /// Possible value for UsdLuxListAPI::GetLightListCacheBehaviorAttr(), Possible value for UsdLuxLightListAPI::GetLightListCacheBehaviorAttr()
137  /// \brief "independent"
138  ///
139  /// Possible value for UsdLuxLightAPI::GetMaterialSyncModeAttr()
141  /// \brief "inputs:angle"
142  ///
143  /// UsdLuxDistantLight
145  /// \brief "inputs:color"
146  ///
147  /// UsdLuxLightAPI
149  /// \brief "inputs:colorTemperature"
150  ///
151  /// UsdLuxLightAPI
153  /// \brief "inputs:diffuse"
154  ///
155  /// UsdLuxLightAPI
157  /// \brief "inputs:enableColorTemperature"
158  ///
159  /// UsdLuxLightAPI
161  /// \brief "inputs:exposure"
162  ///
163  /// UsdLuxLightAPI
165  /// \brief "inputs:height"
166  ///
167  /// UsdLuxRectLight
169  /// \brief "inputs:intensity"
170  ///
171  /// UsdLuxDistantLight, UsdLuxLightAPI
173  /// \brief "inputs:length"
174  ///
175  /// UsdLuxCylinderLight
177  /// \brief "inputs:normalize"
178  ///
179  /// UsdLuxLightAPI
181  /// \brief "inputs:radius"
182  ///
183  /// UsdLuxCylinderLight, UsdLuxSphereLight, UsdLuxDiskLight
185  /// \brief "inputs:shadow:color"
186  ///
187  /// UsdLuxShadowAPI
189  /// \brief "inputs:shadow:distance"
190  ///
191  /// UsdLuxShadowAPI
193  /// \brief "inputs:shadow:enable"
194  ///
195  /// UsdLuxShadowAPI
197  /// \brief "inputs:shadow:falloff"
198  ///
199  /// UsdLuxShadowAPI
201  /// \brief "inputs:shadow:falloffGamma"
202  ///
203  /// UsdLuxShadowAPI
205  /// \brief "inputs:shaping:cone:angle"
206  ///
207  /// UsdLuxShapingAPI
209  /// \brief "inputs:shaping:cone:softness"
210  ///
211  /// UsdLuxShapingAPI
213  /// \brief "inputs:shaping:focus"
214  ///
215  /// UsdLuxShapingAPI
217  /// \brief "inputs:shaping:focusTint"
218  ///
219  /// UsdLuxShapingAPI
221  /// \brief "inputs:shaping:ies:angleScale"
222  ///
223  /// UsdLuxShapingAPI
225  /// \brief "inputs:shaping:ies:file"
226  ///
227  /// UsdLuxShapingAPI
229  /// \brief "inputs:shaping:ies:normalize"
230  ///
231  /// UsdLuxShapingAPI
233  /// \brief "inputs:specular"
234  ///
235  /// UsdLuxLightAPI
237  /// \brief "inputs:texture:file"
238  ///
239  /// UsdLuxDomeLight, UsdLuxRectLight
241  /// \brief "inputs:texture:format"
242  ///
243  /// UsdLuxDomeLight
245  /// \brief "inputs:width"
246  ///
247  /// UsdLuxRectLight
249  /// \brief "latlong"
250  ///
251  /// Possible value for UsdLuxDomeLight::GetTextureFormatAttr()
253  /// \brief "light:filters"
254  ///
255  /// UsdLuxLightAPI
257  /// \brief "lightFilter:shaderId"
258  ///
259  /// UsdLuxLightFilter
261  /// \brief "lightLink"
262  ///
263  /// This token represents the collection name to use with UsdCollectionAPI to represent light-linking of a prim with an applied UsdLuxLightAPI.
265  /// \brief "lightList"
266  ///
267  /// UsdLuxListAPI, UsdLuxLightListAPI
269  /// \brief "lightList:cacheBehavior"
270  ///
271  /// UsdLuxListAPI, UsdLuxLightListAPI
273  /// \brief "light:materialSyncMode"
274  ///
275  /// UsdLuxVolumeLightAPI, UsdLuxMeshLightAPI, UsdLuxLightAPI
277  /// \brief "light:shaderId"
278  ///
279  /// UsdLuxPortalLight, UsdLuxDomeLight, UsdLuxGeometryLight, UsdLuxCylinderLight, UsdLuxSphereLight, UsdLuxRectLight, UsdLuxDiskLight, UsdLuxDistantLight, UsdLuxVolumeLightAPI, UsdLuxMeshLightAPI, UsdLuxLightAPI
281  /// \brief "materialGlowTintsLight"
282  ///
283  /// Default value for UsdLuxVolumeLightAPI schema attribute light:materialSyncMode, Default value for UsdLuxMeshLightAPI schema attribute light:materialSyncMode, Possible value for UsdLuxLightAPI::GetMaterialSyncModeAttr()
285  /// \brief "MeshLight"
286  ///
287  /// Default value for UsdLuxMeshLightAPI schema attribute light:shaderId
289  /// \brief "mirroredBall"
290  ///
291  /// Possible value for UsdLuxDomeLight::GetTextureFormatAttr()
293  /// \brief "noMaterialResponse"
294  ///
295  /// Possible value for UsdLuxLightAPI::GetMaterialSyncModeAttr(), Default value for UsdLuxLightAPI::GetMaterialSyncModeAttr()
297  /// \brief "orientToStageUpAxis"
298  ///
299  /// This token represents the suffix for a UsdGeomXformOp used to orient a light with the stage's up axis.
301  /// \brief "PortalLight"
302  ///
303  /// Default value for UsdLuxPortalLight schema attribute light:shaderId
305  /// \brief "portals"
306  ///
307  /// UsdLuxDomeLight
309  /// \brief "RectLight"
310  ///
311  /// Default value for UsdLuxRectLight schema attribute light:shaderId
313  /// \brief "shadowLink"
314  ///
315  /// This token represents the collection name to use with UsdCollectionAPI to represent shadow-linking of a prim with an applied UsdLuxLightAPI.
317  /// \brief "SphereLight"
318  ///
319  /// Default value for UsdLuxSphereLight schema attribute light:shaderId
321  /// \brief "treatAsLine"
322  ///
323  /// UsdLuxCylinderLight
325  /// \brief "treatAsPoint"
326  ///
327  /// UsdLuxSphereLight
329  /// \brief "VolumeLight"
330  ///
331  /// Default value for UsdLuxVolumeLightAPI schema attribute light:shaderId
333  /// A vector of all of the tokens listed above.
334  const std::vector<TfToken> allTokens;
335 };
336 
337 /// \var UsdLuxTokens
338 ///
339 /// A global variable with static, efficient \link TfToken TfTokens\endlink
340 /// for use in all public USD API. \sa UsdLuxTokensType
342 
344 
345 #endif
const TfToken inputsShadowColor
"inputs:shadow:color"
Definition: tokens.h:188
const TfToken guideRadius
"guideRadius"
Definition: tokens.h:132
const TfToken inputsShadowEnable
"inputs:shadow:enable"
Definition: tokens.h:196
const TfToken inputsTextureFile
"inputs:texture:file"
Definition: tokens.h:240
const TfToken shadowLink
"shadowLink"
Definition: tokens.h:316
const TfToken lightFilterShaderId
"lightFilter:shaderId"
Definition: tokens.h:260
const TfToken inputsTextureFormat
"inputs:texture:format"
Definition: tokens.h:244
const TfToken inputsColorTemperature
"inputs:colorTemperature"
Definition: tokens.h:152
const TfToken inputsSpecular
"inputs:specular"
Definition: tokens.h:236
const TfToken collectionLightLinkIncludeRoot
"collection:lightLink:includeRoot"
Definition: tokens.h:80
const TfToken inputsRadius
"inputs:radius"
Definition: tokens.h:184
#define USDLUX_API
Definition: api.h:40
const TfToken inputsWidth
"inputs:width"
Definition: tokens.h:248
const TfToken distantLight
"DistantLight"
Definition: tokens.h:108
const TfToken consumeAndHalt
"consumeAndHalt"
Definition: tokens.h:92
const TfToken lightShaderId
"light:shaderId"
Definition: tokens.h:280
const TfToken volumeLight
"VolumeLight"
Definition: tokens.h:332
const TfToken angular
"angular"
Definition: tokens.h:68
const TfToken rectLight
"RectLight"
Definition: tokens.h:312
const TfToken lightListCacheBehavior
"lightList:cacheBehavior"
Definition: tokens.h:272
const TfToken noMaterialResponse
"noMaterialResponse"
Definition: tokens.h:296
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:334
const TfToken inputsExposure
"inputs:exposure"
Definition: tokens.h:164
const TfToken filterLink
"filterLink"
Definition: tokens.h:120
const TfToken inputsShapingConeSoftness
"inputs:shaping:cone:softness"
Definition: tokens.h:212
const TfToken treatAsPoint
"treatAsPoint"
Definition: tokens.h:328
const TfToken materialGlowTintsLight
"materialGlowTintsLight"
Definition: tokens.h:284
const TfToken orientToStageUpAxis
"orientToStageUpAxis"
Definition: tokens.h:300
const TfToken consumeAndContinue
"consumeAndContinue"
Definition: tokens.h:88
const TfToken ignore
"ignore"
Definition: tokens.h:136
const TfToken treatAsLine
"treatAsLine"
Definition: tokens.h:324
Definition: token.h:87
USDLUX_API TfStaticData< UsdLuxTokensType > UsdLuxTokens
const TfToken inputsDiffuse
"inputs:diffuse"
Definition: tokens.h:156
const TfToken inputsHeight
"inputs:height"
Definition: tokens.h:168
const TfToken diskLight
"DiskLight"
Definition: tokens.h:104
const TfToken mirroredBall
"mirroredBall"
Definition: tokens.h:292
const TfToken inputsEnableColorTemperature
"inputs:enableColorTemperature"
Definition: tokens.h:160
const TfToken lightList
"lightList"
Definition: tokens.h:268
const TfToken inputsNormalize
"inputs:normalize"
Definition: tokens.h:180
const TfToken portals
"portals"
Definition: tokens.h:308
const TfToken lightLink
"lightLink"
Definition: tokens.h:264
const TfToken collectionFilterLinkIncludeRoot
"collection:filterLink:includeRoot"
Definition: tokens.h:76
const TfToken meshLight
"MeshLight"
Definition: tokens.h:288
const TfToken collectionShadowLinkIncludeRoot
"collection:shadowLink:includeRoot"
Definition: tokens.h:84
const TfToken portalLight
"PortalLight"
Definition: tokens.h:304
const TfToken inputsAngle
"inputs:angle"
Definition: tokens.h:144
const TfToken geometryLight
"GeometryLight"
Definition: tokens.h:128
const TfToken inputsLength
"inputs:length"
Definition: tokens.h:176
const TfToken inputsColor
"inputs:color"
Definition: tokens.h:148
USDLUX_API UsdLuxTokensType()
const TfToken inputsShadowDistance
"inputs:shadow:distance"
Definition: tokens.h:192
const TfToken inputsShadowFalloffGamma
"inputs:shadow:falloffGamma"
Definition: tokens.h:204
const TfToken inputsShapingFocusTint
"inputs:shaping:focusTint"
Definition: tokens.h:220
const TfToken inputsShapingConeAngle
"inputs:shaping:cone:angle"
Definition: tokens.h:208
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1394
const TfToken domeLight
"DomeLight"
Definition: tokens.h:112
const TfToken geometry
"geometry"
Definition: tokens.h:124
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
const TfToken inputsIntensity
"inputs:intensity"
Definition: tokens.h:172
const TfToken cylinderLight
"CylinderLight"
Definition: tokens.h:100
const TfToken inputsShapingIesFile
"inputs:shaping:ies:file"
Definition: tokens.h:228
const TfToken extent
"extent"
Definition: tokens.h:116
const TfToken sphereLight
"SphereLight"
Definition: tokens.h:320
const TfToken lightFilters
"light:filters"
Definition: tokens.h:256
const TfToken automatic
"automatic"
Definition: tokens.h:72
const TfToken inputsShadowFalloff
"inputs:shadow:falloff"
Definition: tokens.h:200
const TfToken inputsShapingFocus
"inputs:shaping:focus"
Definition: tokens.h:216
const TfToken inputsShapingIesAngleScale
"inputs:shaping:ies:angleScale"
Definition: tokens.h:224
const TfToken inputsShapingIesNormalize
"inputs:shaping:ies:normalize"
Definition: tokens.h:232
const TfToken independent
"independent"
Definition: tokens.h:140
const TfToken cubeMapVerticalCross
"cubeMapVerticalCross"
Definition: tokens.h:96
const TfToken latlong
"latlong"
Definition: tokens.h:252
const TfToken lightMaterialSyncMode
"light:materialSyncMode"
Definition: tokens.h:276