All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
pxrEnvDayLight.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_PXRENVDAYLIGHT_H
25 #define USDRI_GENERATED_PXRENVDAYLIGHT_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 // PXRENVDAYLIGHT //
51 // -------------------------------------------------------------------------- //
52 
56 class UsdRiPxrEnvDayLight : public UsdLuxLight
57 {
58 public:
62  static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped;
63 
68  explicit UsdRiPxrEnvDayLight(const UsdPrim& prim=UsdPrim())
69  : UsdLuxLight(prim)
70  {
71  }
72 
76  explicit UsdRiPxrEnvDayLight(const UsdSchemaBase& schemaObj)
77  : UsdLuxLight(schemaObj)
78  {
79  }
80 
82  USDRI_API
83  virtual ~UsdRiPxrEnvDayLight();
84 
88  USDRI_API
89  static const TfTokenVector &
90  GetSchemaAttributeNames(bool includeInherited=true);
91 
101  USDRI_API
102  static UsdRiPxrEnvDayLight
103  Get(const UsdStagePtr &stage, const SdfPath &path);
104 
127  USDRI_API
128  static UsdRiPxrEnvDayLight
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  // DAY
153  // --------------------------------------------------------------------- //
161  USDRI_API
162  UsdAttribute GetDayAttr() const;
163 
169  USDRI_API
170  UsdAttribute CreateDayAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
171 
172 public:
173  // --------------------------------------------------------------------- //
174  // HAZINESS
175  // --------------------------------------------------------------------- //
184  USDRI_API
185  UsdAttribute GetHazinessAttr() const;
186 
192  USDRI_API
193  UsdAttribute CreateHazinessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
194 
195 public:
196  // --------------------------------------------------------------------- //
197  // HOUR
198  // --------------------------------------------------------------------- //
208  USDRI_API
209  UsdAttribute GetHourAttr() const;
210 
216  USDRI_API
217  UsdAttribute CreateHourAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
218 
219 public:
220  // --------------------------------------------------------------------- //
221  // LATITUDE
222  // --------------------------------------------------------------------- //
231  USDRI_API
232  UsdAttribute GetLatitudeAttr() const;
233 
239  USDRI_API
240  UsdAttribute CreateLatitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
241 
242 public:
243  // --------------------------------------------------------------------- //
244  // LONGITUDE
245  // --------------------------------------------------------------------- //
254  USDRI_API
255  UsdAttribute GetLongitudeAttr() const;
256 
262  USDRI_API
263  UsdAttribute CreateLongitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
264 
265 public:
266  // --------------------------------------------------------------------- //
267  // MONTH
268  // --------------------------------------------------------------------- //
277  USDRI_API
278  UsdAttribute GetMonthAttr() const;
279 
285  USDRI_API
286  UsdAttribute CreateMonthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
287 
288 public:
289  // --------------------------------------------------------------------- //
290  // SKYTINT
291  // --------------------------------------------------------------------- //
300  USDRI_API
301  UsdAttribute GetSkyTintAttr() const;
302 
308  USDRI_API
309  UsdAttribute CreateSkyTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
310 
311 public:
312  // --------------------------------------------------------------------- //
313  // SUNDIRECTION
314  // --------------------------------------------------------------------- //
324  USDRI_API
325  UsdAttribute GetSunDirectionAttr() const;
326 
332  USDRI_API
333  UsdAttribute CreateSunDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
334 
335 public:
336  // --------------------------------------------------------------------- //
337  // SUNSIZE
338  // --------------------------------------------------------------------- //
347  USDRI_API
348  UsdAttribute GetSunSizeAttr() const;
349 
355  USDRI_API
356  UsdAttribute CreateSunSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
357 
358 public:
359  // --------------------------------------------------------------------- //
360  // SUNTINT
361  // --------------------------------------------------------------------- //
371  USDRI_API
372  UsdAttribute GetSunTintAttr() const;
373 
379  USDRI_API
380  UsdAttribute CreateSunTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
381 
382 public:
383  // --------------------------------------------------------------------- //
384  // YEAR
385  // --------------------------------------------------------------------- //
392  USDRI_API
393  UsdAttribute GetYearAttr() const;
394 
400  USDRI_API
401  UsdAttribute CreateYearAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
402 
403 public:
404  // --------------------------------------------------------------------- //
405  // ZONE
406  // --------------------------------------------------------------------- //
415  USDRI_API
416  UsdAttribute GetZoneAttr() const;
417 
423  USDRI_API
424  UsdAttribute CreateZoneAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
425 
426 public:
427  // ===================================================================== //
428  // Feel free to add custom code below this line, it will be preserved by
429  // the code generator.
430  //
431  // Just remember to:
432  // - Close the class declaration with };
433  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
434  // - Close the include guard with #endif
435  // ===================================================================== //
436  // --(BEGIN CUSTOM CODE)--
437 };
438 
439 PXR_NAMESPACE_CLOSE_SCOPE
440 
441 #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:149
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:438
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