HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrIntMultLightFilter.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_PXRINTMULTLIGHTFILTER_H
25 #define USDRI_GENERATED_PXRINTMULTLIGHTFILTER_H
26 
27 /// \file usdRi/pxrIntMultLightFilter.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.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 
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PXRINTMULTLIGHTFILTER //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiPxrIntMultLightFilter
54 ///
55 ///
56 /// \deprecated This schema will be replaced in a future release.
57 /// Multiplies the intensity of a given light.
58 ///
59 ///
61 {
62 public:
63  /// Compile time constant representing what kind of schema this class is.
64  ///
65  /// \sa UsdSchemaType
67 
68  /// Construct a UsdRiPxrIntMultLightFilter on UsdPrim \p prim .
69  /// Equivalent to UsdRiPxrIntMultLightFilter::Get(prim.GetStage(), prim.GetPath())
70  /// for a \em valid \p prim, but will not immediately throw an error for
71  /// an invalid \p prim
72  explicit UsdRiPxrIntMultLightFilter(const UsdPrim& prim=UsdPrim())
73  : UsdLuxLightFilter(prim)
74  {
75  }
76 
77  /// Construct a UsdRiPxrIntMultLightFilter on the prim held by \p schemaObj .
78  /// Should be preferred over UsdRiPxrIntMultLightFilter(schemaObj.GetPrim()),
79  /// as it preserves SchemaBase state.
80  explicit UsdRiPxrIntMultLightFilter(const UsdSchemaBase& schemaObj)
81  : UsdLuxLightFilter(schemaObj)
82  {
83  }
84 
85  /// Destructor.
86  USDRI_API
88 
89  /// Return a vector of names of all pre-declared attributes for this schema
90  /// class and all its ancestor classes. Does not include attributes that
91  /// may be authored by custom/extended methods of the schemas involved.
92  USDRI_API
93  static const TfTokenVector &
94  GetSchemaAttributeNames(bool includeInherited=true);
95 
96  /// Return a UsdRiPxrIntMultLightFilter holding the prim adhering to this
97  /// schema at \p path on \p stage. If no prim exists at \p path on
98  /// \p stage, or if the prim at that path does not adhere to this schema,
99  /// return an invalid schema object. This is shorthand for the following:
100  ///
101  /// \code
102  /// UsdRiPxrIntMultLightFilter(stage->GetPrimAtPath(path));
103  /// \endcode
104  ///
105  USDRI_API
107  Get(const UsdStagePtr &stage, const SdfPath &path);
108 
109  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
110  /// is defined (according to UsdPrim::IsDefined()) on this stage.
111  ///
112  /// If a prim adhering to this schema at \p path is already defined on this
113  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
114  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
115  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
116  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
117  /// current EditTarget for any nonexistent, or existing but not \a Defined
118  /// ancestors.
119  ///
120  /// The given \a path must be an absolute prim path that does not contain
121  /// any variant selections.
122  ///
123  /// If it is impossible to author any of the necessary PrimSpecs, (for
124  /// example, in case \a path cannot map to the current UsdEditTarget's
125  /// namespace) issue an error and return an invalid \a UsdPrim.
126  ///
127  /// Note that this method may return a defined prim whose typeName does not
128  /// specify this schema class, in case a stronger typeName opinion overrides
129  /// the opinion at the current EditTarget.
130  ///
131  USDRI_API
133  Define(const UsdStagePtr &stage, const SdfPath &path);
134 
135 protected:
136  /// Returns the type of schema this class belongs to.
137  ///
138  /// \sa UsdSchemaType
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  // RIINTENSITY
157  // --------------------------------------------------------------------- //
158  /// Multipier for the light intensity.
159  /// This setting is meant to override the fallback value in RiLightFilterAPI
160  ///
161  /// | ||
162  /// | -- | -- |
163  /// | Declaration | `float ri:intensity = 1` |
164  /// | C++ Type | float |
165  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
166  USDRI_API
168 
169  /// See GetRiIntensityAttr(), and also
170  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
171  /// If specified, author \p defaultValue as the attribute's default,
172  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
173  /// the default for \p writeSparsely is \c false.
174  USDRI_API
175  UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
176 
177 public:
178  // --------------------------------------------------------------------- //
179  // COLORSATURATION
180  // --------------------------------------------------------------------- //
181  /// Saturation of the light before hitting the surface (0=greyscale,1=normal,
182  /// >1=boosted colors).
183  ///
184  /// | ||
185  /// | -- | -- |
186  /// | Declaration | `float color:saturation = 1` |
187  /// | C++ Type | float |
188  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
189  USDRI_API
191 
192  /// See GetColorSaturationAttr(), and also
193  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
194  /// If specified, author \p defaultValue as the attribute's default,
195  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
196  /// the default for \p writeSparsely is \c false.
197  USDRI_API
198  UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199 
200 public:
201  // ===================================================================== //
202  // Feel free to add custom code below this line, it will be preserved by
203  // the code generator.
204  //
205  // Just remember to:
206  // - Close the class declaration with };
207  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
208  // - Close the include guard with #endif
209  // ===================================================================== //
210  // --(BEGIN CUSTOM CODE)--
211 };
212 
214 
215 #endif
virtual USDRI_API ~UsdRiPxrIntMultLightFilter()
Destructor.
USDRI_API UsdAttribute CreateColorSaturationAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
USDRI_API UsdAttribute GetRiIntensityAttr() const
Represents a concrete typed schema.
static const UsdSchemaType schemaType
static USDRI_API UsdRiPxrIntMultLightFilter Define(const UsdStagePtr &stage, const SdfPath &path)
UsdRiPxrIntMultLightFilter(const UsdSchemaBase &schemaObj)
UsdSchemaType
Definition: common.h:127
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:446
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
USDRI_API UsdSchemaType _GetSchemaType() const override
GLsizei const GLchar *const * path
Definition: glew.h:6461
static USDRI_API UsdRiPxrIntMultLightFilter Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetColorSaturationAttr() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1346
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
UsdRiPxrIntMultLightFilter(const UsdPrim &prim=UsdPrim())
Definition: type.h:64
USDRI_API UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Definition: value.h:174