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  // --------------------------------------------------------------------- //
169  USDRI_API
171 
177  USDRI_API
178  UsdAttribute CreateBarnModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179 
180 public:
181  // --------------------------------------------------------------------- //
182  // WIDTH
183  // --------------------------------------------------------------------- //
191  USDRI_API
192  UsdAttribute GetWidthAttr() const;
193 
199  USDRI_API
200  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
201 
202 public:
203  // --------------------------------------------------------------------- //
204  // HEIGHT
205  // --------------------------------------------------------------------- //
213  USDRI_API
214  UsdAttribute GetHeightAttr() const;
215 
221  USDRI_API
222  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
223 
224 public:
225  // --------------------------------------------------------------------- //
226  // RADIUS
227  // --------------------------------------------------------------------- //
235  USDRI_API
236  UsdAttribute GetRadiusAttr() const;
237 
243  USDRI_API
244  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
245 
246 public:
247  // --------------------------------------------------------------------- //
248  // ANALYTICDIRECTIONAL
249  // --------------------------------------------------------------------- //
259  USDRI_API
261 
267  USDRI_API
268  UsdAttribute CreateAnalyticDirectionalAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
269 
270 public:
271  // --------------------------------------------------------------------- //
272  // ANALYTICSHEARX
273  // --------------------------------------------------------------------- //
281  USDRI_API
283 
289  USDRI_API
290  UsdAttribute CreateAnalyticShearXAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
291 
292 public:
293  // --------------------------------------------------------------------- //
294  // ANALYTICSHEARY
295  // --------------------------------------------------------------------- //
303  USDRI_API
305 
311  USDRI_API
312  UsdAttribute CreateAnalyticShearYAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
313 
314 public:
315  // --------------------------------------------------------------------- //
316  // ANALYTICAPEX
317  // --------------------------------------------------------------------- //
325  USDRI_API
327 
333  USDRI_API
334  UsdAttribute CreateAnalyticApexAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
335 
336 public:
337  // --------------------------------------------------------------------- //
338  // ANALYTICUSELIGHTDIRECTION
339  // --------------------------------------------------------------------- //
350  USDRI_API
352 
358  USDRI_API
359  UsdAttribute CreateAnalyticUseLightDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
360 
361 public:
362  // --------------------------------------------------------------------- //
363  // ANALYTICDENSITYNEARDISTANCE
364  // --------------------------------------------------------------------- //
373  USDRI_API
375 
381  USDRI_API
382  UsdAttribute CreateAnalyticDensityNearDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
383 
384 public:
385  // --------------------------------------------------------------------- //
386  // ANALYTICDENSITYFARDISTANCE
387  // --------------------------------------------------------------------- //
396  USDRI_API
398 
404  USDRI_API
405  UsdAttribute CreateAnalyticDensityFarDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
406 
407 public:
408  // --------------------------------------------------------------------- //
409  // ANALYTICDENSITYNEARVALUE
410  // --------------------------------------------------------------------- //
418  USDRI_API
420 
426  USDRI_API
427  UsdAttribute CreateAnalyticDensityNearValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
428 
429 public:
430  // --------------------------------------------------------------------- //
431  // ANALYTICDENSITYFARVALUE
432  // --------------------------------------------------------------------- //
440  USDRI_API
442 
448  USDRI_API
449  UsdAttribute CreateAnalyticDensityFarValueAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
450 
451 public:
452  // --------------------------------------------------------------------- //
453  // ANALYTICDENSITYEXPONENT
454  // --------------------------------------------------------------------- //
462  USDRI_API
464 
470  USDRI_API
471  UsdAttribute CreateAnalyticDensityExponentAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
472 
473 public:
474  // --------------------------------------------------------------------- //
475  // EDGETHICKNESS
476  // --------------------------------------------------------------------- //
485  USDRI_API
487 
493  USDRI_API
494  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
495 
496 public:
497  // --------------------------------------------------------------------- //
498  // PREBARNEFFECT
499  // --------------------------------------------------------------------- //
509  USDRI_API
511 
517  USDRI_API
518  UsdAttribute CreatePreBarnEffectAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
519 
520 public:
521  // --------------------------------------------------------------------- //
522  // SCALEWIDTH
523  // --------------------------------------------------------------------- //
531  USDRI_API
533 
539  USDRI_API
540  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
541 
542 public:
543  // --------------------------------------------------------------------- //
544  // SCALEHEIGHT
545  // --------------------------------------------------------------------- //
553  USDRI_API
555 
561  USDRI_API
562  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
563 
564 public:
565  // --------------------------------------------------------------------- //
566  // REFINETOP
567  // --------------------------------------------------------------------- //
575  USDRI_API
577 
583  USDRI_API
584  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
585 
586 public:
587  // --------------------------------------------------------------------- //
588  // REFINEBOTTOM
589  // --------------------------------------------------------------------- //
597  USDRI_API
599 
605  USDRI_API
606  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
607 
608 public:
609  // --------------------------------------------------------------------- //
610  // REFINELEFT
611  // --------------------------------------------------------------------- //
619  USDRI_API
621 
627  USDRI_API
628  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
629 
630 public:
631  // --------------------------------------------------------------------- //
632  // REFINERIGHT
633  // --------------------------------------------------------------------- //
641  USDRI_API
643 
649  USDRI_API
650  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
651 
652 public:
653  // --------------------------------------------------------------------- //
654  // EDGESCALETOP
655  // --------------------------------------------------------------------- //
663  USDRI_API
665 
671  USDRI_API
672  UsdAttribute CreateEdgeScaleTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
673 
674 public:
675  // --------------------------------------------------------------------- //
676  // EDGESCALEBOTTOM
677  // --------------------------------------------------------------------- //
685  USDRI_API
687 
693  USDRI_API
694  UsdAttribute CreateEdgeScaleBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
695 
696 public:
697  // --------------------------------------------------------------------- //
698  // EDGESCALELEFT
699  // --------------------------------------------------------------------- //
707  USDRI_API
709 
715  USDRI_API
716  UsdAttribute CreateEdgeScaleLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
717 
718 public:
719  // --------------------------------------------------------------------- //
720  // EDGESCALERIGHT
721  // --------------------------------------------------------------------- //
729  USDRI_API
731 
737  USDRI_API
738  UsdAttribute CreateEdgeScaleRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
739 
740 public:
741  // ===================================================================== //
742  // Feel free to add custom code below this line, it will be preserved by
743  // the code generator.
744  //
745  // Just remember to:
746  // - Close the class declaration with };
747  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
748  // - Close the include guard with #endif
749  // ===================================================================== //
750  // --(BEGIN CUSTOM CODE)--
751 };
752 
753 PXR_NAMESPACE_CLOSE_SCOPE
754 
755 #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...
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:127
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:433
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:287
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: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...
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:182
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 ...