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 USDKARMA_TOKENS_H
25 #define USDKARMA_TOKENS_H
26 
27 /// \file usdKarma/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 usdKarmaTokensType
46 ///
47 /// \link usdKarmaTokens \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 /// usdKarmaTokens also contains all of the \em allowedTokens values
57 /// declared for schema builtin attributes of 'token' scene description type.
58 /// Use usdKarmaTokens like so:
59 ///
60 /// \code
61 /// gprim.GetMyTokenValuedAttr().Set(usdKarmaTokens->aov);
62 /// \endcode
65  /// \brief "aov"
66  ///
67  /// Property namespace prefix for the usdKarmaAOVSettingsAPI schema.
68  const TfToken aov;
69  /// \brief "average"
70  ///
71  /// Possible value for usdKarmaAOVSettingsAPI::GetKarmaPlaneSamplingAttr(), Default value for usdKarmaAOVSettingsAPI::GetKarmaPlaneSamplingAttr()
73  /// \brief "karma:camera:lensshader"
74  ///
75  /// usdKarmaCameraSettingsAPI
77  /// \brief "karma:camera:orthowidth"
78  ///
79  /// usdKarmaCameraSettingsAPI
81  /// \brief "karma:camera:projection"
82  ///
83  /// usdKarmaCameraSettingsAPI
85  /// \brief "karma:camera:window"
86  ///
87  /// usdKarmaCameraSettingsAPI
89  /// \brief "karma:command:checkpoint"
90  ///
91  /// usdKarmaCommandSettingsAPI
93  /// \brief "karma:command:frame"
94  ///
95  /// usdKarmaCommandSettingsAPI
97  /// \brief "karma:command:frame_count"
98  ///
99  /// usdKarmaCommandSettingsAPI
101  /// \brief "karma:command:frame_inc"
102  ///
103  /// usdKarmaCommandSettingsAPI
105  /// \brief "karma:command:timelimit"
106  ///
107  /// usdKarmaCommandSettingsAPI
109  /// \brief "karma:command:timelimit_image"
110  ///
111  /// usdKarmaCommandSettingsAPI
113  /// \brief "karma:command:timelimit_nosave_partial"
114  ///
115  /// usdKarmaCommandSettingsAPI
117  /// \brief "karma:global:abortmissingtexture"
118  ///
119  /// usdKarmaRendererSettingsAPI
121  /// \brief "karma:global:cacheratio"
122  ///
123  /// usdKarmaRendererSettingsAPI
125  /// \brief "karma:global:cachesize"
126  ///
127  /// usdKarmaRendererSettingsAPI
129  /// \brief "karma:global:colorlimit"
130  ///
131  /// usdKarmaRendererSettingsAPI
133  /// \brief "karma:global:dicingcamera"
134  ///
135  /// usdKarmaRendererSettingsAPI
137  /// \brief "karma:global:diffusecomponents"
138  ///
139  /// usdKarmaRendererSettingsAPI
141  /// \brief "karma:global:disable_lighting"
142  ///
143  /// usdKarmaRendererSettingsAPI
145  /// \brief "karma:global:enable_dof"
146  ///
147  /// usdKarmaRendererSettingsAPI
149  /// \brief "karma:global:exportcomponents"
150  ///
151  /// usdKarmaRendererSettingsAPI
153  /// \brief "karma:global:head_ao_distance"
154  ///
155  /// usdKarmaRendererSettingsAPI
157  /// \brief "karma:global:head_ao_samples"
158  ///
159  /// usdKarmaRendererSettingsAPI
161  /// \brief "karma:global:head_depthcue_alpha"
162  ///
163  /// usdKarmaRendererSettingsAPI
165  /// \brief "karma:global:head_depthcue_color"
166  ///
167  /// usdKarmaRendererSettingsAPI
169  /// \brief "karma:global:head_depthcue_z"
170  ///
171  /// usdKarmaRendererSettingsAPI
173  /// \brief "karma:global:imagefilter"
174  ///
175  /// usdKarmaRendererSettingsAPI
177  /// \brief "karma:global:ipr_inc_random"
178  ///
179  /// usdKarmaRendererSettingsAPI
181  /// \brief "karma:global:ipr_proxy_for_imagefilter"
182  ///
183  /// usdKarmaRendererSettingsAPI
185  /// \brief "karma:global:ipr_proxydepth"
186  ///
187  /// usdKarmaRendererSettingsAPI
189  /// \brief "karma:global:ipr_reserve_threads"
190  ///
191  /// usdKarmaRendererSettingsAPI
193  /// \brief "karma:global:light_sampling_mode"
194  ///
195  /// usdKarmaRendererSettingsAPI
197  /// \brief "karma:global:light_sampling_quality"
198  ///
199  /// usdKarmaRendererSettingsAPI
201  /// \brief "karma:global:offscreenquality"
202  ///
203  /// usdKarmaRendererSettingsAPI
205  /// \brief "karma:global:pixeloracle"
206  ///
207  /// usdKarmaRendererSettingsAPI
209  /// \brief "karma:global:randomseed"
210  ///
211  /// usdKarmaRendererSettingsAPI
213  /// \brief "karma:global:raybias"
214  ///
215  /// usdKarmaRendererSettingsAPI
217  /// \brief "karma:global:refractcomponents"
218  ///
219  /// usdKarmaRendererSettingsAPI
221  /// \brief "karma:global:rendercamera"
222  ///
223  /// usdKarmaRendererSettingsAPI
225  /// \brief "karma:global:samplefilter"
226  ///
227  /// usdKarmaRendererSettingsAPI
229  /// \brief "karma:global:samplesperpixel"
230  ///
231  /// usdKarmaRendererSettingsAPI
233  /// \brief "karma:global:screendoorlimit"
234  ///
235  /// usdKarmaRendererSettingsAPI
237  /// \brief "karma:global:ssscomponents"
238  ///
239  /// usdKarmaRendererSettingsAPI
241  /// \brief "karma:global:tilesize"
242  ///
243  /// usdKarmaRendererSettingsAPI
245  /// \brief "karma:global:usecacheratio"
246  ///
247  /// usdKarmaRendererSettingsAPI
249  /// \brief "karma:global:volumecomponents"
250  ///
251  /// usdKarmaRendererSettingsAPI
253  /// \brief "karma:light:activeradius"
254  ///
255  /// usdKarmaLightSettingsAPI
257  /// \brief "karma:light:category"
258  ///
259  /// usdKarmaLightSettingsAPI
261  /// \brief "karma:light:distant_blur"
262  ///
263  /// usdKarmaLightSettingsAPI
265  /// \brief "karma:light:force_uniform_sampling"
266  ///
267  /// usdKarmaLightSettingsAPI
269  /// \brief "karma:light:hdri_max_isize"
270  ///
271  /// usdKarmaLightSettingsAPI
273  /// \brief "karma:light:misbias"
274  ///
275  /// usdKarmaLightSettingsAPI
277  /// \brief "karma:light:samplingquality"
278  ///
279  /// usdKarmaLightSettingsAPI
281  /// \brief "karma:light:shadowtraceset"
282  ///
283  /// usdKarmaLightSettingsAPI
285  /// \brief "karma:light:singlesided"
286  ///
287  /// usdKarmaLightSettingsAPI
289  /// \brief "karma:plane:defaultvalue"
290  ///
291  /// usdKarmaAOVSettingsAPI
293  /// \brief "karma:plane:disable"
294  ///
295  /// usdKarmaAOVSettingsAPI
297  /// \brief "karma:plane:dither"
298  ///
299  /// usdKarmaAOVSettingsAPI
301  /// \brief "karma:plane:exclude_dcm"
302  ///
303  /// usdKarmaAOVSettingsAPI
305  /// \brief "karma:plane:filename"
306  ///
307  /// usdKarmaAOVSettingsAPI
309  /// \brief "karma:plane:filter"
310  ///
311  /// usdKarmaAOVSettingsAPI
313  /// \brief "karma:plane:sampling"
314  ///
315  /// usdKarmaAOVSettingsAPI
317  /// \brief "Light Tree"
318  ///
319  /// Possible value for usdKarmaRendererSettingsAPI::GetKarmaGlobalLight_sampling_modeAttr(), Default value for usdKarmaRendererSettingsAPI::GetKarmaGlobalLight_sampling_modeAttr()
321  /// \brief "Uniform"
322  ///
323  /// Possible value for usdKarmaRendererSettingsAPI::GetKarmaGlobalLight_sampling_modeAttr()
325  /// \brief "zfar"
326  ///
327  /// Possible value for usdKarmaAOVSettingsAPI::GetKarmaPlaneSamplingAttr()
328  const TfToken zfar;
329  /// \brief "znear"
330  ///
331  /// Possible value for usdKarmaAOVSettingsAPI::GetKarmaPlaneSamplingAttr()
332  const TfToken znear;
333  /// A vector of all of the tokens listed above.
334  const std::vector<TfToken> allTokens;
335 };
336 
337 /// \var usdKarmaTokens
338 ///
339 /// A global variable with static, efficient \link TfToken TfTokens\endlink
340 /// for use in all public USD API. \sa usdKarmaTokensType
342 
344 
345 #endif
const TfToken karmaGlobalRendercamera
"karma:global:rendercamera"
Definition: tokens.h:224
#define USDKARMA_API
Definition: api.h:45
const TfToken karmaCommandFrame
"karma:command:frame"
Definition: tokens.h:96
const TfToken karmaLightMisbias
"karma:light:misbias"
Definition: tokens.h:276
const TfToken karmaGlobalLight_sampling_mode
"karma:global:light_sampling_mode"
Definition: tokens.h:196
const TfToken karmaCameraLensshader
"karma:camera:lensshader"
Definition: tokens.h:76
const TfToken karmaLightHdri_max_isize
"karma:light:hdri_max_isize"
Definition: tokens.h:272
USDKARMA_API usdKarmaTokensType()
Definition: tokens.cpp:28
const TfToken karmaGlobalHead_depthcue_color
"karma:global:head_depthcue_color"
Definition: tokens.h:168
const TfToken karmaGlobalRaybias
"karma:global:raybias"
Definition: tokens.h:216
const TfToken karmaGlobalAbortmissingtexture
"karma:global:abortmissingtexture"
Definition: tokens.h:120
const TfToken karmaGlobalColorlimit
"karma:global:colorlimit"
Definition: tokens.h:132
const TfToken karmaGlobalIpr_inc_random
"karma:global:ipr_inc_random"
Definition: tokens.h:180
const TfToken karmaGlobalHead_ao_samples
"karma:global:head_ao_samples"
Definition: tokens.h:160
const TfToken karmaGlobalHead_depthcue_z
"karma:global:head_depthcue_z"
Definition: tokens.h:172
const TfToken lightTree
"Light Tree"
Definition: tokens.h:320
const TfToken karmaGlobalLight_sampling_quality
"karma:global:light_sampling_quality"
Definition: tokens.h:200
const TfToken karmaCommandTimelimit
"karma:command:timelimit"
Definition: tokens.h:108
const TfToken karmaGlobalDiffusecomponents
"karma:global:diffusecomponents"
Definition: tokens.h:140
const TfToken karmaCommandCheckpoint
"karma:command:checkpoint"
Definition: tokens.h:92
const TfToken karmaLightCategory
"karma:light:category"
Definition: tokens.h:260
const TfToken karmaGlobalEnable_dof
"karma:global:enable_dof"
Definition: tokens.h:148
const TfToken karmaGlobalRandomseed
"karma:global:randomseed"
Definition: tokens.h:212
const TfToken karmaGlobalIpr_proxy_for_imagefilter
"karma:global:ipr_proxy_for_imagefilter"
Definition: tokens.h:184
const TfToken karmaGlobalSamplefilter
"karma:global:samplefilter"
Definition: tokens.h:228
const TfToken karmaGlobalCacheratio
"karma:global:cacheratio"
Definition: tokens.h:124
const TfToken karmaLightForce_uniform_sampling
"karma:light:force_uniform_sampling"
Definition: tokens.h:268
const TfToken karmaLightSinglesided
"karma:light:singlesided"
Definition: tokens.h:288
const TfToken karmaLightActiveradius
"karma:light:activeradius"
Definition: tokens.h:256
const TfToken karmaGlobalVolumecomponents
"karma:global:volumecomponents"
Definition: tokens.h:252
const TfToken karmaLightDistant_blur
"karma:light:distant_blur"
Definition: tokens.h:264
const TfToken karmaGlobalUsecacheratio
"karma:global:usecacheratio"
Definition: tokens.h:248
Definition: token.h:89
const TfToken karmaCommandTimelimit_image
"karma:command:timelimit_image"
Definition: tokens.h:112
const TfToken karmaGlobalOffscreenquality
"karma:global:offscreenquality"
Definition: tokens.h:204
const TfToken karmaGlobalPixeloracle
"karma:global:pixeloracle"
Definition: tokens.h:208
const TfToken karmaGlobalIpr_proxydepth
"karma:global:ipr_proxydepth"
Definition: tokens.h:188
const TfToken karmaPlaneSampling
"karma:plane:sampling"
Definition: tokens.h:316
const TfToken karmaLightSamplingquality
"karma:light:samplingquality"
Definition: tokens.h:280
const TfToken karmaGlobalScreendoorlimit
"karma:global:screendoorlimit"
Definition: tokens.h:236
const TfToken karmaCameraProjection
"karma:camera:projection"
Definition: tokens.h:84
const TfToken aov
"aov"
Definition: tokens.h:68
const TfToken karmaCameraOrthowidth
"karma:camera:orthowidth"
Definition: tokens.h:80
const std::vector< TfToken > allTokens
A vector of all of the tokens listed above.
Definition: tokens.h:334
const TfToken karmaPlaneDisable
"karma:plane:disable"
Definition: tokens.h:296
USDKARMA_API TfStaticData< usdKarmaTokensType > & usdKarmaTokens()
Definition: tokens.cpp:168
const TfToken uniform
"Uniform"
Definition: tokens.h:324
const TfToken karmaGlobalIpr_reserve_threads
"karma:global:ipr_reserve_threads"
Definition: tokens.h:192
const TfToken karmaPlaneDither
"karma:plane:dither"
Definition: tokens.h:300
const TfToken karmaGlobalDisable_lighting
"karma:global:disable_lighting"
Definition: tokens.h:144
const TfToken znear
"znear"
Definition: tokens.h:332
const TfToken karmaLightShadowtraceset
"karma:light:shadowtraceset"
Definition: tokens.h:284
const TfToken karmaCommandFrame_inc
"karma:command:frame_inc"
Definition: tokens.h:104
const TfToken karmaPlaneDefaultvalue
"karma:plane:defaultvalue"
Definition: tokens.h:292
const TfToken karmaGlobalImagefilter
"karma:global:imagefilter"
Definition: tokens.h:176
const TfToken karmaCommandFrame_count
"karma:command:frame_count"
Definition: tokens.h:100
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1245
const TfToken average
"average"
Definition: tokens.h:72
const TfToken karmaCameraWindow
"karma:camera:window"
Definition: tokens.h:88
const TfToken karmaGlobalHead_ao_distance
"karma:global:head_ao_distance"
Definition: tokens.h:156
const TfToken karmaGlobalTilesize
"karma:global:tilesize"
Definition: tokens.h:244
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:83
const TfToken karmaGlobalSamplesperpixel
"karma:global:samplesperpixel"
Definition: tokens.h:232
const TfToken karmaGlobalHead_depthcue_alpha
"karma:global:head_depthcue_alpha"
Definition: tokens.h:164
const TfToken karmaGlobalSsscomponents
"karma:global:ssscomponents"
Definition: tokens.h:240
const TfToken karmaPlaneFilter
"karma:plane:filter"
Definition: tokens.h:312
const TfToken karmaGlobalDicingcamera
"karma:global:dicingcamera"
Definition: tokens.h:136
const TfToken zfar
"zfar"
Definition: tokens.h:328
const TfToken karmaPlaneExclude_dcm
"karma:plane:exclude_dcm"
Definition: tokens.h:304
const TfToken karmaCommandTimelimit_nosave_partial
"karma:command:timelimit_nosave_partial"
Definition: tokens.h:116
const TfToken karmaPlaneFilename
"karma:plane:filename"
Definition: tokens.h:308
const TfToken karmaGlobalRefractcomponents
"karma:global:refractcomponents"
Definition: tokens.h:220
const TfToken karmaGlobalCachesize
"karma:global:cachesize"
Definition: tokens.h:128
const TfToken karmaGlobalExportcomponents
"karma:global:exportcomponents"
Definition: tokens.h:152