HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrAovLight.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_PXRAOVLIGHT_H
25 #define USDRI_GENERATED_PXRAOVLIGHT_H
26 
27 /// \file usdRi/pxrAovLight.h
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdRi/api.h"
31 #include "pxr/usd/usdLux/light.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 // PXRAOVLIGHT //
51 // -------------------------------------------------------------------------- //
52 
53 /// \class UsdRiPxrAovLight
54 ///
55 /// \deprecated This schema will be replaced in a future release.
56 ///
58 {
59 public:
60  /// Compile time constant representing what kind of schema this class is.
61  ///
62  /// \sa UsdSchemaKind
64 
65  /// Construct a UsdRiPxrAovLight on UsdPrim \p prim .
66  /// Equivalent to UsdRiPxrAovLight::Get(prim.GetStage(), prim.GetPath())
67  /// for a \em valid \p prim, but will not immediately throw an error for
68  /// an invalid \p prim
69  explicit UsdRiPxrAovLight(const UsdPrim& prim=UsdPrim())
70  : UsdLuxLight(prim)
71  {
72  }
73 
74  /// Construct a UsdRiPxrAovLight on the prim held by \p schemaObj .
75  /// Should be preferred over UsdRiPxrAovLight(schemaObj.GetPrim()),
76  /// as it preserves SchemaBase state.
77  explicit UsdRiPxrAovLight(const UsdSchemaBase& schemaObj)
78  : UsdLuxLight(schemaObj)
79  {
80  }
81 
82  /// Destructor.
83  USDRI_API
84  virtual ~UsdRiPxrAovLight();
85 
86  /// Return a vector of names of all pre-declared attributes for this schema
87  /// class and all its ancestor classes. Does not include attributes that
88  /// may be authored by custom/extended methods of the schemas involved.
89  USDRI_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
93  /// Return a UsdRiPxrAovLight holding the prim adhering to this
94  /// schema at \p path on \p stage. If no prim exists at \p path on
95  /// \p stage, or if the prim at that path does not adhere to this schema,
96  /// return an invalid schema object. This is shorthand for the following:
97  ///
98  /// \code
99  /// UsdRiPxrAovLight(stage->GetPrimAtPath(path));
100  /// \endcode
101  ///
102  USDRI_API
103  static UsdRiPxrAovLight
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
106  /// Attempt to ensure a \a UsdPrim adhering to this schema at \p path
107  /// is defined (according to UsdPrim::IsDefined()) on this stage.
108  ///
109  /// If a prim adhering to this schema at \p path is already defined on this
110  /// stage, return that prim. Otherwise author an \a SdfPrimSpec with
111  /// \a specifier == \a SdfSpecifierDef and this schema's prim type name for
112  /// the prim at \p path at the current EditTarget. Author \a SdfPrimSpec s
113  /// with \p specifier == \a SdfSpecifierDef and empty typeName at the
114  /// current EditTarget for any nonexistent, or existing but not \a Defined
115  /// ancestors.
116  ///
117  /// The given \a path must be an absolute prim path that does not contain
118  /// any variant selections.
119  ///
120  /// If it is impossible to author any of the necessary PrimSpecs, (for
121  /// example, in case \a path cannot map to the current UsdEditTarget's
122  /// namespace) issue an error and return an invalid \a UsdPrim.
123  ///
124  /// Note that this method may return a defined prim whose typeName does not
125  /// specify this schema class, in case a stronger typeName opinion overrides
126  /// the opinion at the current EditTarget.
127  ///
128  USDRI_API
129  static UsdRiPxrAovLight
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
133  /// Returns the kind of schema this class belongs to.
134  ///
135  /// \sa UsdSchemaKind
136  USDRI_API
137  UsdSchemaKind _GetSchemaKind() const override;
138 
139 private:
140  // needs to invoke _GetStaticTfType.
141  friend class UsdSchemaRegistry;
142  USDRI_API
143  static const TfType &_GetStaticTfType();
144 
145  static bool _IsTypedSchema();
146 
147  // override SchemaBase virtuals.
148  USDRI_API
149  const TfType &_GetTfType() const override;
150 
151 public:
152  // --------------------------------------------------------------------- //
153  // AOVNAME
154  // --------------------------------------------------------------------- //
155  /// The name of the AOV to write to.
156  ///
157  /// | ||
158  /// | -- | -- |
159  /// | Declaration | `string aovName = ""` |
160  /// | C++ Type | std::string |
161  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->String |
162  USDRI_API
164 
165  /// See GetAovNameAttr(), and also
166  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
167  /// If specified, author \p defaultValue as the attribute's default,
168  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
169  /// the default for \p writeSparsely is \c false.
170  USDRI_API
171  UsdAttribute CreateAovNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
172 
173 public:
174  // --------------------------------------------------------------------- //
175  // INPRIMARYHIT
176  // --------------------------------------------------------------------- //
177  /// If this is on, the usual mask of the illuminated objects
178  /// is generated. If this is off, you can get a mask of only in the
179  /// refraction or reflection.
180  ///
181  /// | ||
182  /// | -- | -- |
183  /// | Declaration | `bool inPrimaryHit = 1` |
184  /// | C++ Type | bool |
185  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
186  USDRI_API
188 
189  /// See GetInPrimaryHitAttr(), and also
190  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
191  /// If specified, author \p defaultValue as the attribute's default,
192  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
193  /// the default for \p writeSparsely is \c false.
194  USDRI_API
195  UsdAttribute CreateInPrimaryHitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // --------------------------------------------------------------------- //
199  // INREFLECTION
200  // --------------------------------------------------------------------- //
201  /// If this is on, the rays are traced through the specular
202  /// reflections to get the masking signal. Warning: this will
203  /// require some amount of samples to get a clean mask.
204  ///
205  /// | ||
206  /// | -- | -- |
207  /// | Declaration | `bool inReflection = 0` |
208  /// | C++ Type | bool |
209  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
210  USDRI_API
212 
213  /// See GetInReflectionAttr(), and also
214  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
215  /// If specified, author \p defaultValue as the attribute's default,
216  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
217  /// the default for \p writeSparsely is \c false.
218  USDRI_API
219  UsdAttribute CreateInReflectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220 
221 public:
222  // --------------------------------------------------------------------- //
223  // INREFRACTION
224  // --------------------------------------------------------------------- //
225  /// If this is on, the rays are traced through the glass
226  /// refractions to get the masking signal. Warning: this will
227  /// require some amount of samples to get a clean mask.
228  ///
229  /// | ||
230  /// | -- | -- |
231  /// | Declaration | `bool inRefraction = 0` |
232  /// | C++ Type | bool |
233  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
234  USDRI_API
236 
237  /// See GetInRefractionAttr(), and also
238  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
239  /// If specified, author \p defaultValue as the attribute's default,
240  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
241  /// the default for \p writeSparsely is \c false.
242  USDRI_API
243  UsdAttribute CreateInRefractionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
244 
245 public:
246  // --------------------------------------------------------------------- //
247  // INVERT
248  // --------------------------------------------------------------------- //
249  /// If this is on, it inverts the signal for the AOV.
250  ///
251  /// | ||
252  /// | -- | -- |
253  /// | Declaration | `bool invert = 0` |
254  /// | C++ Type | bool |
255  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
256  USDRI_API
257  UsdAttribute GetInvertAttr() const;
258 
259  /// See GetInvertAttr(), and also
260  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
261  /// If specified, author \p defaultValue as the attribute's default,
262  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
263  /// the default for \p writeSparsely is \c false.
264  USDRI_API
265  UsdAttribute CreateInvertAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
266 
267 public:
268  // --------------------------------------------------------------------- //
269  // ONVOLUMEBOUNDARIES
270  // --------------------------------------------------------------------- //
271  /// If this is on, the bounding box or shape of volumes will
272  /// appear in the mask. Since this is not always desirable, this can
273  /// be turned off.
274  ///
275  /// | ||
276  /// | -- | -- |
277  /// | Declaration | `bool onVolumeBoundaries = 1` |
278  /// | C++ Type | bool |
279  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
280  USDRI_API
282 
283  /// See GetOnVolumeBoundariesAttr(), and also
284  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
285  /// If specified, author \p defaultValue as the attribute's default,
286  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
287  /// the default for \p writeSparsely is \c false.
288  USDRI_API
289  UsdAttribute CreateOnVolumeBoundariesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
290 
291 public:
292  // --------------------------------------------------------------------- //
293  // USECOLOR
294  // --------------------------------------------------------------------- //
295  /// If this is on, it outputs a RGB color image instead of a
296  /// float image for the AOV.
297  ///
298  /// | ||
299  /// | -- | -- |
300  /// | Declaration | `bool useColor = 0` |
301  /// | C++ Type | bool |
302  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
303  USDRI_API
305 
306  /// See GetUseColorAttr(), and also
307  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
308  /// If specified, author \p defaultValue as the attribute's default,
309  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
310  /// the default for \p writeSparsely is \c false.
311  USDRI_API
312  UsdAttribute CreateUseColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
313 
314 public:
315  // --------------------------------------------------------------------- //
316  // USETHROUGHPUT
317  // --------------------------------------------------------------------- //
318  /// If this is on, the values in the mask for the reflected
319  /// or refracted rays will be affected by the strength of the reflection
320  /// or refraction. This can lead to values below and above 1.0. Turn
321  /// this off if you want a more solid mask.
322  ///
323  /// | ||
324  /// | -- | -- |
325  /// | Declaration | `bool useThroughput = 1` |
326  /// | C++ Type | bool |
327  /// | \ref Usd_Datatypes "Usd Type" | SdfValueTypeNames->Bool |
328  USDRI_API
330 
331  /// See GetUseThroughputAttr(), and also
332  /// \ref Usd_Create_Or_Get_Property for when to use Get vs Create.
333  /// If specified, author \p defaultValue as the attribute's default,
334  /// sparsely (when it makes sense to do so) if \p writeSparsely is \c true -
335  /// the default for \p writeSparsely is \c false.
336  USDRI_API
337  UsdAttribute CreateUseThroughputAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
338 
339 public:
340  // ===================================================================== //
341  // Feel free to add custom code below this line, it will be preserved by
342  // the code generator.
343  //
344  // Just remember to:
345  // - Close the class declaration with };
346  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
347  // - Close the include guard with #endif
348  // ===================================================================== //
349  // --(BEGIN CUSTOM CODE)--
350 };
351 
353 
354 #endif
USDRI_API UsdAttribute GetInReflectionAttr() const
USDRI_API UsdSchemaKind _GetSchemaKind() const override
GLsizei const GLchar *const * path
Definition: glcorearb.h:3340
USDRI_API UsdAttribute GetInvertAttr() const
static USDRI_API const TfTokenVector & GetSchemaAttributeNames(bool includeInherited=true)
static const UsdSchemaKind schemaKind
Definition: pxrAovLight.h:63
USDRI_API UsdAttribute GetInRefractionAttr() const
USDRI_API UsdAttribute GetOnVolumeBoundariesAttr() const
USDRI_API UsdAttribute CreateInPrimaryHitAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdSchemaKind
Definition: common.h:127
USDRI_API UsdAttribute GetUseColorAttr() const
USDRI_API UsdAttribute CreateOnVolumeBoundariesAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateAovNameAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateInReflectionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Represents a concrete typed schema.
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
static USDRI_API UsdRiPxrAovLight Get(const UsdStagePtr &stage, const SdfPath &path)
USDRI_API UsdAttribute GetAovNameAttr() const
USDRI_API UsdAttribute CreateUseThroughputAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdRiPxrAovLight(const UsdPrim &prim=UsdPrim())
Definition: pxrAovLight.h:69
PXR_NAMESPACE_CLOSE_SCOPE PXR_NAMESPACE_OPEN_SCOPE
Definition: path.h:1375
USDRI_API UsdAttribute CreateUseColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDRI_API UsdAttribute CreateInRefractionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
UsdRiPxrAovLight(const UsdSchemaBase &schemaObj)
Definition: pxrAovLight.h:77
USDRI_API UsdAttribute GetInPrimaryHitAttr() const
#define PXR_NAMESPACE_CLOSE_SCOPE
Definition: pxr.h:91
static USDRI_API UsdRiPxrAovLight Define(const UsdStagePtr &stage, const SdfPath &path)
Definition: type.h:64
USDRI_API UsdAttribute GetUseThroughputAttr() const
virtual USDRI_API ~UsdRiPxrAovLight()
Destructor.
Definition: value.h:168
USDRI_API UsdAttribute CreateInvertAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const