All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
portalLight.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_PORTALLIGHT_H
8#define USDLUX_GENERATED_PORTALLIGHT_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// PORTALLIGHT //
34// -------------------------------------------------------------------------- //
35
43{
44public:
48 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
49
54 explicit UsdLuxPortalLight(const UsdPrim& prim=UsdPrim())
56 {
57 }
58
62 explicit UsdLuxPortalLight(const UsdSchemaBase& schemaObj)
63 : UsdLuxBoundableLightBase(schemaObj)
64 {
65 }
66
68 USDLUX_API
70
74 USDLUX_API
75 static const TfTokenVector &
76 GetSchemaAttributeNames(bool includeInherited=true);
77
87 USDLUX_API
89 Get(const UsdStagePtr &stage, const SdfPath &path);
90
113 USDLUX_API
114 static UsdLuxPortalLight
115 Define(const UsdStagePtr &stage, const SdfPath &path);
116
117protected:
121 USDLUX_API
123
124private:
125 // needs to invoke _GetStaticTfType.
126 friend class UsdSchemaRegistry;
127 USDLUX_API
128 static const TfType &_GetStaticTfType();
129
130 static bool _IsTypedSchema();
131
132 // override SchemaBase virtuals.
133 USDLUX_API
134 const TfType &_GetTfType() const override;
135
136public:
137 // --------------------------------------------------------------------- //
138 // WIDTH
139 // --------------------------------------------------------------------- //
147 USDLUX_API
149
155 USDLUX_API
156 UsdAttribute CreateWidthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
157
158public:
159 // --------------------------------------------------------------------- //
160 // HEIGHT
161 // --------------------------------------------------------------------- //
169 USDLUX_API
171
177 USDLUX_API
178 UsdAttribute CreateHeightAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
179
180public:
181 // ===================================================================== //
182 // Feel free to add custom code below this line, it will be preserved by
183 // the code generator.
184 //
185 // Just remember to:
186 // - Close the class declaration with };
187 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
188 // - Close the include guard with #endif
189 // ===================================================================== //
190 // --(BEGIN CUSTOM CODE)--
191};
192
193PXR_NAMESPACE_CLOSE_SCOPE
194
195#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 intrinsic lights that are boundable.
A rectangular portal in the local XY plane that guides sampling of a dome light.
Definition: portalLight.h:43
USDLUX_API UsdAttribute GetWidthAttr() const
Width of the portal rectangle in the local X axis.
USDLUX_API UsdAttribute GetHeightAttr() const
Height of the portal rectangle in the local Y axis.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: portalLight.h:48
UsdLuxPortalLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxPortalLight on the prim held by schemaObj .
Definition: portalLight.h:62
USDLUX_API UsdAttribute CreateHeightAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
static USDLUX_API UsdLuxPortalLight 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 UsdAttribute CreateWidthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDLUX_API ~UsdLuxPortalLight()
Destructor.
static USDLUX_API UsdLuxPortalLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxPortalLight holding the prim adhering to this schema at path on stage.
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...
UsdLuxPortalLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxPortalLight on UsdPrim prim .
Definition: portalLight.h:54
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
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