HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
lightFilterAPI.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_LIGHTFILTERAPI_H
25 #define USDRI_GENERATED_LIGHTFILTERAPI_H
26 
27 /// \file usdRi/lightFilterAPI.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 // RILIGHTFILTERAPI //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiLightFilterAPI
54 ///
55 ///
56 /// \deprecated RenderMan-specific light filter settings will move to a
57 /// new schema in a future release.
58 ///
59 /// Renderman-specific attributes for light filters.
60 ///
61 /// For any described attribute \em Fallback \em Value or \em Allowed \em Values below
62 /// that are text/tokens, the actual token is published and defined in \ref UsdRiTokens.
63 /// So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded
64 /// as the value.
65 ///
67 {
68 public:
69  /// Compile time constant representing what kind of schema this class is.
70  ///
71  /// \sa UsdSchemaKind
73 
74  /// Construct a UsdRiLightFilterAPI on UsdPrim \p prim .
75  /// Equivalent to UsdRiLightFilterAPI::Get(prim.GetStage(), prim.GetPath())
76  /// for a \em valid \p prim, but will not immediately throw an error for
77  /// an invalid \p prim
78  explicit UsdRiLightFilterAPI(const UsdPrim& prim=UsdPrim())
79  : UsdAPISchemaBase(prim)
80  {
81  }
82 
83  /// Construct a UsdRiLightFilterAPI on the prim held by \p schemaObj .
84  /// Should be preferred over UsdRiLightFilterAPI(schemaObj.GetPrim()),
85  /// as it preserves SchemaBase state.
86  explicit UsdRiLightFilterAPI(const UsdSchemaBase& schemaObj)
87  : UsdAPISchemaBase(schemaObj)
88  {
89  }
90 
91  /// Destructor.
92  USDRI_API
93  virtual ~UsdRiLightFilterAPI();
94 
95  /// Return a vector of names of all pre-declared attributes for this schema
96  /// class and all its ancestor classes. Does not include attributes that
97  /// may be authored by custom/extended methods of the schemas involved.
98  USDRI_API
99  static const TfTokenVector &
100  GetSchemaAttributeNames(bool includeInherited=true);
101 
102  /// Return a UsdRiLightFilterAPI holding the prim adhering to this
103  /// schema at \p path on \p stage. If no prim exists at \p path on
104  /// \p stage, or if the prim at that path does not adhere to this schema,
105  /// return an invalid schema object. This is shorthand for the following:
106  ///
107  /// \code
108  /// UsdRiLightFilterAPI(stage->GetPrimAtPath(path));
109  /// \endcode
110  ///
111  USDRI_API
112  static UsdRiLightFilterAPI
113  Get(const UsdStagePtr &stage, const SdfPath &path);
114 
115 
116  /// Returns true if this <b>single-apply</b> API schema can be applied to
117  /// the given \p prim. If this schema can not be a applied to the prim,
118  /// this returns false and, if provided, populates \p whyNot with the
119  /// reason it can not be applied.
120  ///
121  /// Note that if CanApply returns false, that does not necessarily imply
122  /// that calling Apply will fail. Callers are expected to call CanApply
123  /// before calling Apply if they want to ensure that it is valid to
124  /// apply a schema.
125  ///
126  /// \sa UsdPrim::GetAppliedSchemas()
127  /// \sa UsdPrim::HasAPI()
128  /// \sa UsdPrim::CanApplyAPI()
129  /// \sa UsdPrim::ApplyAPI()
130  /// \sa UsdPrim::RemoveAPI()
131  ///
132  USDRI_API
133  static bool
134  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
135 
136  /// Applies this <b>single-apply</b> API schema to the given \p prim.
137  /// This information is stored by adding "RiLightFilterAPI" to the
138  /// token-valued, listOp metadata \em apiSchemas on the prim.
139  ///
140  /// \return A valid UsdRiLightFilterAPI object is returned upon success.
141  /// An invalid (or empty) UsdRiLightFilterAPI object is returned upon
142  /// failure. See \ref UsdPrim::ApplyAPI() for conditions
143  /// resulting in failure.
144  ///
145  /// \sa UsdPrim::GetAppliedSchemas()
146  /// \sa UsdPrim::HasAPI()
147  /// \sa UsdPrim::CanApplyAPI()
148  /// \sa UsdPrim::ApplyAPI()
149  /// \sa UsdPrim::RemoveAPI()
150  ///
151  USDRI_API
152  static UsdRiLightFilterAPI
153  Apply(const UsdPrim &prim);
154 
155 protected:
156  /// Returns the kind of schema this class belongs to.
157  ///
158  /// \sa UsdSchemaKind
159  USDRI_API
160  UsdSchemaKind _GetSchemaKind() const override;
161 
162 private:
163  // needs to invoke _GetStaticTfType.
164  friend class UsdSchemaRegistry;
165  USDRI_API
166  static const TfType &_GetStaticTfType();
167 
168  static bool _IsTypedSchema();
169 
170  // override SchemaBase virtuals.
171  USDRI_API
172  const TfType &_GetTfType() const override;
173 
174 public:
175  // --------------------------------------------------------------------- //
176  // RICOMBINEMODE
177  // --------------------------------------------------------------------- //
178  /// Specifies how this filter combines with others.
179  /// Valid values are:
180  ///
181  /// - multiply: The results of filters are multiplied together
182  /// - max: The maximum result of the filters is used. This
183  /// works best for grey-scale filters.
184  /// - min: The minimum result of the filters is used. This
185  /// works best for grey-scale filters.
186  /// - screen: Similar to max, but combines gradients in a smoother
187  /// way by using a screen operation:
188  /// <pre>screen(a,b) = 1-(1-a)(1-b)</pre>
189  /// This works best for grey-scale filters.
190  ///
191  /// Light filters on a light are grouped by their combine mode.
192  /// Each group is executed and combined using that mode. Then,
193  /// the final results of each group are multiplied together.
194  ///
195  /// Fallback: multiply
196  ///
197  ///
198  /// | ||
199  /// | -- | -- |
200  /// | Declaration | `token ri:combineMode = "multiply"` |
201  /// | C++ Type | TfToken |
202  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Token |
203  /// | \ref UsdRiTokens "Allowed Values" | multiply, max, min, screen |
204  USDRI_API
206 
207  /// See GetRiCombineModeAttr(), and also
208  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
209  /// If specified, author \p defaultValue as the attribute's default,
210  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
211  /// the default for \p writeSparsely is \c false.
212  USDRI_API
213  UsdAttribute CreateRiCombineModeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
214 
215 public:
216  // --------------------------------------------------------------------- //
217  // RIDENSITY
218  // --------------------------------------------------------------------- //
219  /// Scales the strength of the filter.
220  ///
221  /// | ||
222  /// | -- | -- |
223  /// | Declaration | `float ri:density = 1` |
224  /// | C++ Type | float |
225  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
226  USDRI_API
228 
229  /// See GetRiDensityAttr(), and also
230  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
231  /// If specified, author \p defaultValue as the attribute's default,
232  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
233  /// the default for \p writeSparsely is \c false.
234  USDRI_API
235  UsdAttribute CreateRiDensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236 
237 public:
238  // --------------------------------------------------------------------- //
239  // RIINVERT
240  // --------------------------------------------------------------------- //
241  /// When true, inverts the output of the light filter.
242  ///
243  /// | ||
244  /// | -- | -- |
245  /// | Declaration | `bool ri:invert = 0` |
246  /// | C++ Type | bool |
247  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
248  USDRI_API
250 
251  /// See GetRiInvertAttr(), and also
252  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
253  /// If specified, author \p defaultValue as the attribute's default,
254  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
255  /// the default for \p writeSparsely is \c false.
256  USDRI_API
257  UsdAttribute CreateRiInvertAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
258 
259 public:
260  // --------------------------------------------------------------------- //
261  // RIINTENSITY
262  // --------------------------------------------------------------------- //
263  /// Multipier for the diffuse and specular result.
264  ///
265  /// | ||
266  /// | -- | -- |
267  /// | Declaration | `float ri:intensity = 0` |
268  /// | C++ Type | float |
269  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
270  USDRI_API
272 
273  /// See GetRiIntensityAttr(), and also
274  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
275  /// If specified, author \p defaultValue as the attribute's default,
276  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
277  /// the default for \p writeSparsely is \c false.
278  USDRI_API
279  UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
280 
281 public:
282  // --------------------------------------------------------------------- //
283  // RIEXPOSURE
284  // --------------------------------------------------------------------- //
285  /// Exposure control for the multiplier.
286  ///
287  /// | ||
288  /// | -- | -- |
289  /// | Declaration | `float ri:exposure = 0` |
290  /// | C++ Type | float |
291  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
292  USDRI_API
294 
295  /// See GetRiExposureAttr(), and also
296  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
297  /// If specified, author \p defaultValue as the attribute's default,
298  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
299  /// the default for \p writeSparsely is \c false.
300  USDRI_API
301  UsdAttribute CreateRiExposureAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
302 
303 public:
304  // --------------------------------------------------------------------- //
305  // RIDIFFUSE
306  // --------------------------------------------------------------------- //
307  /// A multiplier for the effect of this light on the diffuse
308  /// response of materials. This is a non-physical control.
309  ///
310  /// | ||
311  /// | -- | -- |
312  /// | Declaration | `float ri:diffuse = 1` |
313  /// | C++ Type | float |
314  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
315  USDRI_API
317 
318  /// See GetRiDiffuseAttr(), and also
319  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
320  /// If specified, author \p defaultValue as the attribute's default,
321  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
322  /// the default for \p writeSparsely is \c false.
323  USDRI_API
324  UsdAttribute CreateRiDiffuseAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
325 
326 public:
327  // --------------------------------------------------------------------- //
328  // RISPECULAR
329  // --------------------------------------------------------------------- //
330  /// A multiplier for the effect of this light on the specular
331  /// response of materials. This is a non-physical control.
332  ///
333  /// | ||
334  /// | -- | -- |
335  /// | Declaration | `float ri:specular = 1` |
336  /// | C++ Type | float |
337  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Float |
338  USDRI_API
340 
341  /// See GetRiSpecularAttr(), and also
342  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
343  /// If specified, author \p defaultValue as the attribute's default,
344  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
345  /// the default for \p writeSparsely is \c false.
346  USDRI_API
347  UsdAttribute CreateRiSpecularAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
348 
349 public:
350  // ===================================================================== //
351  // Feel free to add custom code below this line, it will be preserved by
352  // the code generator.
353  //
354  // Just remember to:
355  // - Close the class declaration with };
356  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
357  // - Close the include guard with #endif
358  // ===================================================================== //
359  // --(BEGIN CUSTOM CODE)--
360 };
361 
363 
364 #endif
static USDRI_API UsdRiLightFilterAPI Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetRiInvertAttr() const
virtual USDRI_API ~UsdRiLightFilterAPI()
Destructor.
USDRI_API UsdAttribute CreateRiCombineModeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
USDRI_API UsdAttribute GetRiDensityAttr() const
UsdRiLightFilterAPI(const UsdSchemaBase &schemaObj)
USDRI_API UsdAttribute CreateRiIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRiCombineModeAttr() const
UsdSchemaKind
Definition: common.h:127
Single Apply API schema.
UsdRiLightFilterAPI(const UsdPrim &prim=UsdPrim())
USDRI_API UsdAttribute CreateRiDensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
GLsizei const GLchar *const * string
Definition: glcorearb.h:813
USDRI_API UsdAttribute GetRiIntensityAttr() const
Definition: prim.h:132
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
#define USDRI_API
Definition: api.h:40
Definition: path.h:288
USDRI_API UsdAttribute CreateRiExposureAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRiSpecularAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateRiInvertAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute GetRiSpecularAttr() const
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
USDRI_API UsdAttribute GetRiDiffuseAttr() const
static USDRI_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
Definition: type.h:64
USDRI_API UsdAttribute CreateRiDiffuseAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdSchemaKind _GetSchemaKind() const override
static USDRI_API UsdRiLightFilterAPI Apply(const UsdPrim &prim)
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
static const UsdSchemaKind schemaKind
Definition: value.h:168
USDRI_API UsdAttribute GetRiExposureAttr() const