All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
cylinderLight.h
Go to the documentation of this file.
1//
2// Copyright 2016 Pixar
3//
4// Licensed under the terms set forth in the LICENSE.txt file available at
5// https://openusd.org/license.
6//
7#ifndef USDLUX_GENERATED_CYLINDERLIGHT_H
8#define USDLUX_GENERATED_CYLINDERLIGHT_H
9
11
12#include "pxr/pxr.h"
13#include "pxr/usd/usdLux/api.h"
15#include "pxr/usd/usd/prim.h"
16#include "pxr/usd/usd/stage.h"
18
19#include "pxr/base/vt/value.h"
20
21#include "pxr/base/gf/vec3d.h"
22#include "pxr/base/gf/vec3f.h"
24
25#include "pxr/base/tf/token.h"
26#include "pxr/base/tf/type.h"
27
28PXR_NAMESPACE_OPEN_SCOPE
29
30class SdfAssetPath;
31
32// -------------------------------------------------------------------------- //
33// CYLINDERLIGHT //
34// -------------------------------------------------------------------------- //
35
44{
45public:
49 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
50
55 explicit UsdLuxCylinderLight(const UsdPrim& prim=UsdPrim())
57 {
58 }
59
63 explicit UsdLuxCylinderLight(const UsdSchemaBase& schemaObj)
64 : UsdLuxBoundableLightBase(schemaObj)
65 {
66 }
67
69 USDLUX_API
71
75 USDLUX_API
76 static const TfTokenVector &
77 GetSchemaAttributeNames(bool includeInherited=true);
78
88 USDLUX_API
90 Get(const UsdStagePtr &stage, const SdfPath &path);
91
114 USDLUX_API
116 Define(const UsdStagePtr &stage, const SdfPath &path);
117
118protected:
122 USDLUX_API
124
125private:
126 // needs to invoke _GetStaticTfType.
127 friend class UsdSchemaRegistry;
128 USDLUX_API
129 static const TfType &_GetStaticTfType();
130
131 static bool _IsTypedSchema();
132
133 // override SchemaBase virtuals.
134 USDLUX_API
135 const TfType &_GetTfType() const override;
136
137public:
138 // --------------------------------------------------------------------- //
139 // LENGTH
140 // --------------------------------------------------------------------- //
148 USDLUX_API
150
156 USDLUX_API
157 UsdAttribute CreateLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
158
159public:
160 // --------------------------------------------------------------------- //
161 // RADIUS
162 // --------------------------------------------------------------------- //
170 USDLUX_API
172
178 USDLUX_API
179 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180
181public:
182 // --------------------------------------------------------------------- //
183 // TREATASLINE
184 // --------------------------------------------------------------------- //
195 USDLUX_API
197
203 USDLUX_API
204 UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
205
206public:
207 // ===================================================================== //
208 // Feel free to add custom code below this line, it will be preserved by
209 // the code generator.
210 //
211 // Just remember to:
212 // - Close the class declaration with };
213 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
214 // - Close the include guard with #endif
215 // ===================================================================== //
216 // --(BEGIN CUSTOM CODE)--
217};
218
219PXR_NAMESPACE_CLOSE_SCOPE
220
221#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:274
TfType represents a dynamic runtime type.
Definition: type.h:48
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:160
Base class for intrinsic lights that are boundable.
Light emitted outward from a cylinder.
Definition: cylinderLight.h:44
UsdLuxCylinderLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxCylinderLight on the prim held by schemaObj .
Definition: cylinderLight.h:63
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: cylinderLight.h:49
virtual USDLUX_API ~UsdLuxCylinderLight()
Destructor.
USDLUX_API UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTreatAsLineAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetRadiusAttr() const
Radius of the cylinder.
USDLUX_API UsdAttribute CreateLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetTreatAsLineAttr() const
A hint that this light can be treated as a 'line' light (effectively, a zero-radius cylinder) by rend...
static USDLUX_API UsdLuxCylinderLight 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 GetLengthAttr() const
Length of the cylinder, in the local X axis.
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
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...
UsdLuxCylinderLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxCylinderLight on UsdPrim prim .
Definition: cylinderLight.h:55
static USDLUX_API UsdLuxCylinderLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxCylinderLight holding the prim adhering to this schema at path on stage.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
The base class for all schema types in Usd.
Definition: schemaBase.h:39
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:147
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:112
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:440