All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
nonboundableLightBase.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_NONBOUNDABLELIGHTBASE_H
8#define USDLUX_GENERATED_NONBOUNDABLELIGHTBASE_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// NONBOUNDABLELIGHTBASE //
34// -------------------------------------------------------------------------- //
35
45{
46public:
50 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
51
57 : UsdGeomXformable(prim)
58 {
59 }
60
64 explicit UsdLuxNonboundableLightBase(const UsdSchemaBase& schemaObj)
65 : UsdGeomXformable(schemaObj)
66 {
67 }
68
70 USDLUX_API
72
76 USDLUX_API
77 static const TfTokenVector &
78 GetSchemaAttributeNames(bool includeInherited=true);
79
89 USDLUX_API
91 Get(const UsdStagePtr &stage, const SdfPath &path);
92
93
94protected:
98 USDLUX_API
99 UsdSchemaKind _GetSchemaKind() const override;
100
101private:
102 // needs to invoke _GetStaticTfType.
103 friend class UsdSchemaRegistry;
104 USDLUX_API
105 static const TfType &_GetStaticTfType();
106
107 static bool _IsTypedSchema();
108
109 // override SchemaBase virtuals.
110 USDLUX_API
111 const TfType &_GetTfType() const override;
112
113public:
114 // ===================================================================== //
115 // Feel free to add custom code below this line, it will be preserved by
116 // the code generator.
117 //
118 // Just remember to:
119 // - Close the class declaration with };
120 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
121 // - Close the include guard with #endif
122 // ===================================================================== //
123 // --(BEGIN CUSTOM CODE)--
124
130
132 USDLUX_API
134
136 USDLUX_API
138
140 USDLUX_API
142 VtValue const &defaultValue = VtValue(),
143 bool writeSparsely=false) const;
144
146 USDLUX_API
148
150 USDLUX_API
152 VtValue const &defaultValue = VtValue(),
153 bool writeSparsely=false) const;
154
156 USDLUX_API
158
160 USDLUX_API
162 VtValue const &defaultValue = VtValue(),
163 bool writeSparsely=false) const;
164
166 USDLUX_API
168
170 USDLUX_API
172 VtValue const &defaultValue = VtValue(),
173 bool writeSparsely=false) const;
174
176 USDLUX_API
178
180 USDLUX_API
182 VtValue const &defaultValue = VtValue(),
183 bool writeSparsely=false) const;
184
186 USDLUX_API
188
190 USDLUX_API
192 VtValue const &defaultValue = VtValue(),
193 bool writeSparsely=false) const;
194
196 USDLUX_API
198
200 USDLUX_API
202 VtValue const &defaultValue = VtValue(),
203 bool writeSparsely=false) const;
204
206 USDLUX_API
208
210 USDLUX_API
212 VtValue const &defaultValue = VtValue(),
213 bool writeSparsely=false) const;
214
216 USDLUX_API
218
220 USDLUX_API
222
224};
225
226PXR_NAMESPACE_CLOSE_SCOPE
227
228#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 all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:236
API schema that imparts the quality of being a light onto a prim.
Definition: lightAPI.h:73
Base class for intrinsic lights that are not boundable.
USDLUX_API UsdAttribute GetEnableColorTemperatureAttr() const
See UsdLuxLightAPI::GetEnableColorTemperatureAttr().
USDLUX_API UsdAttribute CreateColorTemperatureAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateColorTemperatureAttr().
USDLUX_API UsdLuxLightAPI LightAPI() const
Contructs and returns a UsdLuxLightAPI object for this light.
USDLUX_API UsdAttribute CreateNormalizeAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateNormalizeAttr().
USDLUX_API UsdAttribute CreateSpecularAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateSpecularAttr().
virtual USDLUX_API ~UsdLuxNonboundableLightBase()
Destructor.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
USDLUX_API UsdAttribute CreateIntensityAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateIntensityAttr().
USDLUX_API UsdAttribute GetDiffuseAttr() const
See UsdLuxLightAPI::GetDiffuseAttr().
UsdLuxNonboundableLightBase(const UsdSchemaBase &schemaObj)
Construct a UsdLuxNonboundableLightBase on the prim held by schemaObj .
USDLUX_API UsdAttribute GetExposureAttr() const
See UsdLuxLightAPI::GetExposureAttr().
USDLUX_API UsdAttribute CreateEnableColorTemperatureAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateEnableColorTemperatureAttr().
USDLUX_API UsdAttribute CreateExposureAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateExposureAttr().
USDLUX_API UsdRelationship GetFiltersRel() const
See UsdLuxLightAPI::GetFiltersRel().
USDLUX_API UsdAttribute GetIntensityAttr() const
See UsdLuxLightAPI::GetIntensityAttr().
USDLUX_API UsdRelationship CreateFiltersRel() const
See UsdLuxLightAPI::CreateFiltersRel().
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...
USDLUX_API UsdAttribute GetNormalizeAttr() const
See UsdLuxLightAPI::GetNormalizeAttr().
USDLUX_API UsdAttribute CreateDiffuseAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateDiffuseAttr().
static USDLUX_API UsdLuxNonboundableLightBase Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxNonboundableLightBase holding the prim adhering to this schema at path on stage.
USDLUX_API UsdAttribute GetColorTemperatureAttr() const
See UsdLuxLightAPI::GetColorTemperatureAttr().
USDLUX_API UsdAttribute GetSpecularAttr() const
See UsdLuxLightAPI::GetSpecularAttr().
USDLUX_API UsdAttribute CreateColorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See UsdLuxLightAPI::CreateColorAttr().
UsdLuxNonboundableLightBase(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxNonboundableLightBase on UsdPrim prim .
USDLUX_API UsdAttribute GetColorAttr() const
See UsdLuxLightAPI::GetColorAttr().
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:111
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