All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
rectLight.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_RECTLIGHT_H
25 #define USDLUX_GENERATED_RECTLIGHT_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 // RECTLIGHT //
51 // -------------------------------------------------------------------------- //
52 
62 {
63 public:
68 
73  explicit UsdLuxRectLight(const UsdPrim& prim=UsdPrim())
74  : UsdLuxLight(prim)
75  {
76  }
77 
81  explicit UsdLuxRectLight(const UsdSchemaBase& schemaObj)
82  : UsdLuxLight(schemaObj)
83  {
84  }
85 
87  USDLUX_API
88  virtual ~UsdLuxRectLight();
89 
93  USDLUX_API
94  static const TfTokenVector &
95  GetSchemaAttributeNames(bool includeInherited=true);
96 
106  USDLUX_API
107  static UsdLuxRectLight
108  Get(const UsdStagePtr &stage, const SdfPath &path);
109 
132  USDLUX_API
133  static UsdLuxRectLight
134  Define(const UsdStagePtr &stage, const SdfPath &path);
135 
136 protected:
140  USDLUX_API
141  UsdSchemaType _GetSchemaType() const override;
142 
143 private:
144  // needs to invoke _GetStaticTfType.
145  friend class UsdSchemaRegistry;
146  USDLUX_API
147  static const TfType &_GetStaticTfType();
148 
149  static bool _IsTypedSchema();
150 
151  // override SchemaBase virtuals.
152  USDLUX_API
153  const TfType &_GetTfType() const override;
154 
155 public:
156  // --------------------------------------------------------------------- //
157  // WIDTH
158  // --------------------------------------------------------------------- //
165  USDLUX_API
166  UsdAttribute GetWidthAttr() const;
167 
173  USDLUX_API
174  UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
175 
176 public:
177  // --------------------------------------------------------------------- //
178  // HEIGHT
179  // --------------------------------------------------------------------- //
186  USDLUX_API
187  UsdAttribute GetHeightAttr() const;
188 
194  USDLUX_API
195  UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
196 
197 public:
198  // --------------------------------------------------------------------- //
199  // TEXTUREFILE
200  // --------------------------------------------------------------------- //
207  USDLUX_API
209 
215  USDLUX_API
216  UsdAttribute CreateTextureFileAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
217 
218 public:
219  // ===================================================================== //
220  // Feel free to add custom code below this line, it will be preserved by
221  // the code generator.
222  //
223  // Just remember to:
224  // - Close the class declaration with };
225  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
226  // - Close the include guard with #endif
227  // ===================================================================== //
228  // --(BEGIN CUSTOM CODE)--
229 };
230 
231 PXR_NAMESPACE_CLOSE_SCOPE
232 
233 #endif
USDLUX_API UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
UsdLuxRectLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxRectLight on UsdPrim prim .
Definition: rectLight.h:73
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...
USDLUX_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDLUX_API UsdAttribute GetTextureFileAttr() const
A color texture to use on the rectangle.
static USDLUX_API UsdLuxRectLight 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 CreateTextureFileAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTextureFileAttr(), 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.
UsdLuxRectLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxRectLight on the prim held by schemaObj .
Definition: rectLight.h:81
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
virtual USDLUX_API ~UsdLuxRectLight()
Destructor.
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
Light emitted from one side of a rectangle.
Definition: rectLight.h:61
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
USDLUX_API UsdAttribute GetHeightAttr() const
Height of the rectangle, in the local Y axis.
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 const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: rectLight.h:67
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDLUX_API UsdAttribute GetWidthAttr() const
Width of the rectangle, in the local X axis.
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
static USDLUX_API UsdLuxRectLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxRectLight holding the prim adhering to this schema at path on stage.