All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
domeLight_1.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_DOMELIGHT_1_H
8#define USDLUX_GENERATED_DOMELIGHT_1_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// DOMELIGHT_1 //
34// -------------------------------------------------------------------------- //
35
84{
85public:
89 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
90
95 explicit UsdLuxDomeLight_1(const UsdPrim& prim=UsdPrim())
97 {
98 }
99
103 explicit UsdLuxDomeLight_1(const UsdSchemaBase& schemaObj)
104 : UsdLuxNonboundableLightBase(schemaObj)
105 {
106 }
107
109 USDLUX_API
111
115 USDLUX_API
116 static const TfTokenVector &
117 GetSchemaAttributeNames(bool includeInherited=true);
118
128 USDLUX_API
129 static UsdLuxDomeLight_1
130 Get(const UsdStagePtr &stage, const SdfPath &path);
131
154 USDLUX_API
155 static UsdLuxDomeLight_1
156 Define(const UsdStagePtr &stage, const SdfPath &path);
157
158protected:
162 USDLUX_API
164
165private:
166 // needs to invoke _GetStaticTfType.
167 friend class UsdSchemaRegistry;
168 USDLUX_API
169 static const TfType &_GetStaticTfType();
170
171 static bool _IsTypedSchema();
172
173 // override SchemaBase virtuals.
174 USDLUX_API
175 const TfType &_GetTfType() const override;
176
177public:
178 // --------------------------------------------------------------------- //
179 // TEXTUREFILE
180 // --------------------------------------------------------------------- //
189 USDLUX_API
191
197 USDLUX_API
198 UsdAttribute CreateTextureFileAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
199
200public:
201 // --------------------------------------------------------------------- //
202 // TEXTUREFORMAT
203 // --------------------------------------------------------------------- //
226 USDLUX_API
228
234 USDLUX_API
235 UsdAttribute CreateTextureFormatAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
236
237public:
238 // --------------------------------------------------------------------- //
239 // GUIDERADIUS
240 // --------------------------------------------------------------------- //
248 USDLUX_API
250
256 USDLUX_API
257 UsdAttribute CreateGuideRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
258
259public:
260 // --------------------------------------------------------------------- //
261 // POLEAXIS
262 // --------------------------------------------------------------------- //
280 USDLUX_API
282
288 USDLUX_API
289 UsdAttribute CreatePoleAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
290
291public:
292 // --------------------------------------------------------------------- //
293 // PORTALS
294 // --------------------------------------------------------------------- //
297 USDLUX_API
299
302 USDLUX_API
304
305public:
306 // ===================================================================== //
307 // Feel free to add custom code below this line, it will be preserved by
308 // the code generator.
309 //
310 // Just remember to:
311 // - Close the class declaration with };
312 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
313 // - Close the include guard with #endif
314 // ===================================================================== //
315 // --(BEGIN CUSTOM CODE)--
316};
317
318PXR_NAMESPACE_CLOSE_SCOPE
319
320#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
Light emitted inward from a distant external environment, such as a sky or IBL light probe.
Definition: domeLight_1.h:84
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.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: domeLight_1.h:89
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.
USDLUX_API UsdRelationship CreatePortalsRel() const
See GetPortalsRel(), and also Create vs Get Property Methods for when to use Get vs Create.
UsdLuxDomeLight_1(const UsdSchemaBase &schemaObj)
Construct a UsdLuxDomeLight_1 on the prim held by schemaObj .
Definition: domeLight_1.h:103
USDLUX_API UsdAttribute GetGuideRadiusAttr() const
The radius of guide geometry to use to visualize the dome light.
static USDLUX_API UsdLuxDomeLight_1 Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxDomeLight_1 holding the prim adhering to this schema at path on stage.
USDLUX_API UsdAttribute CreatePoleAxisAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetPoleAxisAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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 UsdLuxDomeLight_1 Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
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...
UsdLuxDomeLight_1(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxDomeLight_1 on UsdPrim prim .
Definition: domeLight_1.h:95
virtual USDLUX_API ~UsdLuxDomeLight_1()
Destructor.
USDLUX_API UsdAttribute GetPoleAxisAttr() const
A token which indicates the starting alignment of the dome light's top pole.
USDLUX_API UsdAttribute GetTextureFormatAttr() const
Specifies the parameterization of the color map file.
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: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