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 
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 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // PXRAOVLIGHT //
51 // -------------------------------------------------------------------------- //
52 
56 class UsdRiPxrAovLight : public UsdLuxLight
57 {
58 public:
62  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
63 
68  explicit UsdRiPxrAovLight(const UsdPrim& prim=UsdPrim())
69  : UsdLuxLight(prim)
70  {
71  }
72 
76  explicit UsdRiPxrAovLight(const UsdSchemaBase& schemaObj)
77  : UsdLuxLight(schemaObj)
78  {
79  }
80 
82  USDRI_API
83  virtual ~UsdRiPxrAovLight();
84 
88  USDRI_API
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
101  USDRI_API
102  static UsdRiPxrAovLight
103  Get(const UsdStagePtr &stage, const SdfPath &path);
104 
127  USDRI_API
128  static UsdRiPxrAovLight
129  Define(const UsdStagePtr &stage, const SdfPath &path);
130 
131 protected:
135  USDRI_API
136  UsdSchemaType _GetSchemaType() const override;
137 
138 private:
139  // needs to invoke _GetStaticTfType.
140  friend class UsdSchemaRegistry;
141  USDRI_API
142  static const TfType &_GetStaticTfType();
143 
144  static bool _IsTypedSchema();
145 
146  // override SchemaBase virtuals.
147  USDRI_API
148  const TfType &_GetTfType() const override;
149 
150 public:
151  // --------------------------------------------------------------------- //
152  // AOVNAME
153  // --------------------------------------------------------------------- //
161  USDRI_API
162  UsdAttribute GetAovNameAttr() const;
163 
169  USDRI_API
170  UsdAttribute CreateAovNameAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // INPRIMARYHIT
175  // --------------------------------------------------------------------- //
185  USDRI_API
186  UsdAttribute GetInPrimaryHitAttr() const;
187 
193  USDRI_API
194  UsdAttribute CreateInPrimaryHitAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
195 
196 public:
197  // --------------------------------------------------------------------- //
198  // INREFLECTION
199  // --------------------------------------------------------------------- //
209  USDRI_API
210  UsdAttribute GetInReflectionAttr() const;
211 
217  USDRI_API
218  UsdAttribute CreateInReflectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
219 
220 public:
221  // --------------------------------------------------------------------- //
222  // INREFRACTION
223  // --------------------------------------------------------------------- //
233  USDRI_API
234  UsdAttribute GetInRefractionAttr() const;
235 
241  USDRI_API
242  UsdAttribute CreateInRefractionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
243 
244 public:
245  // --------------------------------------------------------------------- //
246  // INVERT
247  // --------------------------------------------------------------------- //
255  USDRI_API
256  UsdAttribute GetInvertAttr() const;
257 
263  USDRI_API
264  UsdAttribute CreateInvertAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
265 
266 public:
267  // --------------------------------------------------------------------- //
268  // ONVOLUMEBOUNDARIES
269  // --------------------------------------------------------------------- //
279  USDRI_API
280  UsdAttribute GetOnVolumeBoundariesAttr() const;
281 
287  USDRI_API
288  UsdAttribute CreateOnVolumeBoundariesAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
289 
290 public:
291  // --------------------------------------------------------------------- //
292  // USECOLOR
293  // --------------------------------------------------------------------- //
302  USDRI_API
303  UsdAttribute GetUseColorAttr() const;
304 
310  USDRI_API
311  UsdAttribute CreateUseColorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
312 
313 public:
314  // --------------------------------------------------------------------- //
315  // USETHROUGHPUT
316  // --------------------------------------------------------------------- //
327  USDRI_API
328  UsdAttribute GetUseThroughputAttr() const;
329 
335  USDRI_API
336  UsdAttribute CreateUseThroughputAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
337 
338 public:
339  // ===================================================================== //
340  // Feel free to add custom code below this line, it will be preserved by
341  // the code generator.
342  //
343  // Just remember to:
344  // - Close the class declaration with };
345  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
346  // - Close the include guard with #endif
347  // ===================================================================== //
348  // --(BEGIN CUSTOM CODE)--
349 };
350 
351 PXR_NAMESPACE_CLOSE_SCOPE
352 
353 #endif
static USDLUX_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...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
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
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
Base class for all lights.
Definition: light.h:77
TfType represents a dynamic runtime type.
Definition: type.h:70
Singleton registry that provides access to prim and property definition information for registered Us...
static USDLUX_API UsdLuxLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxLight holding the prim adhering to this schema at path on stage.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182