All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
distantLight.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 USDLUX_GENERATED_DISTANTLIGHT_H
25 #define USDLUX_GENERATED_DISTANTLIGHT_H
26 
28 
29 #include "pxr/pxr.h"
30 #include "pxr/usd/usdLux/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/usdLux/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 // DISTANTLIGHT //
51 // -------------------------------------------------------------------------- //
52 
59 {
60 public:
65 
70  explicit UsdLuxDistantLight(const UsdPrim& prim=UsdPrim())
71  : UsdLuxLight(prim)
72  {
73  }
74 
78  explicit UsdLuxDistantLight(const UsdSchemaBase& schemaObj)
79  : UsdLuxLight(schemaObj)
80  {
81  }
82 
84  USDLUX_API
85  virtual ~UsdLuxDistantLight();
86 
90  USDLUX_API
91  static const TfTokenVector &
92  GetSchemaAttributeNames(bool includeInherited=true);
93 
103  USDLUX_API
104  static UsdLuxDistantLight
105  Get(const UsdStagePtr &stage, const SdfPath &path);
106 
129  USDLUX_API
130  static UsdLuxDistantLight
131  Define(const UsdStagePtr &stage, const SdfPath &path);
132 
133 protected:
137  USDLUX_API
138  UsdSchemaType _GetSchemaType() const override;
139 
140 private:
141  // needs to invoke _GetStaticTfType.
142  friend class UsdSchemaRegistry;
143  USDLUX_API
144  static const TfType &_GetStaticTfType();
145 
146  static bool _IsTypedSchema();
147 
148  // override SchemaBase virtuals.
149  USDLUX_API
150  const TfType &_GetTfType() const override;
151 
152 public:
153  // --------------------------------------------------------------------- //
154  // ANGLE
155  // --------------------------------------------------------------------- //
165  USDLUX_API
166  UsdAttribute GetAngleAttr() const;
167 
173  USDLUX_API
174  UsdAttribute CreateAngleAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
175 
176 public:
177  // --------------------------------------------------------------------- //
178  // INTENSITY
179  // --------------------------------------------------------------------- //
187  USDLUX_API
189 
195  USDLUX_API
196  UsdAttribute CreateIntensityAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197 
198 public:
199  // ===================================================================== //
200  // Feel free to add custom code below this line, it will be preserved by
201  // the code generator.
202  //
203  // Just remember to:
204  // - Close the class declaration with };
205  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
206  // - Close the include guard with #endif
207  // ===================================================================== //
208  // --(BEGIN CUSTOM CODE)--
209 };
210 
211 PXR_NAMESPACE_CLOSE_SCOPE
212 
213 #endif
UsdLuxDistantLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxDistantLight on UsdPrim prim .
Definition: distantLight.h:70
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: distantLight.h:64
Light emitted from a distant source along the -Z axis.
Definition: distantLight.h:58
static USDLUX_API UsdLuxDistantLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxDistantLight holding the prim adhering to this schema at path on stage.
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 UsdAttribute CreateAngleAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetAngleAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
UsdLuxDistantLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxDistantLight on the prim held by schemaObj .
Definition: distantLight.h:78
static USDLUX_API UsdLuxDistantLight Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
USDLUX_API UsdAttribute GetIntensityAttr() const
Scales the emission of the light linearly.
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
USDLUX_API UsdAttribute GetAngleAttr() const
Angular size of the light in degrees.
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
virtual USDLUX_API ~UsdLuxDistantLight()
Destructor.
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
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...
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...
USDLUX_API UsdAttribute CreateIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetIntensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
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