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  // --------------------------------------------------------------------- //
162  USDRI_API
163  UsdAttribute GetDayAttr() const;
164 
170  USDRI_API
171  UsdAttribute CreateDayAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
172 
173 public:
174  // --------------------------------------------------------------------- //
175  // HAZINESS
176  // --------------------------------------------------------------------- //
186  USDRI_API
187  UsdAttribute GetHazinessAttr() const;
188 
194  USDRI_API
195  UsdAttribute CreateHazinessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // --------------------------------------------------------------------- //
199  // HOUR
200  // --------------------------------------------------------------------- //
211  USDRI_API
212  UsdAttribute GetHourAttr() const;
213 
219  USDRI_API
220  UsdAttribute CreateHourAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
221 
222 public:
223  // --------------------------------------------------------------------- //
224  // LATITUDE
225  // --------------------------------------------------------------------- //
235  USDRI_API
236  UsdAttribute GetLatitudeAttr() const;
237 
243  USDRI_API
244  UsdAttribute CreateLatitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
245 
246 public:
247  // --------------------------------------------------------------------- //
248  // LONGITUDE
249  // --------------------------------------------------------------------- //
259  USDRI_API
260  UsdAttribute GetLongitudeAttr() const;
261 
267  USDRI_API
268  UsdAttribute CreateLongitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
269 
270 public:
271  // --------------------------------------------------------------------- //
272  // MONTH
273  // --------------------------------------------------------------------- //
283  USDRI_API
284  UsdAttribute GetMonthAttr() const;
285 
291  USDRI_API
292  UsdAttribute CreateMonthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
293 
294 public:
295  // --------------------------------------------------------------------- //
296  // SKYTINT
297  // --------------------------------------------------------------------- //
307  USDRI_API
308  UsdAttribute GetSkyTintAttr() const;
309 
315  USDRI_API
316  UsdAttribute CreateSkyTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
317 
318 public:
319  // --------------------------------------------------------------------- //
320  // SUNDIRECTION
321  // --------------------------------------------------------------------- //
332  USDRI_API
333  UsdAttribute GetSunDirectionAttr() const;
334 
340  USDRI_API
341  UsdAttribute CreateSunDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
342 
343 public:
344  // --------------------------------------------------------------------- //
345  // SUNSIZE
346  // --------------------------------------------------------------------- //
356  USDRI_API
357  UsdAttribute GetSunSizeAttr() const;
358 
364  USDRI_API
365  UsdAttribute CreateSunSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
366 
367 public:
368  // --------------------------------------------------------------------- //
369  // SUNTINT
370  // --------------------------------------------------------------------- //
381  USDRI_API
382  UsdAttribute GetSunTintAttr() const;
383 
389  USDRI_API
390  UsdAttribute CreateSunTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
391 
392 public:
393  // --------------------------------------------------------------------- //
394  // YEAR
395  // --------------------------------------------------------------------- //
403  USDRI_API
404  UsdAttribute GetYearAttr() const;
405 
411  USDRI_API
412  UsdAttribute CreateYearAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
413 
414 public:
415  // --------------------------------------------------------------------- //
416  // ZONE
417  // --------------------------------------------------------------------- //
427  USDRI_API
428  UsdAttribute GetZoneAttr() const;
429 
435  USDRI_API
436  UsdAttribute CreateZoneAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
437 
438 public:
439  // ===================================================================== //
440  // Feel free to add custom code below this line, it will be preserved by
441  // the code generator.
442  //
443  // Just remember to:
444  // - Close the class declaration with };
445  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
446  // - Close the include guard with #endif
447  // ===================================================================== //
448  // --(BEGIN CUSTOM CODE)--
449 };
450 
451 PXR_NAMESPACE_CLOSE_SCOPE
452 
453 #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