All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrRampLightFilter.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_PXRRAMPLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRRAMPLIGHTFILTER_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 // PXRRAMPLIGHTFILTER //
54 // -------------------------------------------------------------------------- //
55 
66 {
67 public:
72 
77  explicit UsdRiPxrRampLightFilter(const UsdPrim& prim=UsdPrim())
78  : UsdLuxLightFilter(prim)
79  {
80  }
81 
85  explicit UsdRiPxrRampLightFilter(const UsdSchemaBase& schemaObj)
86  : UsdLuxLightFilter(schemaObj)
87  {
88  }
89 
91  USDRI_API
92  virtual ~UsdRiPxrRampLightFilter();
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  // RAMPMODE
162  // --------------------------------------------------------------------- //
171  USDRI_API
173 
179  USDRI_API
180  UsdAttribute CreateRampModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
181 
182 public:
183  // --------------------------------------------------------------------- //
184  // BEGINDISTANCE
185  // --------------------------------------------------------------------- //
193  USDRI_API
195 
201  USDRI_API
202  UsdAttribute CreateBeginDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
203 
204 public:
205  // --------------------------------------------------------------------- //
206  // ENDDISTANCE
207  // --------------------------------------------------------------------- //
215  USDRI_API
217 
223  USDRI_API
224  UsdAttribute CreateEndDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
225 
226 public:
227  // --------------------------------------------------------------------- //
228  // FALLOFF
229  // --------------------------------------------------------------------- //
237  USDRI_API
239 
245  USDRI_API
246  UsdAttribute CreateFalloffAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
247 
248 public:
249  // --------------------------------------------------------------------- //
250  // FALLOFFKNOTS
251  // --------------------------------------------------------------------- //
259  USDRI_API
261 
267  USDRI_API
268  UsdAttribute CreateFalloffKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
269 
270 public:
271  // --------------------------------------------------------------------- //
272  // FALLOFFFLOATS
273  // --------------------------------------------------------------------- //
281  USDRI_API
283 
289  USDRI_API
290  UsdAttribute CreateFalloffFloatsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
291 
292 public:
293  // --------------------------------------------------------------------- //
294  // FALLOFFINTERPOLATION
295  // --------------------------------------------------------------------- //
304  USDRI_API
306 
312  USDRI_API
313  UsdAttribute CreateFalloffInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
314 
315 public:
316  // --------------------------------------------------------------------- //
317  // COLORRAMP
318  // --------------------------------------------------------------------- //
326  USDRI_API
328 
334  USDRI_API
335  UsdAttribute CreateColorRampAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
336 
337 public:
338  // --------------------------------------------------------------------- //
339  // COLORRAMPKNOTS
340  // --------------------------------------------------------------------- //
348  USDRI_API
350 
356  USDRI_API
357  UsdAttribute CreateColorRampKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
358 
359 public:
360  // --------------------------------------------------------------------- //
361  // COLORRAMPCOLORS
362  // --------------------------------------------------------------------- //
370  USDRI_API
372 
378  USDRI_API
379  UsdAttribute CreateColorRampColorsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
380 
381 public:
382  // --------------------------------------------------------------------- //
383  // COLORRAMPINTERPOLATION
384  // --------------------------------------------------------------------- //
393  USDRI_API
395 
401  USDRI_API
402  UsdAttribute CreateColorRampInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
403 
404 public:
405  // ===================================================================== //
406  // Feel free to add custom code below this line, it will be preserved by
407  // the code generator.
408  //
409  // Just remember to:
410  // - Close the class declaration with };
411  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
412  // - Close the include guard with #endif
413  // ===================================================================== //
414  // --(BEGIN CUSTOM CODE)--
415 
418  USDRI_API
420 
423  USDRI_API
425 };
426 
427 PXR_NAMESPACE_CLOSE_SCOPE
428 
429 #endif
USDRI_API UsdAttribute CreateFalloffInterpolationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFalloffInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs Cre...
USDRI_API UsdAttribute CreateFalloffKnotsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFalloffKnotsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetBeginDistanceAttr() const
Distance where the ramp starts.
USDRI_API UsdAttribute GetFalloffInterpolationAttr() const
Falloff spline type.
USDRI_API UsdAttribute GetFalloffAttr() const
Controls the transition from the core to the edge.
USDRI_API UsdAttribute CreateRampModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRampModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetFalloffFloatsAttr() const
Float values of the falloff spline.
USDRI_API UsdAttribute CreateColorRampKnotsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorRampKnotsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetRampModeAttr() const
Specifies the direction in which the ramp is applied.
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 UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
static USDRI_API UsdRiPxrRampLightFilter 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 GetColorRampColorsAttr() const
Color values of the colorRamp spline.
USDRI_API UsdAttribute CreateColorRampInterpolationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorRampInterpolationAttr(), and also Create vs Get Property Methods for when to use Get vs C...
USDRI_API UsdAttribute CreateFalloffFloatsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFalloffFloatsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
RiSplineAPI is a general purpose API schema used to describe a named spline stored as a set of attrib...
Definition: splineAPI.h:71
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
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:433
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...
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
UsdRiPxrRampLightFilter(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrRampLightFilter on UsdPrim prim .
USDRI_API UsdRiSplineAPI GetColorRampAPI() const
Return the UsdRiSplineAPI interface used for examining and modifying the color ramp.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
USDRI_API UsdAttribute CreateBeginDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetBeginDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetColorRampAttr() const
Controls the color gradient for the transition.
virtual USDRI_API ~UsdRiPxrRampLightFilter()
Destructor.
TfType represents a dynamic runtime type.
Definition: type.h:70
USDRI_API UsdAttribute GetColorRampKnotsAttr() const
Knots of the colorRamp spline.
Singleton registry that provides access to prim and property definition information for registered Us...
USDRI_API UsdAttribute CreateColorRampColorsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorRampColorsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDRI_API UsdRiPxrRampLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrRampLightFilter holding the prim adhering to this schema at path on stage...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDRI_API UsdAttribute GetFalloffKnotsAttr() const
Knots of the falloff spline.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
USDRI_API UsdAttribute CreateEndDistanceAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetEndDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetEndDistanceAttr() const
Distance where the ramp ends.
USDRI_API UsdAttribute GetColorRampInterpolationAttr() const
ColorRamp spline type.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
USDRI_API UsdAttribute CreateFalloffAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetFalloffAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdRiPxrRampLightFilter(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrRampLightFilter on the prim held by schemaObj .
USDRI_API UsdAttribute CreateColorRampAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetColorRampAttr(), 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
A ramp to modulate how a light falls off with distance.
USDRI_API UsdRiSplineAPI GetFalloffRampAPI() const
Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp.