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 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usdLux/lightFilter.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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PXRBARNLIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
63 {
64 public:
69 
74  explicit UsdRiPxrBarnLightFilter(const UsdPrim& prim=UsdPrim())
75  : UsdLuxLightFilter(prim)
76  {
77  }
78 
82  explicit UsdRiPxrBarnLightFilter(const UsdSchemaBase& schemaObj)
83  : UsdLuxLightFilter(schemaObj)
84  {
85  }
86 
88  USDRI_API
89  virtual ~UsdRiPxrBarnLightFilter();
90 
94  USDRI_API
95  static const TfTokenVector &
96  GetSchemaAttributeNames(bool includeInherited=true);
97 
107  USDRI_API
109  Get(const UsdStagePtr &stage, const SdfPath &path);
110 
133  USDRI_API
135  Define(const UsdStagePtr &stage, const SdfPath &path);
136 
137 protected:
141  USDRI_API
142  UsdSchemaType _GetSchemaType() const override;
143 
144 private:
145  // needs to invoke _GetStaticTfType.
146  friend class UsdSchemaRegistry;
147  USDRI_API
148  static const TfType &_GetStaticTfType();
149 
150  static bool _IsTypedSchema();
151 
152  // override SchemaBase virtuals.
153  USDRI_API
154  const TfType &_GetTfType() const override;
155 
156 public:
157  // --------------------------------------------------------------------- //
158  // BARNMODE
159  // --------------------------------------------------------------------- //
168  USDRI_API
170 
176  USDRI_API
177  UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
178 
179 public:
180  // --------------------------------------------------------------------- //
181  // WIDTH
182  // --------------------------------------------------------------------- //
189  USDRI_API
190  UsdAttribute GetWidthAttr() const;
191 
197  USDRI_API
198  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // --------------------------------------------------------------------- //
202  // HEIGHT
203  // --------------------------------------------------------------------- //
210  USDRI_API
211  UsdAttribute GetHeightAttr() const;
212 
218  USDRI_API
219  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220 
221 public:
222  // --------------------------------------------------------------------- //
223  // RADIUS
224  // --------------------------------------------------------------------- //
231  USDRI_API
232  UsdAttribute GetRadiusAttr() const;
233 
239  USDRI_API
240  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
241 
242 public:
243  // --------------------------------------------------------------------- //
244  // ANALYTICDIRECTIONAL
245  // --------------------------------------------------------------------- //
254  USDRI_API
256 
262  USDRI_API
263  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
264 
265 public:
266  // --------------------------------------------------------------------- //
267  // ANALYTICSHEARX
268  // --------------------------------------------------------------------- //
275  USDRI_API
277 
283  USDRI_API
284  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
285 
286 public:
287  // --------------------------------------------------------------------- //
288  // ANALYTICSHEARY
289  // --------------------------------------------------------------------- //
296  USDRI_API
298 
304  USDRI_API
305  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
306 
307 public:
308  // --------------------------------------------------------------------- //
309  // ANALYTICAPEX
310  // --------------------------------------------------------------------- //
317  USDRI_API
319 
325  USDRI_API
326  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
327 
328 public:
329  // --------------------------------------------------------------------- //
330  // ANALYTICUSELIGHTDIRECTION
331  // --------------------------------------------------------------------- //
341  USDRI_API
343 
349  USDRI_API
350  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
351 
352 public:
353  // --------------------------------------------------------------------- //
354  // ANALYTICDENSITYNEARDISTANCE
355  // --------------------------------------------------------------------- //
363  USDRI_API
365 
371  USDRI_API
372  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
373 
374 public:
375  // --------------------------------------------------------------------- //
376  // ANALYTICDENSITYFARDISTANCE
377  // --------------------------------------------------------------------- //
385  USDRI_API
387 
393  USDRI_API
394  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
395 
396 public:
397  // --------------------------------------------------------------------- //
398  // ANALYTICDENSITYNEARVALUE
399  // --------------------------------------------------------------------- //
406  USDRI_API
408 
414  USDRI_API
415  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
416 
417 public:
418  // --------------------------------------------------------------------- //
419  // ANALYTICDENSITYFARVALUE
420  // --------------------------------------------------------------------- //
427  USDRI_API
429 
435  USDRI_API
436  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
437 
438 public:
439  // --------------------------------------------------------------------- //
440  // ANALYTICDENSITYEXPONENT
441  // --------------------------------------------------------------------- //
448  USDRI_API
450 
456  USDRI_API
457  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
458 
459 public:
460  // --------------------------------------------------------------------- //
461  // EDGETHICKNESS
462  // --------------------------------------------------------------------- //
470  USDRI_API
472 
478  USDRI_API
479  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
480 
481 public:
482  // --------------------------------------------------------------------- //
483  // PREBARNEFFECT
484  // --------------------------------------------------------------------- //
493  USDRI_API
495 
501  USDRI_API
502  UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
503 
504 public:
505  // --------------------------------------------------------------------- //
506  // SCALEWIDTH
507  // --------------------------------------------------------------------- //
514  USDRI_API
516 
522  USDRI_API
523  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
524 
525 public:
526  // --------------------------------------------------------------------- //
527  // SCALEHEIGHT
528  // --------------------------------------------------------------------- //
535  USDRI_API
537 
543  USDRI_API
544  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
545 
546 public:
547  // --------------------------------------------------------------------- //
548  // REFINETOP
549  // --------------------------------------------------------------------- //
556  USDRI_API
558 
564  USDRI_API
565  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
566 
567 public:
568  // --------------------------------------------------------------------- //
569  // REFINEBOTTOM
570  // --------------------------------------------------------------------- //
577  USDRI_API
579 
585  USDRI_API
586  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
587 
588 public:
589  // --------------------------------------------------------------------- //
590  // REFINELEFT
591  // --------------------------------------------------------------------- //
598  USDRI_API
600 
606  USDRI_API
607  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
608 
609 public:
610  // --------------------------------------------------------------------- //
611  // REFINERIGHT
612  // --------------------------------------------------------------------- //
619  USDRI_API
621 
627  USDRI_API
628  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
629 
630 public:
631  // --------------------------------------------------------------------- //
632  // EDGETOP
633  // --------------------------------------------------------------------- //
640  USDRI_API
642 
648  USDRI_API
649  UsdAttribute CreateEdgeTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
650 
651 public:
652  // --------------------------------------------------------------------- //
653  // EDGEBOTTOM
654  // --------------------------------------------------------------------- //
661  USDRI_API
663 
669  USDRI_API
670  UsdAttribute CreateEdgeBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
671 
672 public:
673  // --------------------------------------------------------------------- //
674  // EDGELEFT
675  // --------------------------------------------------------------------- //
682  USDRI_API
684 
690  USDRI_API
691  UsdAttribute CreateEdgeLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
692 
693 public:
694  // --------------------------------------------------------------------- //
695  // EDGERIGHT
696  // --------------------------------------------------------------------- //
703  USDRI_API
705 
711  USDRI_API
712  UsdAttribute CreateEdgeRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
713 
714 public:
715  // ===================================================================== //
716  // Feel free to add custom code below this line, it will be preserved by
717  // the code generator.
718  //
719  // Just remember to:
720  // - Close the class declaration with };
721  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
722  // - Close the include guard with #endif
723  // ===================================================================== //
724  // --(BEGIN CUSTOM CODE)--
725 };
726 
727 PXR_NAMESPACE_CLOSE_SCOPE
728 
729 #endif
USDRI_API UsdAttribute GetAnalyticShearXAttr() const
Shear the projection along the X axis.
USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr() const
Distance from the barn where the density interpolation ends.
USDRI_API UsdAttribute GetRefineLeftAttr() const
Additional adjustment to the left region.
USDRI_API UsdAttribute GetEdgeLeftAttr() const
Additional adjustment to the left region.
virtual USDRI_API ~UsdRiPxrBarnLightFilter()
Destructor.
USDRI_API UsdAttribute GetEdgeTopAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPreBarnEffectAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDensityFarValueAttr(), and also Create vs Get Property Methods for when to use Get vs ...
USDRI_API UsdAttribute GetRefineBottomAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute GetRadiusAttr() const
Radius of the corners of the inner barn square.
USDRI_API UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticUseLightDirectionAttr(), and also Create vs Get Property Methods for when to use Get v...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDRI_API UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticShearYAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeThicknessAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetAnalyticApexAttr() const
Shear the projection along the Y axis.
USDRI_API UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDensityNearDistanceAttr(), and also Create vs Get Property Methods for when to use Get...
USDRI_API UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineRightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetBarnModeAttr() const
Chooses a physical or analytic evaluation model for the barn.
USDRI_API UsdAttribute GetEdgeThicknessAttr() const
Thickness of the edge region.
USDRI_API UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBarnModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetAnalyticDirectionalAttr() const
When this is on, the texture projects along a direction using the orthographic projection.
USDRI_API UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineBottomAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDirectionalAttr(), and also Create vs Get Property Methods for when to use Get vs Crea...
USDRI_API UsdAttribute GetEdgeBottomAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr() const
Distance from the barn where the density interpolation starts.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
USDRI_API UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticShearXAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineLeftAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateEdgeLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeLeftAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Simulated geometric barn doors that control the spread of light.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
USDRI_API UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScaleHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDensityNearValueAttr(), and also Create vs Get Property Methods for when to use Get vs...
USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr() const
Density multiplier where the density interpolation starts.
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRI_API UsdAttribute CreateEdgeRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeRightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
Return a vector of names of all pre-declared attributes for this schema class and all its ancestor cl...
USDRI_API UsdAttribute CreateEdgeTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeTopAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdRiPxrBarnLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrBarnLightFilter on UsdPrim prim .
USDRI_API UsdAttribute GetRefineRightAttr() const
Additional adjustment to the left region.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
USDRI_API UsdAttribute GetAnalyticDensityFarValueAttr() const
Density multiplier at the end of interpolation.
static USDRI_API UsdRiPxrBarnLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrBarnLightFilter holding the prim adhering to this schema at path on stage...
USDRI_API UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDensityExponentAttr(), and also Create vs Get Property Methods for when to use Get vs ...
USDRI_API UsdAttribute CreateEdgeBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeBottomAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetAnalyticShearYAttr() const
Shear the projection along the Y axis.
UsdRiPxrBarnLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrBarnLightFilter on the prim held by schemaObj .
USDRI_API UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScaleWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetScaleWidthAttr() const
Scale the width of the inner barn shape.
USDRI_API UsdAttribute GetPreBarnEffectAttr() const
The effect on light before it reaches the barn geometry.
USDRI_API UsdAttribute GetWidthAttr() const
Width of the inner region of the barn (X axis).
USDRI_API UsdAttribute GetEdgeRightAttr() const
Additional adjustment to the left region.
USDRI_API UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticApexAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAnalyticDensityFarDistanceAttr(), and also Create vs Get Property Methods for when to use Get ...
USDRI_API UsdAttribute GetRefineTopAttr() const
Additional adjustment to the top region.
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
USDRI_API UsdAttribute GetAnalyticDensityExponentAttr() const
Power exponent of the density interpolation.
static USDRI_API UsdRiPxrBarnLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDRI_API UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineTopAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDRI_API UsdAttribute GetScaleHeightAttr() const
Scale the height of the inner barn shape.
USDRI_API UsdAttribute GetHeightAttr() const
Height of the inner region of the barn (Y axis).
A light filter modifies the effect of a light.
Definition: lightFilter.h:76
USDRI_API UsdAttribute GetAnalyticUseLightDirectionAttr() const
When this is on, If this is on, the projection direction is determined by the position of the center ...