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 
66 {
67 public:
72 
77  explicit UsdRiPxrBarnLightFilter(const UsdPrim& prim=UsdPrim())
78  : UsdLuxLightFilter(prim)
79  {
80  }
81 
85  explicit UsdRiPxrBarnLightFilter(const UsdSchemaBase& schemaObj)
86  : UsdLuxLightFilter(schemaObj)
87  {
88  }
89 
91  USDRI_API
92  virtual ~UsdRiPxrBarnLightFilter();
93 
97  USDRI_API
98  static const TfTokenVector &
99  GetSchemaAttributeNames(bool includeInherited=true);
100 
110  USDRI_API
112  Get(const UsdStagePtr &stage, const SdfPath &path);
113 
136  USDRI_API
138  Define(const UsdStagePtr &stage, const SdfPath &path);
139 
140 protected:
144  USDRI_API
145  UsdSchemaType _GetSchemaType() 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  // --------------------------------------------------------------------- //
172  USDRI_API
174 
180  USDRI_API
181  UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
182 
183 public:
184  // --------------------------------------------------------------------- //
185  // WIDTH
186  // --------------------------------------------------------------------- //
194  USDRI_API
195  UsdAttribute GetWidthAttr() const;
196 
202  USDRI_API
203  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204 
205 public:
206  // --------------------------------------------------------------------- //
207  // HEIGHT
208  // --------------------------------------------------------------------- //
216  USDRI_API
217  UsdAttribute GetHeightAttr() const;
218 
224  USDRI_API
225  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
226 
227 public:
228  // --------------------------------------------------------------------- //
229  // RADIUS
230  // --------------------------------------------------------------------- //
238  USDRI_API
239  UsdAttribute GetRadiusAttr() const;
240 
246  USDRI_API
247  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
248 
249 public:
250  // --------------------------------------------------------------------- //
251  // ANALYTICDIRECTIONAL
252  // --------------------------------------------------------------------- //
262  USDRI_API
264 
270  USDRI_API
271  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
272 
273 public:
274  // --------------------------------------------------------------------- //
275  // ANALYTICSHEARX
276  // --------------------------------------------------------------------- //
284  USDRI_API
286 
292  USDRI_API
293  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // ANALYTICSHEARY
298  // --------------------------------------------------------------------- //
306  USDRI_API
308 
314  USDRI_API
315  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
316 
317 public:
318  // --------------------------------------------------------------------- //
319  // ANALYTICAPEX
320  // --------------------------------------------------------------------- //
328  USDRI_API
330 
336  USDRI_API
337  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
338 
339 public:
340  // --------------------------------------------------------------------- //
341  // ANALYTICUSELIGHTDIRECTION
342  // --------------------------------------------------------------------- //
353  USDRI_API
355 
361  USDRI_API
362  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
363 
364 public:
365  // --------------------------------------------------------------------- //
366  // ANALYTICDENSITYNEARDISTANCE
367  // --------------------------------------------------------------------- //
376  USDRI_API
378 
384  USDRI_API
385  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
386 
387 public:
388  // --------------------------------------------------------------------- //
389  // ANALYTICDENSITYFARDISTANCE
390  // --------------------------------------------------------------------- //
399  USDRI_API
401 
407  USDRI_API
408  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
409 
410 public:
411  // --------------------------------------------------------------------- //
412  // ANALYTICDENSITYNEARVALUE
413  // --------------------------------------------------------------------- //
421  USDRI_API
423 
429  USDRI_API
430  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
431 
432 public:
433  // --------------------------------------------------------------------- //
434  // ANALYTICDENSITYFARVALUE
435  // --------------------------------------------------------------------- //
443  USDRI_API
445 
451  USDRI_API
452  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
453 
454 public:
455  // --------------------------------------------------------------------- //
456  // ANALYTICDENSITYEXPONENT
457  // --------------------------------------------------------------------- //
465  USDRI_API
467 
473  USDRI_API
474  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
475 
476 public:
477  // --------------------------------------------------------------------- //
478  // EDGETHICKNESS
479  // --------------------------------------------------------------------- //
488  USDRI_API
490 
496  USDRI_API
497  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
498 
499 public:
500  // --------------------------------------------------------------------- //
501  // PREBARNEFFECT
502  // --------------------------------------------------------------------- //
512  USDRI_API
514 
520  USDRI_API
521  UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
522 
523 public:
524  // --------------------------------------------------------------------- //
525  // SCALEWIDTH
526  // --------------------------------------------------------------------- //
534  USDRI_API
536 
542  USDRI_API
543  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
544 
545 public:
546  // --------------------------------------------------------------------- //
547  // SCALEHEIGHT
548  // --------------------------------------------------------------------- //
556  USDRI_API
558 
564  USDRI_API
565  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
566 
567 public:
568  // --------------------------------------------------------------------- //
569  // REFINETOP
570  // --------------------------------------------------------------------- //
578  USDRI_API
580 
586  USDRI_API
587  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
588 
589 public:
590  // --------------------------------------------------------------------- //
591  // REFINEBOTTOM
592  // --------------------------------------------------------------------- //
600  USDRI_API
602 
608  USDRI_API
609  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
610 
611 public:
612  // --------------------------------------------------------------------- //
613  // REFINELEFT
614  // --------------------------------------------------------------------- //
622  USDRI_API
624 
630  USDRI_API
631  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
632 
633 public:
634  // --------------------------------------------------------------------- //
635  // REFINERIGHT
636  // --------------------------------------------------------------------- //
644  USDRI_API
646 
652  USDRI_API
653  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
654 
655 public:
656  // --------------------------------------------------------------------- //
657  // EDGESCALETOP
658  // --------------------------------------------------------------------- //
666  USDRI_API
668 
674  USDRI_API
675  UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
676 
677 public:
678  // --------------------------------------------------------------------- //
679  // EDGESCALEBOTTOM
680  // --------------------------------------------------------------------- //
688  USDRI_API
690 
696  USDRI_API
697  UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
698 
699 public:
700  // --------------------------------------------------------------------- //
701  // EDGESCALELEFT
702  // --------------------------------------------------------------------- //
710  USDRI_API
712 
718  USDRI_API
719  UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
720 
721 public:
722  // --------------------------------------------------------------------- //
723  // EDGESCALERIGHT
724  // --------------------------------------------------------------------- //
732  USDRI_API
734 
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 
756 PXR_NAMESPACE_CLOSE_SCOPE
757 
758 #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 CreateEdgeScaleTopAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeScaleTopAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetRefineLeftAttr() const
Additional offset adjustment to the left region.
virtual USDRI_API ~UsdRiPxrBarnLightFilter()
Destructor.
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 GetEdgeScaleRightAttr() const
Additional edge scale adjustment to the left region.
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 offset 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 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...
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:127
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:132
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
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.
USDRI_API UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeScaleBottomAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
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 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 offset 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 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 GetEdgeScaleTopAttr() const
Additional edge scale adjustment to the top region.
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 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 offset adjustment to the top region.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
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...
USDRI_API UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeScaleRightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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:174
USDRI_API UsdAttribute GetScaleHeightAttr() const
Scale the height of the inner barn shape.
USDRI_API UsdAttribute GetEdgeScaleBottomAttr() const
Additional edge scale adjustment to the top region.
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 GetEdgeScaleLeftAttr() const
Additional edge scale adjustment to the left region.
USDRI_API UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeScaleLeftAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetAnalyticUseLightDirectionAttr() const
When this is on, If this is on, the projection direction is determined by the position of the center ...