Loading...
Searching...
No Matches
domeLight.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_DOMELIGHT_H
25#define USDLUX_GENERATED_DOMELIGHT_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// DOMELIGHT //
51// -------------------------------------------------------------------------- //
52
89{
90public:
94 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
95
100 explicit UsdLuxDomeLight(const UsdPrim& prim=UsdPrim())
102 {
103 }
104
108 explicit UsdLuxDomeLight(const UsdSchemaBase& schemaObj)
109 : UsdLuxNonboundableLightBase(schemaObj)
110 {
111 }
112
114 USDLUX_API
116
120 USDLUX_API
121 static const TfTokenVector &
122 GetSchemaAttributeNames(bool includeInherited=true);
123
133 USDLUX_API
134 static UsdLuxDomeLight
135 Get(const UsdStagePtr &stage, const SdfPath &path);
136
159 USDLUX_API
160 static UsdLuxDomeLight
161 Define(const UsdStagePtr &stage, const SdfPath &path);
162
163protected:
167 USDLUX_API
169
170private:
171 // needs to invoke _GetStaticTfType.
172 friend class UsdSchemaRegistry;
173 USDLUX_API
174 static const TfType &_GetStaticTfType();
175
176 static bool _IsTypedSchema();
177
178 // override SchemaBase virtuals.
179 USDLUX_API
180 const TfType &_GetTfType() const override;
181
182public:
183 // --------------------------------------------------------------------- //
184 // TEXTUREFILE
185 // --------------------------------------------------------------------- //
194 USDLUX_API
196
202 USDLUX_API
203 UsdAttribute CreateTextureFileAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
204
205public:
206 // --------------------------------------------------------------------- //
207 // TEXTUREFORMAT
208 // --------------------------------------------------------------------- //
230 USDLUX_API
232
238 USDLUX_API
239 UsdAttribute CreateTextureFormatAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
240
241public:
242 // --------------------------------------------------------------------- //
243 // GUIDERADIUS
244 // --------------------------------------------------------------------- //
252 USDLUX_API
254
260 USDLUX_API
261 UsdAttribute CreateGuideRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
262
263public:
264 // --------------------------------------------------------------------- //
265 // PORTALS
266 // --------------------------------------------------------------------- //
269 USDLUX_API
271
274 USDLUX_API
276
277public:
278 // ===================================================================== //
279 // Feel free to add custom code below this line, it will be preserved by
280 // the code generator.
281 //
282 // Just remember to:
283 // - Close the class declaration with };
284 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
285 // - Close the include guard with #endif
286 // ===================================================================== //
287 // --(BEGIN CUSTOM CODE)--
288
298 USDLUX_API
300};
301
302PXR_NAMESPACE_CLOSE_SCOPE
303
304#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
Light emitted inward from a distant external environment, such as a sky or IBL light probe.
Definition: domeLight.h:89
USDLUX_API UsdAttribute CreateTextureFormatAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTextureFormatAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute CreateGuideRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetGuideRadiusAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API void OrientToStageUpAxis() const
Adds a transformation op, if neeeded, to orient the dome to align with the stage's up axis.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: domeLight.h:94
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 UsdRelationship GetPortalsRel() const
Optional portals to guide light sampling.
static USDLUX_API UsdLuxDomeLight 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 UsdRelationship CreatePortalsRel() const
See GetPortalsRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetGuideRadiusAttr() const
The radius of guide geometry to use to visualize the dome light.
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 dome, such as an HDR (high dynamic range) texture intended for IBL (ima...
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...
virtual USDLUX_API ~UsdLuxDomeLight()
Destructor.
UsdLuxDomeLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxDomeLight on the prim held by schemaObj .
Definition: domeLight.h:108
UsdLuxDomeLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxDomeLight on UsdPrim prim .
Definition: domeLight.h:100
USDLUX_API UsdAttribute GetTextureFormatAttr() const
Specifies the parameterization of the color map file.
static USDLUX_API UsdLuxDomeLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxDomeLight holding the prim adhering to this schema at path on stage.
Base class for intrinsic lights that are not boundable.
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