HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrBarnLightFilter.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_PXRBARNLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRBARNLIGHTFILTER_H
26 
27 /// \file usdRi/pxrBarnLightFilter.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 // PXRBARNLIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiPxrBarnLightFilter
54 ///
55 ///
56 /// \deprecated This schema will be replaced in a future release.
57 /// Simulated geometric barn doors that control the spread of 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 UsdRiPxrBarnLightFilter on UsdPrim \p prim .
74  /// Equivalent to UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter(const UsdPrim& prim=UsdPrim())
78  : UsdLuxLightFilter(prim)
79  {
80  }
81 
82  /// Construct a UsdRiPxrBarnLightFilter on the prim held by \p schemaObj .
83  /// Should be preferred over UsdRiPxrBarnLightFilter(schemaObj.GetPrim()),
84  /// as it preserves SchemaBase state.
85  explicit UsdRiPxrBarnLightFilter(const UsdSchemaBase& schemaObj)
86  : UsdLuxLightFilter(schemaObj)
87  {
88  }
89 
90  /// Destructor.
91  USDRI_API
92  virtual ~UsdRiPxrBarnLightFilter();
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 UsdRiPxrBarnLightFilter 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  /// UsdRiPxrBarnLightFilter(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  // BARNMODE
162  // --------------------------------------------------------------------- //
163  /// Chooses a physical or analytic evaluation model for
164  /// the barn.
165  ///
166  /// | ||
167  /// | -- | -- |
168  /// | Declaration | `token barnMode = "physical"` |
169  /// | C++ Type | TfToken |
170  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
171  /// | \ref UsdRiTokens "Allowed Values" | physical, analytic |
172  USDRI_API
174 
175  /// See GetBarnModeAttr(), and also
176  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
177  /// If specified, author \p defaultValue as the attribute's default,
178  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
179  /// the default for \p writeSparsely is \c false.
180  USDRI_API
181  UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182 
183 public:
184  // --------------------------------------------------------------------- //
185  // WIDTH
186  // --------------------------------------------------------------------- //
187  /// Width of the inner region of the barn (X axis).
188  ///
189  /// | ||
190  /// | -- | -- |
191  /// | Declaration | `float width = 1` |
192  /// | C++ Type | float |
193  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
194  USDRI_API
195  UsdAttribute GetWidthAttr() const;
196 
197  /// See GetWidthAttr(), and also
198  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
199  /// If specified, author \p defaultValue as the attribute's default,
200  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
201  /// the default for \p writeSparsely is \c false.
202  USDRI_API
203  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204 
205 public:
206  // --------------------------------------------------------------------- //
207  // HEIGHT
208  // --------------------------------------------------------------------- //
209  /// Height of the inner region of the barn (Y axis).
210  ///
211  /// | ||
212  /// | -- | -- |
213  /// | Declaration | `float height = 1` |
214  /// | C++ Type | float |
215  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
216  USDRI_API
217  UsdAttribute GetHeightAttr() const;
218 
219  /// See GetHeightAttr(), and also
220  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
221  /// If specified, author \p defaultValue as the attribute's default,
222  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
223  /// the default for \p writeSparsely is \c false.
224  USDRI_API
225  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
226 
227 public:
228  // --------------------------------------------------------------------- //
229  // RADIUS
230  // --------------------------------------------------------------------- //
231  /// Radius of the corners of the inner barn square.
232  ///
233  /// | ||
234  /// | -- | -- |
235  /// | Declaration | `float radius = 0.5` |
236  /// | C++ Type | float |
237  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
238  USDRI_API
239  UsdAttribute GetRadiusAttr() const;
240 
241  /// See GetRadiusAttr(), and also
242  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
243  /// If specified, author \p defaultValue as the attribute's default,
244  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
245  /// the default for \p writeSparsely is \c false.
246  USDRI_API
247  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
248 
249 public:
250  // --------------------------------------------------------------------- //
251  // ANALYTICDIRECTIONAL
252  // --------------------------------------------------------------------- //
253  /// When this is on, the texture projects along a direction
254  /// using the orthographic projection. When it is off, the texture
255  /// projects using a focal point specified by the analytic:apex.
256  ///
257  /// | ||
258  /// | -- | -- |
259  /// | Declaration | `bool analytic:directional = 0` |
260  /// | C++ Type | bool |
261  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
262  USDRI_API
264 
265  /// See GetAnalyticDirectionalAttr(), and also
266  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
267  /// If specified, author \p defaultValue as the attribute's default,
268  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
269  /// the default for \p writeSparsely is \c false.
270  USDRI_API
271  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
272 
273 public:
274  // --------------------------------------------------------------------- //
275  // ANALYTICSHEARX
276  // --------------------------------------------------------------------- //
277  /// Shear the projection along the X axis.
278  ///
279  /// | ||
280  /// | -- | -- |
281  /// | Declaration | `float analytic:shearX = 0` |
282  /// | C++ Type | float |
283  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
284  USDRI_API
286 
287  /// See GetAnalyticShearXAttr(), and also
288  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
289  /// If specified, author \p defaultValue as the attribute's default,
290  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
291  /// the default for \p writeSparsely is \c false.
292  USDRI_API
293  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // ANALYTICSHEARY
298  // --------------------------------------------------------------------- //
299  /// Shear the projection along the Y axis.
300  ///
301  /// | ||
302  /// | -- | -- |
303  /// | Declaration | `float analytic:shearY = 0` |
304  /// | C++ Type | float |
305  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
306  USDRI_API
308 
309  /// See GetAnalyticShearYAttr(), and also
310  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
311  /// If specified, author \p defaultValue as the attribute's default,
312  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
313  /// the default for \p writeSparsely is \c false.
314  USDRI_API
315  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
316 
317 public:
318  // --------------------------------------------------------------------- //
319  // ANALYTICAPEX
320  // --------------------------------------------------------------------- //
321  /// Shear the projection along the Y axis.
322  ///
323  /// | ||
324  /// | -- | -- |
325  /// | Declaration | `float analytic:apex = 25` |
326  /// | C++ Type | float |
327  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
328  USDRI_API
330 
331  /// See GetAnalyticApexAttr(), and also
332  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
333  /// If specified, author \p defaultValue as the attribute's default,
334  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
335  /// the default for \p writeSparsely is \c false.
336  USDRI_API
337  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
338 
339 public:
340  // --------------------------------------------------------------------- //
341  // ANALYTICUSELIGHTDIRECTION
342  // --------------------------------------------------------------------- //
343  /// When this is on, If this is on, the projection direction
344  /// is determined by the position of the center of the light source.
345  /// Otherwise, it only follows the orientation of the barn. WARNING:
346  /// This does not work with dome and mesh lights.
347  ///
348  /// | ||
349  /// | -- | -- |
350  /// | Declaration | `bool analytic:useLightDirection = 0` |
351  /// | C++ Type | bool |
352  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
353  USDRI_API
355 
356  /// See GetAnalyticUseLightDirectionAttr(), and also
357  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
358  /// If specified, author \p defaultValue as the attribute's default,
359  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
360  /// the default for \p writeSparsely is \c false.
361  USDRI_API
362  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
363 
364 public:
365  // --------------------------------------------------------------------- //
366  // ANALYTICDENSITYNEARDISTANCE
367  // --------------------------------------------------------------------- //
368  /// Distance from the barn where the density
369  /// interpolation starts.
370  ///
371  /// | ||
372  /// | -- | -- |
373  /// | Declaration | `float analytic:density:nearDistance = 0` |
374  /// | C++ Type | float |
375  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
376  USDRI_API
378 
379  /// See GetAnalyticDensityNearDistanceAttr(), and also
380  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
381  /// If specified, author \p defaultValue as the attribute's default,
382  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
383  /// the default for \p writeSparsely is \c false.
384  USDRI_API
385  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
386 
387 public:
388  // --------------------------------------------------------------------- //
389  // ANALYTICDENSITYFARDISTANCE
390  // --------------------------------------------------------------------- //
391  /// Distance from the barn where the density interpolation
392  /// ends.
393  ///
394  /// | ||
395  /// | -- | -- |
396  /// | Declaration | `float analytic:density:farDistance = 0` |
397  /// | C++ Type | float |
398  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
399  USDRI_API
401 
402  /// See GetAnalyticDensityFarDistanceAttr(), and also
403  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
404  /// If specified, author \p defaultValue as the attribute's default,
405  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
406  /// the default for \p writeSparsely is \c false.
407  USDRI_API
408  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
409 
410 public:
411  // --------------------------------------------------------------------- //
412  // ANALYTICDENSITYNEARVALUE
413  // --------------------------------------------------------------------- //
414  /// Density multiplier where the density interpolation starts.
415  ///
416  /// | ||
417  /// | -- | -- |
418  /// | Declaration | `float analytic:density:nearValue = 0` |
419  /// | C++ Type | float |
420  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
421  USDRI_API
423 
424  /// See GetAnalyticDensityNearValueAttr(), and also
425  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
426  /// If specified, author \p defaultValue as the attribute's default,
427  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
428  /// the default for \p writeSparsely is \c false.
429  USDRI_API
430  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
431 
432 public:
433  // --------------------------------------------------------------------- //
434  // ANALYTICDENSITYFARVALUE
435  // --------------------------------------------------------------------- //
436  /// Density multiplier at the end of interpolation.
437  ///
438  /// | ||
439  /// | -- | -- |
440  /// | Declaration | `float analytic:density:farValue = 1` |
441  /// | C++ Type | float |
442  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
443  USDRI_API
445 
446  /// See GetAnalyticDensityFarValueAttr(), and also
447  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
448  /// If specified, author \p defaultValue as the attribute's default,
449  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
450  /// the default for \p writeSparsely is \c false.
451  USDRI_API
452  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
453 
454 public:
455  // --------------------------------------------------------------------- //
456  // ANALYTICDENSITYEXPONENT
457  // --------------------------------------------------------------------- //
458  /// Power exponent of the density interpolation.
459  ///
460  /// | ||
461  /// | -- | -- |
462  /// | Declaration | `float analytic:density:exponent = 1` |
463  /// | C++ Type | float |
464  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
465  USDRI_API
467 
468  /// See GetAnalyticDensityExponentAttr(), and also
469  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
470  /// If specified, author \p defaultValue as the attribute's default,
471  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
472  /// the default for \p writeSparsely is \c false.
473  USDRI_API
474  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
475 
476 public:
477  // --------------------------------------------------------------------- //
478  // EDGETHICKNESS
479  // --------------------------------------------------------------------- //
480  /// Thickness of the edge region. Larger values will
481  /// soften the edge shape.
482  ///
483  /// | ||
484  /// | -- | -- |
485  /// | Declaration | `float edgeThickness = 0` |
486  /// | C++ Type | float |
487  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
488  USDRI_API
490 
491  /// See GetEdgeThicknessAttr(), and also
492  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
493  /// If specified, author \p defaultValue as the attribute's default,
494  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
495  /// the default for \p writeSparsely is \c false.
496  USDRI_API
497  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
498 
499 public:
500  // --------------------------------------------------------------------- //
501  // PREBARNEFFECT
502  // --------------------------------------------------------------------- //
503  /// The effect on light before it reaches the barn
504  /// geometry.
505  ///
506  /// | ||
507  /// | -- | -- |
508  /// | Declaration | `token preBarnEffect = "noLight"` |
509  /// | C++ Type | TfToken |
510  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
511  /// | \ref UsdRiTokens "Allowed Values" | noEffect, cone, noLight |
512  USDRI_API
514 
515  /// See GetPreBarnEffectAttr(), and also
516  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
517  /// If specified, author \p defaultValue as the attribute's default,
518  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
519  /// the default for \p writeSparsely is \c false.
520  USDRI_API
521  UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
522 
523 public:
524  // --------------------------------------------------------------------- //
525  // SCALEWIDTH
526  // --------------------------------------------------------------------- //
527  /// Scale the width of the inner barn shape.
528  ///
529  /// | ||
530  /// | -- | -- |
531  /// | Declaration | `float scale:width = 1` |
532  /// | C++ Type | float |
533  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
534  USDRI_API
536 
537  /// See GetScaleWidthAttr(), and also
538  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
539  /// If specified, author \p defaultValue as the attribute's default,
540  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
541  /// the default for \p writeSparsely is \c false.
542  USDRI_API
543  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
544 
545 public:
546  // --------------------------------------------------------------------- //
547  // SCALEHEIGHT
548  // --------------------------------------------------------------------- //
549  /// Scale the height of the inner barn shape.
550  ///
551  /// | ||
552  /// | -- | -- |
553  /// | Declaration | `float scale:height = 1` |
554  /// | C++ Type | float |
555  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
556  USDRI_API
558 
559  /// See GetScaleHeightAttr(), and also
560  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
561  /// If specified, author \p defaultValue as the attribute's default,
562  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
563  /// the default for \p writeSparsely is \c false.
564  USDRI_API
565  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
566 
567 public:
568  // --------------------------------------------------------------------- //
569  // REFINETOP
570  // --------------------------------------------------------------------- //
571  /// Additional offset adjustment to the top region.
572  ///
573  /// | ||
574  /// | -- | -- |
575  /// | Declaration | `float refine:top = 0` |
576  /// | C++ Type | float |
577  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
578  USDRI_API
580 
581  /// See GetRefineTopAttr(), and also
582  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
583  /// If specified, author \p defaultValue as the attribute's default,
584  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
585  /// the default for \p writeSparsely is \c false.
586  USDRI_API
587  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
588 
589 public:
590  // --------------------------------------------------------------------- //
591  // REFINEBOTTOM
592  // --------------------------------------------------------------------- //
593  /// Additional offset adjustment to the top region.
594  ///
595  /// | ||
596  /// | -- | -- |
597  /// | Declaration | `float refine:bottom = 0` |
598  /// | C++ Type | float |
599  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
600  USDRI_API
602 
603  /// See GetRefineBottomAttr(), and also
604  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
605  /// If specified, author \p defaultValue as the attribute's default,
606  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
607  /// the default for \p writeSparsely is \c false.
608  USDRI_API
609  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
610 
611 public:
612  // --------------------------------------------------------------------- //
613  // REFINELEFT
614  // --------------------------------------------------------------------- //
615  /// Additional offset adjustment to the left region.
616  ///
617  /// | ||
618  /// | -- | -- |
619  /// | Declaration | `float refine:left = 0` |
620  /// | C++ Type | float |
621  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
622  USDRI_API
624 
625  /// See GetRefineLeftAttr(), and also
626  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
627  /// If specified, author \p defaultValue as the attribute's default,
628  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
629  /// the default for \p writeSparsely is \c false.
630  USDRI_API
631  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
632 
633 public:
634  // --------------------------------------------------------------------- //
635  // REFINERIGHT
636  // --------------------------------------------------------------------- //
637  /// Additional offset adjustment to the left region.
638  ///
639  /// | ||
640  /// | -- | -- |
641  /// | Declaration | `float refine:right = 0` |
642  /// | C++ Type | float |
643  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
644  USDRI_API
646 
647  /// See GetRefineRightAttr(), and also
648  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
649  /// If specified, author \p defaultValue as the attribute's default,
650  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
651  /// the default for \p writeSparsely is \c false.
652  USDRI_API
653  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
654 
655 public:
656  // --------------------------------------------------------------------- //
657  // EDGESCALETOP
658  // --------------------------------------------------------------------- //
659  /// Additional edge scale adjustment to the top region.
660  ///
661  /// | ||
662  /// | -- | -- |
663  /// | Declaration | `float edgeScale:top = 1` |
664  /// | C++ Type | float |
665  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
666  USDRI_API
668 
669  /// See GetEdgeScaleTopAttr(), and also
670  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
671  /// If specified, author \p defaultValue as the attribute's default,
672  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
673  /// the default for \p writeSparsely is \c false.
674  USDRI_API
675  UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
676 
677 public:
678  // --------------------------------------------------------------------- //
679  // EDGESCALEBOTTOM
680  // --------------------------------------------------------------------- //
681  /// Additional edge scale adjustment to the top region.
682  ///
683  /// | ||
684  /// | -- | -- |
685  /// | Declaration | `float edgeScale:bottom = 1` |
686  /// | C++ Type | float |
687  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
688  USDRI_API
690 
691  /// See GetEdgeScaleBottomAttr(), and also
692  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
693  /// If specified, author \p defaultValue as the attribute's default,
694  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
695  /// the default for \p writeSparsely is \c false.
696  USDRI_API
697  UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
698 
699 public:
700  // --------------------------------------------------------------------- //
701  // EDGESCALELEFT
702  // --------------------------------------------------------------------- //
703  /// Additional edge scale adjustment to the left region.
704  ///
705  /// | ||
706  /// | -- | -- |
707  /// | Declaration | `float edgeScale:left = 1` |
708  /// | C++ Type | float |
709  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
710  USDRI_API
712 
713  /// See GetEdgeScaleLeftAttr(), and also
714  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
715  /// If specified, author \p defaultValue as the attribute's default,
716  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
717  /// the default for \p writeSparsely is \c false.
718  USDRI_API
719  UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
720 
721 public:
722  // --------------------------------------------------------------------- //
723  // EDGESCALERIGHT
724  // --------------------------------------------------------------------- //
725  /// Additional edge scale adjustment to the left region.
726  ///
727  /// | ||
728  /// | -- | -- |
729  /// | Declaration | `float edgeScale:right = 1` |
730  /// | C++ Type | float |
731  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
732  USDRI_API
734 
735  /// See GetEdgeScaleRightAttr(), and also
736  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
737  /// If specified, author \p defaultValue as the attribute's default,
738  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
739  /// the default for \p writeSparsely is \c false.
740  USDRI_API
741  UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
742 
743 public:
744  // ===================================================================== //
745  // Feel free to add custom code below this line, it will be preserved by
746  // the code generator.
747  //
748  // Just remember to:
749  // - Close the class declaration with };
750  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
751  // - Close the include guard with #endif
752  // ===================================================================== //
753  // --(BEGIN CUSTOM CODE)--
754 };
755 
757 
758 #endif
USDRI_API UsdAttribute GetRefineRightAttr() const
USDRI_API UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRefineBottomAttr() const
USDRI_API UsdAttribute GetAnalyticDirectionalAttr() const
USDRI_API UsdAttribute GetWidthAttr() const
USDRI_API UsdAttribute GetEdgeThicknessAttr() const
static const UsdSchemaKind schemaKind
USDRI_API UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
USDRI_API UsdAttribute GetRadiusAttr() const
USDRI_API UsdAttribute GetHeightAttr() const
USDRI_API UsdAttribute GetRefineLeftAttr() const
USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr() const
USDRI_API UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdSchemaKind _GetSchemaKind() const override
USDRI_API UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetAnalyticUseLightDirectionAttr() const
USDRI_API UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdSchemaKind
Definition: common.h:127
USDRI_API UsdAttribute GetScaleHeightAttr() const
USDRI_API UsdAttribute GetAnalyticDensityFarValueAttr() const
USDRI_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetBarnModeAttr() const
USDRI_API UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetPreBarnEffectAttr() const
USDRI_API UsdAttribute GetAnalyticApexAttr() const
USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr() const
USDRI_API UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Represents a concrete typed schema.
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Definition: prim.h:132
USDRI_API UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
USDRI_API UsdAttribute GetAnalyticShearYAttr() const
USDRI_API UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeScaleTopAttr() const
USDRI_API UsdAttribute GetAnalyticShearXAttr() const
USDRI_API UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeScaleLeftAttr() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
USDRI_API UsdAttribute GetRefineTopAttr() const
USDRI_API UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
static USDRI_API UsdRiPxrBarnLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
UsdRiPxrBarnLightFilter(const UsdSchemaBase &schemaObj)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
USDRI_API UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Definition: type.h:64
static USDRI_API UsdRiPxrBarnLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetEdgeScaleRightAttr() const
USDRI_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr() const
UsdRiPxrBarnLightFilter(const UsdPrim &prim=UsdPrim())
USDRI_API UsdAttribute GetScaleWidthAttr() const
USDRI_API UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetEdgeScaleBottomAttr() const
USDRI_API UsdAttribute GetAnalyticDensityExponentAttr() const
Definition: value.h:168
virtual USDRI_API ~UsdRiPxrBarnLightFilter()
Destructor.
USDRI_API UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const