All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrRodLightFilter.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_PXRRODLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRRODLIGHTFILTER_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/usd/usdRi/splineAPI.h"
37 
38 
39 #include "pxr/base/vt/value.h"
40 
41 #include "pxr/base/gf/vec3d.h"
42 #include "pxr/base/gf/vec3f.h"
43 #include "pxr/base/gf/matrix4d.h"
44 
45 #include "pxr/base/tf/token.h"
46 #include "pxr/base/tf/type.h"
47 
48 PXR_NAMESPACE_OPEN_SCOPE
49 
50 class SdfAssetPath;
51 
52 // -------------------------------------------------------------------------- //
53 // PXRRODLIGHTFILTER //
54 // -------------------------------------------------------------------------- //
55 
61 {
62 public:
67 
72  explicit UsdRiPxrRodLightFilter(const UsdPrim& prim=UsdPrim())
73  : UsdLuxLightFilter(prim)
74  {
75  }
76 
80  explicit UsdRiPxrRodLightFilter(const UsdSchemaBase& schemaObj)
81  : UsdLuxLightFilter(schemaObj)
82  {
83  }
84 
86  USDRI_API
87  virtual ~UsdRiPxrRodLightFilter();
88 
92  USDRI_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
105  USDRI_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
131  USDRI_API
133  Define(const UsdStagePtr &stage, const SdfPath &path);
134 
135 protected:
139  USDRI_API
140  UsdSchemaType _GetSchemaType() const override;
141 
142 private:
143  // needs to invoke _GetStaticTfType.
144  friend class UsdSchemaRegistry;
145  USDRI_API
146  static const TfType &_GetStaticTfType();
147 
148  static bool _IsTypedSchema();
149 
150  // override SchemaBase virtuals.
151  USDRI_API
152  const TfType &_GetTfType() const override;
153 
154 public:
155  // --------------------------------------------------------------------- //
156  // WIDTH
157  // --------------------------------------------------------------------- //
164  USDRI_API
165  UsdAttribute GetWidthAttr() const;
166 
172  USDRI_API
173  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
174 
175 public:
176  // --------------------------------------------------------------------- //
177  // HEIGHT
178  // --------------------------------------------------------------------- //
185  USDRI_API
186  UsdAttribute GetHeightAttr() const;
187 
193  USDRI_API
194  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
195 
196 public:
197  // --------------------------------------------------------------------- //
198  // DEPTH
199  // --------------------------------------------------------------------- //
206  USDRI_API
207  UsdAttribute GetDepthAttr() const;
208 
214  USDRI_API
215  UsdAttribute CreateDepthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
216 
217 public:
218  // --------------------------------------------------------------------- //
219  // RADIUS
220  // --------------------------------------------------------------------- //
227  USDRI_API
228  UsdAttribute GetRadiusAttr() const;
229 
235  USDRI_API
236  UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
237 
238 public:
239  // --------------------------------------------------------------------- //
240  // EDGETHICKNESS
241  // --------------------------------------------------------------------- //
249  USDRI_API
251 
257  USDRI_API
258  UsdAttribute CreateEdgeThicknessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
259 
260 public:
261  // --------------------------------------------------------------------- //
262  // SCALEWIDTH
263  // --------------------------------------------------------------------- //
270  USDRI_API
272 
278  USDRI_API
279  UsdAttribute CreateScaleWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
280 
281 public:
282  // --------------------------------------------------------------------- //
283  // SCALEHEIGHT
284  // --------------------------------------------------------------------- //
291  USDRI_API
293 
299  USDRI_API
300  UsdAttribute CreateScaleHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
301 
302 public:
303  // --------------------------------------------------------------------- //
304  // SCALEDEPTH
305  // --------------------------------------------------------------------- //
312  USDRI_API
314 
320  USDRI_API
321  UsdAttribute CreateScaleDepthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
322 
323 public:
324  // --------------------------------------------------------------------- //
325  // REFINETOP
326  // --------------------------------------------------------------------- //
333  USDRI_API
335 
341  USDRI_API
342  UsdAttribute CreateRefineTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
343 
344 public:
345  // --------------------------------------------------------------------- //
346  // REFINEBOTTOM
347  // --------------------------------------------------------------------- //
354  USDRI_API
356 
362  USDRI_API
363  UsdAttribute CreateRefineBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
364 
365 public:
366  // --------------------------------------------------------------------- //
367  // REFINELEFT
368  // --------------------------------------------------------------------- //
375  USDRI_API
377 
383  USDRI_API
384  UsdAttribute CreateRefineLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
385 
386 public:
387  // --------------------------------------------------------------------- //
388  // REFINERIGHT
389  // --------------------------------------------------------------------- //
396  USDRI_API
398 
404  USDRI_API
405  UsdAttribute CreateRefineRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
406 
407 public:
408  // --------------------------------------------------------------------- //
409  // REFINEFRONT
410  // --------------------------------------------------------------------- //
417  USDRI_API
419 
425  USDRI_API
426  UsdAttribute CreateRefineFrontAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
427 
428 public:
429  // --------------------------------------------------------------------- //
430  // REFINEBACK
431  // --------------------------------------------------------------------- //
438  USDRI_API
440 
446  USDRI_API
447  UsdAttribute CreateRefineBackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
448 
449 public:
450  // --------------------------------------------------------------------- //
451  // EDGETOP
452  // --------------------------------------------------------------------- //
459  USDRI_API
461 
467  USDRI_API
468  UsdAttribute CreateEdgeTopAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
469 
470 public:
471  // --------------------------------------------------------------------- //
472  // EDGEBOTTOM
473  // --------------------------------------------------------------------- //
480  USDRI_API
482 
488  USDRI_API
489  UsdAttribute CreateEdgeBottomAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
490 
491 public:
492  // --------------------------------------------------------------------- //
493  // EDGELEFT
494  // --------------------------------------------------------------------- //
501  USDRI_API
503 
509  USDRI_API
510  UsdAttribute CreateEdgeLeftAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
511 
512 public:
513  // --------------------------------------------------------------------- //
514  // EDGERIGHT
515  // --------------------------------------------------------------------- //
522  USDRI_API
524 
530  USDRI_API
531  UsdAttribute CreateEdgeRightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
532 
533 public:
534  // --------------------------------------------------------------------- //
535  // EDGEFRONT
536  // --------------------------------------------------------------------- //
543  USDRI_API
545 
551  USDRI_API
552  UsdAttribute CreateEdgeFrontAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
553 
554 public:
555  // --------------------------------------------------------------------- //
556  // EDGEBACK
557  // --------------------------------------------------------------------- //
564  USDRI_API
566 
572  USDRI_API
573  UsdAttribute CreateEdgeBackAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
574 
575 public:
576  // --------------------------------------------------------------------- //
577  // COLORSATURATION
578  // --------------------------------------------------------------------- //
586  USDRI_API
588 
594  USDRI_API
595  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
596 
597 public:
598  // ===================================================================== //
599  // Feel free to add custom code below this line, it will be preserved by
600  // the code generator.
601  //
602  // Just remember to:
603  // - Close the class declaration with };
604  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
605  // - Close the include guard with #endif
606  // ===================================================================== //
607  // --(BEGIN CUSTOM CODE)--
608 
611  USDRI_API
613 
617  USDRI_API
619 };
620 
621 PXR_NAMESPACE_CLOSE_SCOPE
622 
623 #endif
USDRI_API UsdAttribute GetScaleHeightAttr() const
Scale the height of the inner rod shape.
Simulates a rod or capsule-shaped region to modulate light.
USDRI_API UsdAttribute CreateScaleDepthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetScaleDepthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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...
static USDRI_API UsdRiPxrRodLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrRodLightFilter holding the prim adhering to this schema at path on stage...
USDRI_API UsdAttribute GetEdgeThicknessAttr() const
Thickness of the edge region.
USDRI_API UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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 GetEdgeBackAttr() const
Additional adjustment to the back region.
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 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...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
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 GetRadiusAttr() const
Radius of the corners of the inner rod box.
USDRI_API UsdAttribute GetScaleDepthAttr() const
Scale the depth of the inner rod shape.
USDRI_API UsdAttribute GetWidthAttr() const
Width of the inner region of the rod (X axis).
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
USDRI_API UsdAttribute GetRefineBackAttr() const
Additional adjustment to the back region.
UsdRiPxrRodLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrRodLightFilter on UsdPrim prim .
USDRI_API UsdAttribute GetEdgeRightAttr() const
Additional adjustment to the left region.
RiSplineAPI is a general purpose API schema used to describe a named spline stored as a set of attrib...
Definition: splineAPI.h:71
USDRI_API UsdAttribute GetScaleWidthAttr() const
Scale the width of the inner rod shape.
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
USDRI_API UsdAttribute GetRefineRightAttr() const
Additional adjustment to the left region.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
USDRI_API UsdAttribute GetEdgeTopAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute CreateEdgeFrontAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeFrontAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetHeightAttr() const
Height of the inner region of the rod (Y axis).
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
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 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...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDRI_API UsdAttribute CreateEdgeBackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEdgeBackAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateRefineBackAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineBackAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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 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...
virtual USDRI_API ~UsdRiPxrRodLightFilter()
Destructor.
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
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 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 GetEdgeFrontAttr() const
Additional adjustment to the front region.
USDRI_API UsdAttribute GetEdgeLeftAttr() const
Additional adjustment to the left region.
USDRI_API UsdAttribute GetRefineFrontAttr() const
Additional adjustment to the front region.
USDRI_API UsdAttribute GetDepthAttr() const
Depth of the inner region of the rod (Z axis).
static USDRI_API UsdRiPxrRodLightFilter 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 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 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...
TfType represents a dynamic runtime type.
Definition: type.h:70
USDRI_API UsdAttribute CreateDepthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDepthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Singleton registry that provides access to prim and property definition information for registered Us...
UsdRiPxrRodLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrRodLightFilter on the prim held by schemaObj .
USDRI_API UsdAttribute CreateRefineFrontAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRefineFrontAttr(), 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 GetEdgeBottomAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute GetColorSaturationAttr() const
Saturation of the result (0=greyscale, 1=normal, &gt;1=boosted colors).
USDRI_API UsdAttribute GetRefineTopAttr() const
Additional adjustment to the top region.
USDRI_API UsdAttribute GetRefineBottomAttr() const
Additional adjustment to the top region.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDRI_API UsdRiSplineAPI GetFalloffRampAPI() const
Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp.
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...
A light filter modifies the effect of a light.
Definition: lightFilter.h:76
USDRI_API UsdRiSplineAPI GetColorRampAPI() const
Return the UsdRiSplineAPI interface used for examining and modifying the color ramp.
USDRI_API UsdAttribute GetRefineLeftAttr() const
Additional adjustment to the left region.