Loading...
Searching...
No Matches
domeLight_1.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_1_H
25#define USDLUX_GENERATED_DOMELIGHT_1_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_1 //
51// -------------------------------------------------------------------------- //
52
101{
102public:
106 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
107
112 explicit UsdLuxDomeLight_1(const UsdPrim& prim=UsdPrim())
114 {
115 }
116
120 explicit UsdLuxDomeLight_1(const UsdSchemaBase& schemaObj)
121 : UsdLuxNonboundableLightBase(schemaObj)
122 {
123 }
124
126 USDLUX_API
128
132 USDLUX_API
133 static const TfTokenVector &
134 GetSchemaAttributeNames(bool includeInherited=true);
135
145 USDLUX_API
146 static UsdLuxDomeLight_1
147 Get(const UsdStagePtr &stage, const SdfPath &path);
148
171 USDLUX_API
172 static UsdLuxDomeLight_1
173 Define(const UsdStagePtr &stage, const SdfPath &path);
174
175protected:
179 USDLUX_API
181
182private:
183 // needs to invoke _GetStaticTfType.
184 friend class UsdSchemaRegistry;
185 USDLUX_API
186 static const TfType &_GetStaticTfType();
187
188 static bool _IsTypedSchema();
189
190 // override SchemaBase virtuals.
191 USDLUX_API
192 const TfType &_GetTfType() const override;
193
194public:
195 // --------------------------------------------------------------------- //
196 // TEXTUREFILE
197 // --------------------------------------------------------------------- //
206 USDLUX_API
208
214 USDLUX_API
215 UsdAttribute CreateTextureFileAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
216
217public:
218 // --------------------------------------------------------------------- //
219 // TEXTUREFORMAT
220 // --------------------------------------------------------------------- //
242 USDLUX_API
244
250 USDLUX_API
251 UsdAttribute CreateTextureFormatAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
252
253public:
254 // --------------------------------------------------------------------- //
255 // GUIDERADIUS
256 // --------------------------------------------------------------------- //
264 USDLUX_API
266
272 USDLUX_API
273 UsdAttribute CreateGuideRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
274
275public:
276 // --------------------------------------------------------------------- //
277 // POLEAXIS
278 // --------------------------------------------------------------------- //
295 USDLUX_API
297
303 USDLUX_API
304 UsdAttribute CreatePoleAxisAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
305
306public:
307 // --------------------------------------------------------------------- //
308 // PORTALS
309 // --------------------------------------------------------------------- //
312 USDLUX_API
314
317 USDLUX_API
319
320public:
321 // ===================================================================== //
322 // Feel free to add custom code below this line, it will be preserved by
323 // the code generator.
324 //
325 // Just remember to:
326 // - Close the class declaration with };
327 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
328 // - Close the include guard with #endif
329 // ===================================================================== //
330 // --(BEGIN CUSTOM CODE)--
331};
332
333PXR_NAMESPACE_CLOSE_SCOPE
334
335#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_1.h:101
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:106
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:120
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:112
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: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