HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrCookieLightFilter.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 USDRI_GENERATED_PXRCOOKIELIGHTFILTER_H
25 #define USDRI_GENERATED_PXRCOOKIELIGHTFILTER_H
26 
27 /// \file usdRi/pxrCookieLightFilter.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
32 #include "pxr/usd/usd/prim.h"
33 #include "pxr/usd/usd/stage.h"
34 #include "pxr/usd/usdRi/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PXRCOOKIELIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiPxrCookieLightFilter
54 ///
55 ///
56 /// \deprecated This schema will be replaced in a future release.
57 /// A textured surface that filters light.
58 ///
59 ///
60 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
61 /// that are text/tokens, the actual token is published and defined in \ref UsdRiTokens.
62 /// So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded
63 /// as the value.
64 ///
66 {
67 public:
68  /// Compile time constant representing what kind of schema this class is.
69  ///
70  /// \sa UsdSchemaKind
72 
73  /// Construct a UsdRiPxrCookieLightFilter on UsdPrim \p prim .
74  /// Equivalent to UsdRiPxrCookieLightFilter::Get(prim.GetStage(), prim.GetPath())
75  /// for a \em valid \p prim, but will not immediately throw an error for
76  /// an invalid \p prim
77  explicit UsdRiPxrCookieLightFilter(const UsdPrim& prim=UsdPrim())
78  : UsdLuxLightFilter(prim)
79  {
80  }
81 
82  /// Construct a UsdRiPxrCookieLightFilter on the prim held by \p schemaObj .
83  /// Should be preferred over UsdRiPxrCookieLightFilter(schemaObj.GetPrim()),
84  /// as it preserves SchemaBase state.
85  explicit UsdRiPxrCookieLightFilter(const UsdSchemaBase& schemaObj)
86  : UsdLuxLightFilter(schemaObj)
87  {
88  }
89 
90  /// Destructor.
91  USDRI_API
93 
94  /// Return a vector of names of all pre-declared attributes for this schema
95  /// class and all its ancestor classes. Does not include attributes that
96  /// may be authored by custom/extended methods of the schemas involved.
97  USDRI_API
98  static const TfTokenVector &
99  GetSchemaAttributeNames(bool includeInherited=true);
100 
101  /// Return a UsdRiPxrCookieLightFilter holding the prim adhering to this
102  /// schema at \p path on \p stage. If no prim exists at \p path on
103  /// \p stage, or if the prim at that path does not adhere to this schema,
104  /// return an invalid schema object. This is shorthand for the following:
105  ///
106  /// \code
107  /// UsdRiPxrCookieLightFilter(stage->GetPrimAtPath(path));
108  /// \endcode
109  ///
110  USDRI_API
112  Get(const UsdStagePtr &stage, const SdfPath &path);
113 
114  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
115  /// is defined (according to UsdPrim::IsDefined()) on this stage.
116  ///
117  /// If a prim adhering to this schema at \p path is already defined on this
118  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
119  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
120  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
121  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
122  /// current EditTarget for any nonexistent, or existing but not \a Defined
123  /// ancestors.
124  ///
125  /// The given \a path must be an absolute prim path that does not contain
126  /// any variant selections.
127  ///
128  /// If it is impossible to author any of the necessary PrimSpecs, (for
129  /// example, in case \a path cannot map to the current UsdEditTarget's
130  /// namespace) issue an error and return an invalid \a UsdPrim.
131  ///
132  /// Note that this method may return a defined prim whose typeName does not
133  /// specify this schema class, in case a stronger typeName opinion overrides
134  /// the opinion at the current EditTarget.
135  ///
136  USDRI_API
138  Define(const UsdStagePtr &stage, const SdfPath &path);
139 
140 protected:
141  /// Returns the kind of schema this class belongs to.
142  ///
143  /// \sa UsdSchemaKind
144  USDRI_API
145  UsdSchemaKind _GetSchemaKind() const override;
146 
147 private:
148  // needs to invoke _GetStaticTfType.
149  friend class UsdSchemaRegistry;
150  USDRI_API
151  static const TfType &_GetStaticTfType();
152 
153  static bool _IsTypedSchema();
154 
155  // override SchemaBase virtuals.
156  USDRI_API
157  const TfType &_GetTfType() const override;
158 
159 public:
160  // --------------------------------------------------------------------- //
161  // COOKIEMODE
162  // --------------------------------------------------------------------- //
163  /// Chooses a physical or analytic evaluation model for
164  /// the cookie:
165  /// - physical: The cookie behaves like a stained glass window
166  /// through which light falls. The falloff and blur are determined
167  /// by the size of the light, the distance to the light and distance
168  /// from the cookie.
169  /// - analytic: The cookie has a fixed projection and manual blur
170  /// and falloff controls.
171  ///
172  ///
173  /// | ||
174  /// | -- | -- |
175  /// | Declaration | `token cookieMode = "physical"` |
176  /// | C++ Type | TfToken |
177  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
178  /// | \ref UsdRiTokens "Allowed Values" | physical, analytic |
179  USDRI_API
181 
182  /// See GetCookieModeAttr(), and also
183  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
184  /// If specified, author \p defaultValue as the attribute's default,
185  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
186  /// the default for \p writeSparsely is \c false.
187  USDRI_API
188  UsdAttribute CreateCookieModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
189 
190 public:
191  // --------------------------------------------------------------------- //
192  // WIDTH
193  // --------------------------------------------------------------------- //
194  /// Width of the rect the light is shining through.
195  ///
196  /// | ||
197  /// | -- | -- |
198  /// | Declaration | `float width = 1` |
199  /// | C++ Type | float |
200  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
201  USDRI_API
202  UsdAttribute GetWidthAttr() const;
203 
204  /// See GetWidthAttr(), and also
205  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
206  /// If specified, author \p defaultValue as the attribute's default,
207  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
208  /// the default for \p writeSparsely is \c false.
209  USDRI_API
210  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
211 
212 public:
213  // --------------------------------------------------------------------- //
214  // HEIGHT
215  // --------------------------------------------------------------------- //
216  /// Height of the rect the light is shining through.
217  ///
218  /// | ||
219  /// | -- | -- |
220  /// | Declaration | `float height = 1` |
221  /// | C++ Type | float |
222  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
223  USDRI_API
224  UsdAttribute GetHeightAttr() const;
225 
226  /// See GetHeightAttr(), and also
227  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
228  /// If specified, author \p defaultValue as the attribute's default,
229  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
230  /// the default for \p writeSparsely is \c false.
231  USDRI_API
232  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
233 
234 public:
235  // --------------------------------------------------------------------- //
236  // TEXTUREMAP
237  // --------------------------------------------------------------------- //
238  /// A color texture to use on the cookie. May use alpha.
239  ///
240  /// | ||
241  /// | -- | -- |
242  /// | Declaration | `asset texture:map` |
243  /// | C++ Type | SdfAssetPath |
244  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Asset |
245  USDRI_API
247 
248  /// See GetTextureMapAttr(), and also
249  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
250  /// If specified, author \p defaultValue as the attribute's default,
251  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
252  /// the default for \p writeSparsely is \c false.
253  USDRI_API
254  UsdAttribute CreateTextureMapAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
255 
256 public:
257  // --------------------------------------------------------------------- //
258  // TEXTUREWRAPMODE
259  // --------------------------------------------------------------------- //
260  /// Specifies what value to use outside the texture's domain:
261  /// - off: no repeat
262  /// - repeat: repeats in X and Y
263  /// - clamp: uses the value from the nearest edge
264  ///
265  ///
266  /// | ||
267  /// | -- | -- |
268  /// | Declaration | `token texture:wrapMode = "off"` |
269  /// | C++ Type | TfToken |
270  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
271  /// | \ref UsdRiTokens "Allowed Values" | off, repeat, clamp |
272  USDRI_API
274 
275  /// See GetTextureWrapModeAttr(), and also
276  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
277  /// If specified, author \p defaultValue as the attribute's default,
278  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
279  /// the default for \p writeSparsely is \c false.
280  USDRI_API
281  UsdAttribute CreateTextureWrapModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
282 
283 public:
284  // --------------------------------------------------------------------- //
285  // TEXTUREFILLCOLOR
286  // --------------------------------------------------------------------- //
287  /// If the texture is not repeating, this specifies the
288  /// color for the region outside of and behind the projected rectangle.
289  ///
290  /// | ||
291  /// | -- | -- |
292  /// | Declaration | `color3f texture:fillColor = (1, 1, 1)` |
293  /// | C++ Type | GfVec3f |
294  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Color3f |
295  USDRI_API
297 
298  /// See GetTextureFillColorAttr(), and also
299  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
300  /// If specified, author \p defaultValue as the attribute's default,
301  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
302  /// the default for \p writeSparsely is \c false.
303  USDRI_API
304  UsdAttribute CreateTextureFillColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
305 
306 public:
307  // --------------------------------------------------------------------- //
308  // TEXTUREPREMULTIPLIEDALPHA
309  // --------------------------------------------------------------------- //
310  /// Textures are usually premultiplied by their alpha. If this not
311  /// the case, uncheck this.
312  ///
313  /// | ||
314  /// | -- | -- |
315  /// | Declaration | `bool texture:premultipliedAlpha = 1` |
316  /// | C++ Type | bool |
317  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
318  USDRI_API
320 
321  /// See GetTexturePremultipliedAlphaAttr(), and also
322  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
323  /// If specified, author \p defaultValue as the attribute's default,
324  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
325  /// the default for \p writeSparsely is \c false.
326  USDRI_API
327  UsdAttribute CreateTexturePremultipliedAlphaAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
328 
329 public:
330  // --------------------------------------------------------------------- //
331  // TEXTUREINVERTU
332  // --------------------------------------------------------------------- //
333  /// Flips the texture from left to right. By default, the
334  /// orientation of the texture as seen from the light source matches
335  /// the orientation as it is viewed in an image viewer.
336  ///
337  /// | ||
338  /// | -- | -- |
339  /// | Declaration | `bool texture:invertU = 0` |
340  /// | C++ Type | bool |
341  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
342  USDRI_API
344 
345  /// See GetTextureInvertUAttr(), and also
346  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
347  /// If specified, author \p defaultValue as the attribute's default,
348  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
349  /// the default for \p writeSparsely is \c false.
350  USDRI_API
351  UsdAttribute CreateTextureInvertUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
352 
353 public:
354  // --------------------------------------------------------------------- //
355  // TEXTUREINVERTV
356  // --------------------------------------------------------------------- //
357  /// Flips the texture from top to bottom. By default, the
358  /// orientation of the texture as seen from the light source matches
359  /// the orientation as it is viewed in an image viewer.
360  ///
361  /// | ||
362  /// | -- | -- |
363  /// | Declaration | `bool texture:invertV = 0` |
364  /// | C++ Type | bool |
365  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
366  USDRI_API
368 
369  /// See GetTextureInvertVAttr(), and also
370  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
371  /// If specified, author \p defaultValue as the attribute's default,
372  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
373  /// the default for \p writeSparsely is \c false.
374  USDRI_API
375  UsdAttribute CreateTextureInvertVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
376 
377 public:
378  // --------------------------------------------------------------------- //
379  // TEXTURESCALEU
380  // --------------------------------------------------------------------- //
381  /// Scales the U dimension.
382  ///
383  /// | ||
384  /// | -- | -- |
385  /// | Declaration | `float texture:scaleU = 1` |
386  /// | C++ Type | float |
387  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
388  USDRI_API
390 
391  /// See GetTextureScaleUAttr(), and also
392  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
393  /// If specified, author \p defaultValue as the attribute's default,
394  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
395  /// the default for \p writeSparsely is \c false.
396  USDRI_API
397  UsdAttribute CreateTextureScaleUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
398 
399 public:
400  // --------------------------------------------------------------------- //
401  // TEXTURESCALEV
402  // --------------------------------------------------------------------- //
403  /// Scales the V dimension.
404  ///
405  /// | ||
406  /// | -- | -- |
407  /// | Declaration | `float texture:scaleV = 1` |
408  /// | C++ Type | float |
409  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
410  USDRI_API
412 
413  /// See GetTextureScaleVAttr(), and also
414  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
415  /// If specified, author \p defaultValue as the attribute's default,
416  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
417  /// the default for \p writeSparsely is \c false.
418  USDRI_API
419  UsdAttribute CreateTextureScaleVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
420 
421 public:
422  // --------------------------------------------------------------------- //
423  // TEXTUREOFFSETU
424  // --------------------------------------------------------------------- //
425  /// Offsets the texture in the U direction.
426  ///
427  /// | ||
428  /// | -- | -- |
429  /// | Declaration | `float texture:offsetU = 0` |
430  /// | C++ Type | float |
431  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
432  USDRI_API
434 
435  /// See GetTextureOffsetUAttr(), and also
436  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
437  /// If specified, author \p defaultValue as the attribute's default,
438  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
439  /// the default for \p writeSparsely is \c false.
440  USDRI_API
441  UsdAttribute CreateTextureOffsetUAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
442 
443 public:
444  // --------------------------------------------------------------------- //
445  // TEXTUREOFFSETV
446  // --------------------------------------------------------------------- //
447  /// Offsets the texture in the V direction.
448  ///
449  /// | ||
450  /// | -- | -- |
451  /// | Declaration | `float texture:offsetV = 0` |
452  /// | C++ Type | float |
453  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
454  USDRI_API
456 
457  /// See GetTextureOffsetVAttr(), and also
458  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
459  /// If specified, author \p defaultValue as the attribute's default,
460  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
461  /// the default for \p writeSparsely is \c false.
462  USDRI_API
463  UsdAttribute CreateTextureOffsetVAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
464 
465 public:
466  // --------------------------------------------------------------------- //
467  // ANALYTICDIRECTIONAL
468  // --------------------------------------------------------------------- //
469  /// When this is on, the texture projects along a direction
470  /// using the orthographic projection. When it is off, the texture
471  /// projects using a focal point specified by the analytic:apex.
472  ///
473  /// | ||
474  /// | -- | -- |
475  /// | Declaration | `bool analytic:directional = 0` |
476  /// | C++ Type | bool |
477  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
478  USDRI_API
480 
481  /// See GetAnalyticDirectionalAttr(), and also
482  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
483  /// If specified, author \p defaultValue as the attribute's default,
484  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
485  /// the default for \p writeSparsely is \c false.
486  USDRI_API
487  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
488 
489 public:
490  // --------------------------------------------------------------------- //
491  // ANALYTICSHEARX
492  // --------------------------------------------------------------------- //
493  /// Shear the projection along the X axis.
494  ///
495  /// | ||
496  /// | -- | -- |
497  /// | Declaration | `float analytic:shearX = 0` |
498  /// | C++ Type | float |
499  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
500  USDRI_API
502 
503  /// See GetAnalyticShearXAttr(), and also
504  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
505  /// If specified, author \p defaultValue as the attribute's default,
506  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
507  /// the default for \p writeSparsely is \c false.
508  USDRI_API
509  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
510 
511 public:
512  // --------------------------------------------------------------------- //
513  // ANALYTICSHEARY
514  // --------------------------------------------------------------------- //
515  /// Shear the projection along the Y axis.
516  ///
517  /// | ||
518  /// | -- | -- |
519  /// | Declaration | `float analytic:shearY = 0` |
520  /// | C++ Type | float |
521  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
522  USDRI_API
524 
525  /// See GetAnalyticShearYAttr(), and also
526  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
527  /// If specified, author \p defaultValue as the attribute's default,
528  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
529  /// the default for \p writeSparsely is \c false.
530  USDRI_API
531  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
532 
533 public:
534  // --------------------------------------------------------------------- //
535  // ANALYTICAPEX
536  // --------------------------------------------------------------------- //
537  /// Distance between the center of cookie and the center of projection.
538  ///
539  /// | ||
540  /// | -- | -- |
541  /// | Declaration | `float analytic:apex = 25` |
542  /// | C++ Type | float |
543  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
544  USDRI_API
546 
547  /// See GetAnalyticApexAttr(), and also
548  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
549  /// If specified, author \p defaultValue as the attribute's default,
550  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
551  /// the default for \p writeSparsely is \c false.
552  USDRI_API
553  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
554 
555 public:
556  // --------------------------------------------------------------------- //
557  // ANALYTICUSELIGHTDIRECTION
558  // --------------------------------------------------------------------- //
559  /// When this is on, If this is on, the projection direction
560  /// is determined by the position of the center of the light source.
561  /// Otherwise, it only follows the orientation of the filter. WARNING:
562  /// This does not work with dome and mesh lights.
563  ///
564  /// | ||
565  /// | -- | -- |
566  /// | Declaration | `bool analytic:useLightDirection = 0` |
567  /// | C++ Type | bool |
568  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
569  USDRI_API
571 
572  /// See GetAnalyticUseLightDirectionAttr(), and also
573  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
574  /// If specified, author \p defaultValue as the attribute's default,
575  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
576  /// the default for \p writeSparsely is \c false.
577  USDRI_API
578  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
579 
580 public:
581  // --------------------------------------------------------------------- //
582  // ANALYTICBLURAMOUNT
583  // --------------------------------------------------------------------- //
584  /// Specify the blur of projected texture from 0-1. This
585  /// gets multiplied by the blurNear/blurFar interpolation. This
586  /// blurs between the projected color and the fill color when the
587  /// texture is not repeating.
588  ///
589  /// | ||
590  /// | -- | -- |
591  /// | Declaration | `float analytic:blur:amount = 0` |
592  /// | C++ Type | float |
593  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
594  USDRI_API
596 
597  /// See GetAnalyticBlurAmountAttr(), and also
598  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
599  /// If specified, author \p defaultValue as the attribute's default,
600  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
601  /// the default for \p writeSparsely is \c false.
602  USDRI_API
603  UsdAttribute CreateAnalyticBlurAmountAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
604 
605 public:
606  // --------------------------------------------------------------------- //
607  // ANALYTICBLURSMULT
608  // --------------------------------------------------------------------- //
609  /// Blur multiplier in the S direction.
610  ///
611  /// | ||
612  /// | -- | -- |
613  /// | Declaration | `float analytic:blur:sMult = 0` |
614  /// | C++ Type | float |
615  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
616  USDRI_API
618 
619  /// See GetAnalyticBlurSMultAttr(), and also
620  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
621  /// If specified, author \p defaultValue as the attribute's default,
622  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
623  /// the default for \p writeSparsely is \c false.
624  USDRI_API
625  UsdAttribute CreateAnalyticBlurSMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
626 
627 public:
628  // --------------------------------------------------------------------- //
629  // ANALYTICBLURTMULT
630  // --------------------------------------------------------------------- //
631  /// Blur multiplier in the T direction.
632  ///
633  /// | ||
634  /// | -- | -- |
635  /// | Declaration | `float analytic:blur:tMult = 0` |
636  /// | C++ Type | float |
637  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
638  USDRI_API
640 
641  /// See GetAnalyticBlurTMultAttr(), and also
642  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
643  /// If specified, author \p defaultValue as the attribute's default,
644  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
645  /// the default for \p writeSparsely is \c false.
646  USDRI_API
647  UsdAttribute CreateAnalyticBlurTMultAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
648 
649 public:
650  // --------------------------------------------------------------------- //
651  // ANALYTICBLURNEARDISTANCE
652  // --------------------------------------------------------------------- //
653  /// Distance from the cookie where the blur interpolation
654  /// starts.
655  ///
656  /// | ||
657  /// | -- | -- |
658  /// | Declaration | `float analytic:blur:nearDistance = 0` |
659  /// | C++ Type | float |
660  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
661  USDRI_API
663 
664  /// See GetAnalyticBlurNearDistanceAttr(), and also
665  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
666  /// If specified, author \p defaultValue as the attribute's default,
667  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
668  /// the default for \p writeSparsely is \c false.
669  USDRI_API
670  UsdAttribute CreateAnalyticBlurNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
671 
672 public:
673  // --------------------------------------------------------------------- //
674  // ANALYTICBLURMIDPOINT
675  // --------------------------------------------------------------------- //
676  /// Distance between near and far where midValue is located.
677  ///
678  /// | ||
679  /// | -- | -- |
680  /// | Declaration | `float analytic:blur:midpoint = 0.5` |
681  /// | C++ Type | float |
682  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
683  USDRI_API
685 
686  /// See GetAnalyticBlurMidpointAttr(), and also
687  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
688  /// If specified, author \p defaultValue as the attribute's default,
689  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
690  /// the default for \p writeSparsely is \c false.
691  USDRI_API
692  UsdAttribute CreateAnalyticBlurMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
693 
694 public:
695  // --------------------------------------------------------------------- //
696  // ANALYTICBLURFARDISTANCE
697  // --------------------------------------------------------------------- //
698  /// Distance from the cookie where the blur interpolation ends.
699  ///
700  /// | ||
701  /// | -- | -- |
702  /// | Declaration | `float analytic:blur:farDistance = 10` |
703  /// | C++ Type | float |
704  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
705  USDRI_API
707 
708  /// See GetAnalyticBlurFarDistanceAttr(), and also
709  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
710  /// If specified, author \p defaultValue as the attribute's default,
711  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
712  /// the default for \p writeSparsely is \c false.
713  USDRI_API
714  UsdAttribute CreateAnalyticBlurFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
715 
716 public:
717  // --------------------------------------------------------------------- //
718  // ANALYTICBLURNEARVALUE
719  // --------------------------------------------------------------------- //
720  /// Blur multiplier where the blur interpolation starts.
721  ///
722  /// | ||
723  /// | -- | -- |
724  /// | Declaration | `float analytic:blur:nearValue = 1` |
725  /// | C++ Type | float |
726  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
727  USDRI_API
729 
730  /// See GetAnalyticBlurNearValueAttr(), and also
731  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
732  /// If specified, author \p defaultValue as the attribute's default,
733  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
734  /// the default for \p writeSparsely is \c false.
735  USDRI_API
736  UsdAttribute CreateAnalyticBlurNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
737 
738 public:
739  // --------------------------------------------------------------------- //
740  // ANALYTICBLURMIDVALUE
741  // --------------------------------------------------------------------- //
742  /// Blur multiplier in the middle of interpolation.
743  ///
744  /// | ||
745  /// | -- | -- |
746  /// | Declaration | `float analytic:blur:midValue = 1` |
747  /// | C++ Type | float |
748  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
749  USDRI_API
751 
752  /// See GetAnalyticBlurMidValueAttr(), and also
753  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
754  /// If specified, author \p defaultValue as the attribute's default,
755  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
756  /// the default for \p writeSparsely is \c false.
757  USDRI_API
758  UsdAttribute CreateAnalyticBlurMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
759 
760 public:
761  // --------------------------------------------------------------------- //
762  // ANALYTICBLURFARVALUE
763  // --------------------------------------------------------------------- //
764  /// Blur multiplier at the end of interpolation.
765  ///
766  /// | ||
767  /// | -- | -- |
768  /// | Declaration | `float analytic:blur:farValue = 1` |
769  /// | C++ Type | float |
770  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
771  USDRI_API
773 
774  /// See GetAnalyticBlurFarValueAttr(), and also
775  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
776  /// If specified, author \p defaultValue as the attribute's default,
777  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
778  /// the default for \p writeSparsely is \c false.
779  USDRI_API
780  UsdAttribute CreateAnalyticBlurFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
781 
782 public:
783  // --------------------------------------------------------------------- //
784  // ANALYTICBLUREXPONENT
785  // --------------------------------------------------------------------- //
786  /// Power exponent of the blur interpolation.
787  ///
788  /// | ||
789  /// | -- | -- |
790  /// | Declaration | `float analytic:blur:exponent = 1` |
791  /// | C++ Type | float |
792  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
793  USDRI_API
795 
796  /// See GetAnalyticBlurExponentAttr(), and also
797  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
798  /// If specified, author \p defaultValue as the attribute's default,
799  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
800  /// the default for \p writeSparsely is \c false.
801  USDRI_API
802  UsdAttribute CreateAnalyticBlurExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
803 
804 public:
805  // --------------------------------------------------------------------- //
806  // ANALYTICDENSITYNEARDISTANCE
807  // --------------------------------------------------------------------- //
808  /// Distance from the cookie where the density
809  /// interpolation starts.
810  ///
811  /// | ||
812  /// | -- | -- |
813  /// | Declaration | `float analytic:density:nearDistance = 0` |
814  /// | C++ Type | float |
815  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
816  USDRI_API
818 
819  /// See GetAnalyticDensityNearDistanceAttr(), and also
820  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
821  /// If specified, author \p defaultValue as the attribute's default,
822  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
823  /// the default for \p writeSparsely is \c false.
824  USDRI_API
825  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
826 
827 public:
828  // --------------------------------------------------------------------- //
829  // ANALYTICDENSITYMIDPOINT
830  // --------------------------------------------------------------------- //
831  /// Distance between near and far where midValue is located.
832  ///
833  /// | ||
834  /// | -- | -- |
835  /// | Declaration | `float analytic:density:midpoint = 0.5` |
836  /// | C++ Type | float |
837  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
838  USDRI_API
840 
841  /// See GetAnalyticDensityMidpointAttr(), and also
842  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
843  /// If specified, author \p defaultValue as the attribute's default,
844  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
845  /// the default for \p writeSparsely is \c false.
846  USDRI_API
847  UsdAttribute CreateAnalyticDensityMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
848 
849 public:
850  // --------------------------------------------------------------------- //
851  // ANALYTICDENSITYFARDISTANCE
852  // --------------------------------------------------------------------- //
853  /// Distance from the cookie where the density interpolation
854  /// ends.
855  ///
856  /// | ||
857  /// | -- | -- |
858  /// | Declaration | `float analytic:density:farDistance = 10` |
859  /// | C++ Type | float |
860  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
861  USDRI_API
863 
864  /// See GetAnalyticDensityFarDistanceAttr(), and also
865  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
866  /// If specified, author \p defaultValue as the attribute's default,
867  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
868  /// the default for \p writeSparsely is \c false.
869  USDRI_API
870  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
871 
872 public:
873  // --------------------------------------------------------------------- //
874  // ANALYTICDENSITYNEARVALUE
875  // --------------------------------------------------------------------- //
876  /// Density multiplier where the density interpolation starts.
877  ///
878  /// | ||
879  /// | -- | -- |
880  /// | Declaration | `float analytic:density:nearValue = 1` |
881  /// | C++ Type | float |
882  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
883  USDRI_API
885 
886  /// See GetAnalyticDensityNearValueAttr(), and also
887  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
888  /// If specified, author \p defaultValue as the attribute's default,
889  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
890  /// the default for \p writeSparsely is \c false.
891  USDRI_API
892  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
893 
894 public:
895  // --------------------------------------------------------------------- //
896  // ANALYTICDENSITYMIDVALUE
897  // --------------------------------------------------------------------- //
898  /// Density multiplier in the middle of interpolation.
899  ///
900  /// | ||
901  /// | -- | -- |
902  /// | Declaration | `float analytic:density:midValue = 1` |
903  /// | C++ Type | float |
904  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
905  USDRI_API
907 
908  /// See GetAnalyticDensityMidValueAttr(), and also
909  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
910  /// If specified, author \p defaultValue as the attribute's default,
911  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
912  /// the default for \p writeSparsely is \c false.
913  USDRI_API
914  UsdAttribute CreateAnalyticDensityMidValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
915 
916 public:
917  // --------------------------------------------------------------------- //
918  // ANALYTICDENSITYFARVALUE
919  // --------------------------------------------------------------------- //
920  /// Density multiplier at the end of interpolation.
921  ///
922  /// | ||
923  /// | -- | -- |
924  /// | Declaration | `float analytic:density:farValue = 1` |
925  /// | C++ Type | float |
926  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
927  USDRI_API
929 
930  /// See GetAnalyticDensityFarValueAttr(), and also
931  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
932  /// If specified, author \p defaultValue as the attribute's default,
933  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
934  /// the default for \p writeSparsely is \c false.
935  USDRI_API
936  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
937 
938 public:
939  // --------------------------------------------------------------------- //
940  // ANALYTICDENSITYEXPONENT
941  // --------------------------------------------------------------------- //
942  /// Power exponent of the density interpolation.
943  ///
944  /// | ||
945  /// | -- | -- |
946  /// | Declaration | `float analytic:density:exponent = 1` |
947  /// | C++ Type | float |
948  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
949  USDRI_API
951 
952  /// See GetAnalyticDensityExponentAttr(), and also
953  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
954  /// If specified, author \p defaultValue as the attribute's default,
955  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
956  /// the default for \p writeSparsely is \c false.
957  USDRI_API
958  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
959 
960 public:
961  // --------------------------------------------------------------------- //
962  // COLORSATURATION
963  // --------------------------------------------------------------------- //
964  /// Saturation of the result (0=greyscale, 1=normal,
965  /// >1=boosted colors).
966  ///
967  /// | ||
968  /// | -- | -- |
969  /// | Declaration | `float color:saturation = 1` |
970  /// | C++ Type | float |
971  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
972  USDRI_API
974 
975  /// See GetColorSaturationAttr(), and also
976  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
977  /// If specified, author \p defaultValue as the attribute's default,
978  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
979  /// the default for \p writeSparsely is \c false.
980  USDRI_API
981  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
982 
983 public:
984  // --------------------------------------------------------------------- //
985  // COLORMIDPOINT
986  // --------------------------------------------------------------------- //
987  /// Midpoint for the contrast control.
988  ///
989  /// | ||
990  /// | -- | -- |
991  /// | Declaration | `float color:midpoint = 0.18` |
992  /// | C++ Type | float |
993  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
994  USDRI_API
996 
997  /// See GetColorMidpointAttr(), and also
998  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
999  /// If specified, author \p defaultValue as the attribute's default,
1000  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
1001  /// the default for \p writeSparsely is \c false.
1002  USDRI_API
1003  UsdAttribute CreateColorMidpointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1004 
1005 public:
1006  // --------------------------------------------------------------------- //
1007  // COLORCONTRAST
1008  // --------------------------------------------------------------------- //
1009  /// Contrast control (less than 1 = contrast reduction,
1010  /// larger than 1 = contrast increase).
1011  ///
1012  /// | ||
1013  /// | -- | -- |
1014  /// | Declaration | `float color:contrast = 1` |
1015  /// | C++ Type | float |
1016  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
1017  USDRI_API
1019 
1020  /// See GetColorContrastAttr(), and also
1021  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
1022  /// If specified, author \p defaultValue as the attribute's default,
1023  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
1024  /// the default for \p writeSparsely is \c false.
1025  USDRI_API
1026  UsdAttribute CreateColorContrastAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1027 
1028 public:
1029  // --------------------------------------------------------------------- //
1030  // COLORWHITEPOINT
1031  // --------------------------------------------------------------------- //
1032  /// White point for the contrast control if (contrast > 1.0).
1033  ///
1034  /// | ||
1035  /// | -- | -- |
1036  /// | Declaration | `float color:whitepoint = 1` |
1037  /// | C++ Type | float |
1038  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
1039  USDRI_API
1041 
1042  /// See GetColorWhitepointAttr(), and also
1043  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
1044  /// If specified, author \p defaultValue as the attribute's default,
1045  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
1046  /// the default for \p writeSparsely is \c false.
1047  USDRI_API
1048  UsdAttribute CreateColorWhitepointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1049 
1050 public:
1051  // --------------------------------------------------------------------- //
1052  // COLORTINT
1053  // --------------------------------------------------------------------- //
1054  /// Tint of the resulting color after saturation, contrast
1055  /// and clamp.
1056  ///
1057  /// | ||
1058  /// | -- | -- |
1059  /// | Declaration | `color3f color:tint = (1, 1, 1)` |
1060  /// | C++ Type | GfVec3f |
1061  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Color3f |
1062  USDRI_API
1064 
1065  /// See GetColorTintAttr(), and also
1066  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
1067  /// If specified, author \p defaultValue as the attribute's default,
1068  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
1069  /// the default for \p writeSparsely is \c false.
1070  USDRI_API
1071  UsdAttribute CreateColorTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
1072 
1073 public:
1074  // ===================================================================== //
1075  // Feel free to add custom code below this line, it will be preserved by
1076  // the code generator.
1077  //
1078  // Just remember to:
1079  // - Close the class declaration with };
1080  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
1081  // - Close the include guard with #endif
1082  // ===================================================================== //
1083  // --(BEGIN CUSTOM CODE)--
1084 };
1085 
1087 
1088 #endif
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
UsdSchemaKind
Definition: common.h:127
Represents a concrete typed schema.
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
Definition: value.h:168