Loading...
Searching...
No Matches
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"
32#include "pxr/usd/usd/prim.h"
33#include "pxr/usd/usd/stage.h"
35
36#include "pxr/base/vt/value.h"
37
38#include "pxr/base/gf/vec3d.h"
39#include "pxr/base/gf/vec3f.h"
41
42#include "pxr/base/tf/token.h"
43#include "pxr/base/tf/type.h"
44
45PXR_NAMESPACE_OPEN_SCOPE
46
47class SdfAssetPath;
48
49// -------------------------------------------------------------------------- //
50// RECTLIGHT //
51// -------------------------------------------------------------------------- //
52
62{
63public:
67 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
68
73 explicit UsdLuxRectLight(const UsdPrim& prim=UsdPrim())
75 {
76 }
77
81 explicit UsdLuxRectLight(const UsdSchemaBase& schemaObj)
82 : UsdLuxBoundableLightBase(schemaObj)
83 {
84 }
85
87 USDLUX_API
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
136protected:
140 USDLUX_API
142
143private:
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
155public:
156 // --------------------------------------------------------------------- //
157 // WIDTH
158 // --------------------------------------------------------------------- //
166 USDLUX_API
168
174 USDLUX_API
175 UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
176
177public:
178 // --------------------------------------------------------------------- //
179 // HEIGHT
180 // --------------------------------------------------------------------- //
188 USDLUX_API
190
196 USDLUX_API
197 UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
198
199public:
200 // --------------------------------------------------------------------- //
201 // TEXTUREFILE
202 // --------------------------------------------------------------------- //
210 USDLUX_API
212
218 USDLUX_API
219 UsdAttribute CreateTextureFileAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
220
221public:
222 // ===================================================================== //
223 // Feel free to add custom code below this line, it will be preserved by
224 // the code generator.
225 //
226 // Just remember to:
227 // - Close the class declaration with };
228 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
229 // - Close the include guard with #endif
230 // ===================================================================== //
231 // --(BEGIN CUSTOM CODE)--
232};
233
234PXR_NAMESPACE_CLOSE_SCOPE
235
236#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:291
TfType represents a dynamic runtime type.
Definition: type.h:65
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
Base class for intrinsic lights that are boundable.
Light emitted from one side of a rectangle.
Definition: rectLight.h:62
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 GetWidthAttr() const
Width of the rectangle, in the local X axis.
USDLUX_API UsdAttribute GetHeightAttr() const
Height of the rectangle, in the local Y axis.
virtual USDLUX_API ~UsdLuxRectLight()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: rectLight.h:67
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.
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.
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.
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 UsdSchemaBase &schemaObj)
Construct a UsdLuxRectLight on the prim held by schemaObj .
Definition: rectLight.h:81
UsdLuxRectLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxRectLight on UsdPrim prim .
Definition: rectLight.h:73
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
USDLUX_API UsdAttribute GetTextureFileAttr() const
A color texture to use on the rectangle.
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...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Singleton registry that provides access to schema type information and the prim definitions for regis...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:165
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:129
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:457