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 
69 {
70 public:
75 
80  explicit UsdRiPxrRampLightFilter(const UsdPrim& prim=UsdPrim())
81  : UsdLuxLightFilter(prim)
82  {
83  }
84 
88  explicit UsdRiPxrRampLightFilter(const UsdSchemaBase& schemaObj)
89  : UsdLuxLightFilter(schemaObj)
90  {
91  }
92 
94  USDRI_API
95  virtual ~UsdRiPxrRampLightFilter();
96 
100  USDRI_API
101  static const TfTokenVector &
102  GetSchemaAttributeNames(bool includeInherited=true);
103 
113  USDRI_API
115  Get(const UsdStagePtr &stage, const SdfPath &path);
116 
139  USDRI_API
141  Define(const UsdStagePtr &stage, const SdfPath &path);
142 
143 protected:
147  USDRI_API
148  UsdSchemaType _GetSchemaType() const override;
149 
150 private:
151  // needs to invoke _GetStaticTfType.
152  friend class UsdSchemaRegistry;
153  USDRI_API
154  static const TfType &_GetStaticTfType();
155 
156  static bool _IsTypedSchema();
157 
158  // override SchemaBase virtuals.
159  USDRI_API
160  const TfType &_GetTfType() const override;
161 
162 public:
163  // --------------------------------------------------------------------- //
164  // RAMPMODE
165  // --------------------------------------------------------------------- //
174  USDRI_API
176 
182  USDRI_API
183  UsdAttribute CreateRampModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
184 
185 public:
186  // --------------------------------------------------------------------- //
187  // BEGINDISTANCE
188  // --------------------------------------------------------------------- //
196  USDRI_API
198 
204  USDRI_API
205  UsdAttribute CreateBeginDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
206 
207 public:
208  // --------------------------------------------------------------------- //
209  // ENDDISTANCE
210  // --------------------------------------------------------------------- //
218  USDRI_API
220 
226  USDRI_API
227  UsdAttribute CreateEndDistanceAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
228 
229 public:
230  // --------------------------------------------------------------------- //
231  // FALLOFF
232  // --------------------------------------------------------------------- //
240  USDRI_API
242 
248  USDRI_API
249  UsdAttribute CreateFalloffAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
250 
251 public:
252  // --------------------------------------------------------------------- //
253  // FALLOFFKNOTS
254  // --------------------------------------------------------------------- //
262  USDRI_API
264 
270  USDRI_API
271  UsdAttribute CreateFalloffKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
272 
273 public:
274  // --------------------------------------------------------------------- //
275  // FALLOFFFLOATS
276  // --------------------------------------------------------------------- //
284  USDRI_API
286 
292  USDRI_API
293  UsdAttribute CreateFalloffFloatsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // FALLOFFINTERPOLATION
298  // --------------------------------------------------------------------- //
307  USDRI_API
309 
315  USDRI_API
316  UsdAttribute CreateFalloffInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
317 
318 public:
319  // --------------------------------------------------------------------- //
320  // COLORRAMP
321  // --------------------------------------------------------------------- //
329  USDRI_API
331 
337  USDRI_API
338  UsdAttribute CreateColorRampAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
339 
340 public:
341  // --------------------------------------------------------------------- //
342  // COLORRAMPKNOTS
343  // --------------------------------------------------------------------- //
351  USDRI_API
353 
359  USDRI_API
360  UsdAttribute CreateColorRampKnotsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
361 
362 public:
363  // --------------------------------------------------------------------- //
364  // COLORRAMPCOLORS
365  // --------------------------------------------------------------------- //
373  USDRI_API
375 
381  USDRI_API
382  UsdAttribute CreateColorRampColorsAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
383 
384 public:
385  // --------------------------------------------------------------------- //
386  // COLORRAMPINTERPOLATION
387  // --------------------------------------------------------------------- //
396  USDRI_API
398 
404  USDRI_API
405  UsdAttribute CreateColorRampInterpolationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
406 
407 public:
408  // ===================================================================== //
409  // Feel free to add custom code below this line, it will be preserved by
410  // the code generator.
411  //
412  // Just remember to:
413  // - Close the class declaration with };
414  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
415  // - Close the include guard with #endif
416  // ===================================================================== //
417  // --(BEGIN CUSTOM CODE)--
418 
421  USDRI_API
423 
426  USDRI_API
428 };
429 
430 PXR_NAMESPACE_CLOSE_SCOPE
431 
432 #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...
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
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
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:288
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:64
USDRI_API UsdAttribute GetColorRampKnotsAttr() const
Knots of the colorRamp spline.
Singleton registry that provides access to schema type information and the prim definitions for regis...
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:174
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
USDRI_API UsdRiSplineAPI GetFalloffRampAPI() const
Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp.