Loading...
Searching...
No Matches
boundableLightBase.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_BOUNDABLELIGHTBASE_H
25#define USDLUX_GENERATED_BOUNDABLELIGHTBASE_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// BOUNDABLELIGHTBASE //
51// -------------------------------------------------------------------------- //
52
62{
63public:
67 static const UsdSchemaKind schemaKind = UsdSchemaKind::AbstractTyped;
68
74 : UsdGeomBoundable(prim)
75 {
76 }
77
81 explicit UsdLuxBoundableLightBase(const UsdSchemaBase& schemaObj)
82 : UsdGeomBoundable(schemaObj)
83 {
84 }
85
87 USDLUX_API
89
93 USDLUX_API
94 static const TfTokenVector &
95 GetSchemaAttributeNames(bool includeInherited=true);
96
106 USDLUX_API
108 Get(const UsdStagePtr &stage, const SdfPath &path);
109
110
111protected:
115 USDLUX_API
117
118private:
119 // needs to invoke _GetStaticTfType.
120 friend class UsdSchemaRegistry;
121 USDLUX_API
122 static const TfType &_GetStaticTfType();
123
124 static bool _IsTypedSchema();
125
126 // override SchemaBase virtuals.
127 USDLUX_API
128 const TfType &_GetTfType() const override;
129
130public:
131 // ===================================================================== //
132 // Feel free to add custom code below this line, it will be preserved by
133 // the code generator.
134 //
135 // Just remember to:
136 // - Close the class declaration with };
137 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
138 // - Close the include guard with #endif
139 // ===================================================================== //
140 // --(BEGIN CUSTOM CODE)--
141
147
149 USDLUX_API
151
153 USDLUX_API
155
157 USDLUX_API
159 VtValue const &defaultValue = VtValue(),
160 bool writeSparsely=false) const;
161
163 USDLUX_API
165
167 USDLUX_API
169 VtValue const &defaultValue = VtValue(),
170 bool writeSparsely=false) const;
171
173 USDLUX_API
175
177 USDLUX_API
179 VtValue const &defaultValue = VtValue(),
180 bool writeSparsely=false) const;
181
183 USDLUX_API
185
187 USDLUX_API
189 VtValue const &defaultValue = VtValue(),
190 bool writeSparsely=false) const;
191
193 USDLUX_API
195
197 USDLUX_API
199 VtValue const &defaultValue = VtValue(),
200 bool writeSparsely=false) const;
201
203 USDLUX_API
205
207 USDLUX_API
209 VtValue const &defaultValue = VtValue(),
210 bool writeSparsely=false) const;
211
213 USDLUX_API
215
217 USDLUX_API
219 VtValue const &defaultValue = VtValue(),
220 bool writeSparsely=false) const;
221
223 USDLUX_API
225
227 USDLUX_API
229 VtValue const &defaultValue = VtValue(),
230 bool writeSparsely=false) const;
231
233 USDLUX_API
235
237 USDLUX_API
239
241};
242
243PXR_NAMESPACE_CLOSE_SCOPE
244
245#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:290
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
Boundable introduces the ability for a prim to persistently cache a rectilinear, local-space,...
Definition: boundable.h:83
Base class for intrinsic lights that are boundable.
UsdLuxBoundableLightBase(const UsdSchemaBase &schemaObj)
Construct a UsdLuxBoundableLightBase on the prim held by schemaObj .
USDLUX_API UsdAttribute GetEnableColorTemperatureAttr() const
See UsdLuxLightAPI::GetEnableColorTemperatureAttr().
static USDLUX_API UsdLuxBoundableLightBase Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxBoundableLightBase holding the prim adhering to this schema at path on stage.
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().
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().
virtual USDLUX_API ~UsdLuxBoundableLightBase()
Destructor.
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().
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().
UsdLuxBoundableLightBase(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxBoundableLightBase on UsdPrim prim .
USDLUX_API UsdAttribute GetColorAttr() const
See UsdLuxLightAPI::GetColorAttr().
API schema that imparts the quality of being a light onto a prim.
Definition: lightAPI.h:90
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
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:164
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