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 
58 {
59 public:
64 
69  explicit UsdRiPxrEnvDayLight(const UsdPrim& prim=UsdPrim())
70  : UsdLuxLight(prim)
71  {
72  }
73 
77  explicit UsdRiPxrEnvDayLight(const UsdSchemaBase& schemaObj)
78  : UsdLuxLight(schemaObj)
79  {
80  }
81 
83  USDRI_API
84  virtual ~UsdRiPxrEnvDayLight();
85 
89  USDRI_API
90  static const TfTokenVector &
91  GetSchemaAttributeNames(bool includeInherited=true);
92 
102  USDRI_API
103  static UsdRiPxrEnvDayLight
104  Get(const UsdStagePtr &stage, const SdfPath &path);
105 
128  USDRI_API
129  static UsdRiPxrEnvDayLight
130  Define(const UsdStagePtr &stage, const SdfPath &path);
131 
132 protected:
136  USDRI_API
137  UsdSchemaType _GetSchemaType() 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  // DAY
154  // --------------------------------------------------------------------- //
163  USDRI_API
164  UsdAttribute GetDayAttr() const;
165 
171  USDRI_API
172  UsdAttribute CreateDayAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
173 
174 public:
175  // --------------------------------------------------------------------- //
176  // HAZINESS
177  // --------------------------------------------------------------------- //
187  USDRI_API
189 
195  USDRI_API
196  UsdAttribute CreateHazinessAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197 
198 public:
199  // --------------------------------------------------------------------- //
200  // HOUR
201  // --------------------------------------------------------------------- //
212  USDRI_API
213  UsdAttribute GetHourAttr() const;
214 
220  USDRI_API
221  UsdAttribute CreateHourAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
222 
223 public:
224  // --------------------------------------------------------------------- //
225  // LATITUDE
226  // --------------------------------------------------------------------- //
236  USDRI_API
238 
244  USDRI_API
245  UsdAttribute CreateLatitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
246 
247 public:
248  // --------------------------------------------------------------------- //
249  // LONGITUDE
250  // --------------------------------------------------------------------- //
260  USDRI_API
262 
268  USDRI_API
269  UsdAttribute CreateLongitudeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
270 
271 public:
272  // --------------------------------------------------------------------- //
273  // MONTH
274  // --------------------------------------------------------------------- //
284  USDRI_API
285  UsdAttribute GetMonthAttr() const;
286 
292  USDRI_API
293  UsdAttribute CreateMonthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
294 
295 public:
296  // --------------------------------------------------------------------- //
297  // SKYTINT
298  // --------------------------------------------------------------------- //
308  USDRI_API
310 
316  USDRI_API
317  UsdAttribute CreateSkyTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
318 
319 public:
320  // --------------------------------------------------------------------- //
321  // SUNDIRECTION
322  // --------------------------------------------------------------------- //
333  USDRI_API
335 
341  USDRI_API
342  UsdAttribute CreateSunDirectionAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
343 
344 public:
345  // --------------------------------------------------------------------- //
346  // SUNSIZE
347  // --------------------------------------------------------------------- //
357  USDRI_API
359 
365  USDRI_API
366  UsdAttribute CreateSunSizeAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
367 
368 public:
369  // --------------------------------------------------------------------- //
370  // SUNTINT
371  // --------------------------------------------------------------------- //
382  USDRI_API
384 
390  USDRI_API
391  UsdAttribute CreateSunTintAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
392 
393 public:
394  // --------------------------------------------------------------------- //
395  // YEAR
396  // --------------------------------------------------------------------- //
404  USDRI_API
405  UsdAttribute GetYearAttr() const;
406 
412  USDRI_API
413  UsdAttribute CreateYearAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
414 
415 public:
416  // --------------------------------------------------------------------- //
417  // ZONE
418  // --------------------------------------------------------------------- //
428  USDRI_API
429  UsdAttribute GetZoneAttr() const;
430 
436  USDRI_API
437  UsdAttribute CreateZoneAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
438 
439 public:
440  // ===================================================================== //
441  // Feel free to add custom code below this line, it will be preserved by
442  // the code generator.
443  //
444  // Just remember to:
445  // - Close the class declaration with };
446  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
447  // - Close the include guard with #endif
448  // ===================================================================== //
449  // --(BEGIN CUSTOM CODE)--
450 };
451 
452 PXR_NAMESPACE_CLOSE_SCOPE
453 
454 #endif
static USDRI_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...
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
USDRI_API UsdAttribute GetMonthAttr() const
month: Month of the year, 1 through 12.
USDRI_API UsdAttribute CreateHourAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHourAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetDayAttr() const
day: Day of the month, 1 through 31.
static USDRI_API UsdRiPxrEnvDayLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiPxrEnvDayLight holding the prim adhering to this schema at path on stage.
USDRI_API UsdAttribute GetLatitudeAttr() const
latitude: Latitude in degrees.
USDRI_API UsdAttribute GetZoneAttr() const
zone: Standard time zone offset from GMT/UTC in hours.
USDRI_API UsdAttribute GetSunDirectionAttr() const
sunDirection: The apparent direction towards the center of the sun.
USDRI_API UsdAttribute CreateLatitudeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLatitudeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetHourAttr() const
hour: Hours since midnight, local standard time.
USDRI_API UsdAttribute CreateZoneAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetZoneAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute GetYearAttr() const
year: Four-digit year.
USDRI_API UsdAttribute GetLongitudeAttr() const
longitude: Longitude in degrees.
USDRI_API UsdAttribute CreateYearAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetYearAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
Represents a concrete typed schema.
USDRI_API UsdAttribute CreateSunTintAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSunTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
virtual USDRI_API ~UsdRiPxrEnvDayLight()
Destructor.
USDRI_API UsdAttribute CreateLongitudeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLongitudeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateHazinessAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHazinessAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
static USDRI_API UsdRiPxrEnvDayLight Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDRI_API UsdAttribute CreateSunSizeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSunSizeAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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:132
USDRI_API UsdAttribute CreateDayAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetDayAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
UsdRiPxrEnvDayLight(const UsdPrim &prim=UsdPrim())
Construct a UsdRiPxrEnvDayLight on UsdPrim prim .
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:288
USDRI_API UsdAttribute CreateSkyTintAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSkyTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
Base class for all lights.
Definition: light.h:77
USDRI_API UsdAttribute CreateSunDirectionAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetSunDirectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
USDRI_API UsdAttribute CreateMonthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetMonthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDRI_API UsdAttribute GetSunSizeAttr() const
sunSize: Scale the apparent size of the sun in the sky.
USDRI_API UsdAttribute GetSunTintAttr() const
sunTint: Tweak the sun&#39;s contribution and color.
The base class for all schema types in Usd.
Definition: schemaBase.h:56
UsdRiPxrEnvDayLight(const UsdSchemaBase &schemaObj)
Construct a UsdRiPxrEnvDayLight on the prim held by schemaObj .
USDRI_API UsdAttribute GetHazinessAttr() const
haziness: The turbidity of the sky.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:168
USDRI_API UsdAttribute GetSkyTintAttr() const
skyTint: Tweak the sky&#39;s contribution and color.