All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
sphereLight.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_SPHERELIGHT_H
8#define USDLUX_GENERATED_SPHERELIGHT_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// SPHERELIGHT //
34// -------------------------------------------------------------------------- //
35
41{
42public:
46 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
47
52 explicit UsdLuxSphereLight(const UsdPrim& prim=UsdPrim())
54 {
55 }
56
60 explicit UsdLuxSphereLight(const UsdSchemaBase& schemaObj)
61 : UsdLuxBoundableLightBase(schemaObj)
62 {
63 }
64
66 USDLUX_API
68
72 USDLUX_API
73 static const TfTokenVector &
74 GetSchemaAttributeNames(bool includeInherited=true);
75
85 USDLUX_API
87 Get(const UsdStagePtr &stage, const SdfPath &path);
88
111 USDLUX_API
112 static UsdLuxSphereLight
113 Define(const UsdStagePtr &stage, const SdfPath &path);
114
115protected:
119 USDLUX_API
121
122private:
123 // needs to invoke _GetStaticTfType.
124 friend class UsdSchemaRegistry;
125 USDLUX_API
126 static const TfType &_GetStaticTfType();
127
128 static bool _IsTypedSchema();
129
130 // override SchemaBase virtuals.
131 USDLUX_API
132 const TfType &_GetTfType() const override;
133
134public:
135 // --------------------------------------------------------------------- //
136 // RADIUS
137 // --------------------------------------------------------------------- //
145 USDLUX_API
147
153 USDLUX_API
154 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
155
156public:
157 // --------------------------------------------------------------------- //
158 // TREATASPOINT
159 // --------------------------------------------------------------------- //
170 USDLUX_API
172
178 USDLUX_API
179 UsdAttribute CreateTreatAsPointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
180
181public:
182 // ===================================================================== //
183 // Feel free to add custom code below this line, it will be preserved by
184 // the code generator.
185 //
186 // Just remember to:
187 // - Close the class declaration with };
188 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
189 // - Close the include guard with #endif
190 // ===================================================================== //
191 // --(BEGIN CUSTOM CODE)--
192};
193
194PXR_NAMESPACE_CLOSE_SCOPE
195
196#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 sphere.
Definition: sphereLight.h:41
USDLUX_API UsdAttribute CreateTreatAsPointAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTreatAsPointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: sphereLight.h:46
UsdLuxSphereLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxSphereLight on the prim held by schemaObj .
Definition: sphereLight.h:60
virtual USDLUX_API ~UsdLuxSphereLight()
Destructor.
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 GetTreatAsPointAttr() const
A hint that this light can be treated as a 'point' light (effectively, a zero-radius sphere) by rende...
USDLUX_API UsdAttribute GetRadiusAttr() const
Radius of the sphere.
static USDLUX_API UsdLuxSphereLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxSphereLight holding the prim adhering to this schema at path on stage.
UsdLuxSphereLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxSphereLight on UsdPrim prim .
Definition: sphereLight.h:52
static USDLUX_API UsdLuxSphereLight 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 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...
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