Loading...
Searching...
No Matches
sphereLight.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_SPHERELIGHT_H
25#define USDLUX_GENERATED_SPHERELIGHT_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// SPHERELIGHT //
51// -------------------------------------------------------------------------- //
52
58{
59public:
63 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
64
69 explicit UsdLuxSphereLight(const UsdPrim& prim=UsdPrim())
71 {
72 }
73
77 explicit UsdLuxSphereLight(const UsdSchemaBase& schemaObj)
78 : UsdLuxBoundableLightBase(schemaObj)
79 {
80 }
81
83 USDLUX_API
85
89 USDLUX_API
90 static const TfTokenVector &
91 GetSchemaAttributeNames(bool includeInherited=true);
92
102 USDLUX_API
103 static UsdLuxSphereLight
104 Get(const UsdStagePtr &stage, const SdfPath &path);
105
128 USDLUX_API
129 static UsdLuxSphereLight
130 Define(const UsdStagePtr &stage, const SdfPath &path);
131
132protected:
136 USDLUX_API
138
139private:
140 // needs to invoke _GetStaticTfType.
141 friend class UsdSchemaRegistry;
142 USDLUX_API
143 static const TfType &_GetStaticTfType();
144
145 static bool _IsTypedSchema();
146
147 // override SchemaBase virtuals.
148 USDLUX_API
149 const TfType &_GetTfType() const override;
150
151public:
152 // --------------------------------------------------------------------- //
153 // RADIUS
154 // --------------------------------------------------------------------- //
162 USDLUX_API
164
170 USDLUX_API
171 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
172
173public:
174 // --------------------------------------------------------------------- //
175 // TREATASPOINT
176 // --------------------------------------------------------------------- //
187 USDLUX_API
189
195 USDLUX_API
196 UsdAttribute CreateTreatAsPointAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197
198public:
199 // ===================================================================== //
200 // Feel free to add custom code below this line, it will be preserved by
201 // the code generator.
202 //
203 // Just remember to:
204 // - Close the class declaration with };
205 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
206 // - Close the include guard with #endif
207 // ===================================================================== //
208 // --(BEGIN CUSTOM CODE)--
209};
210
211PXR_NAMESPACE_CLOSE_SCOPE
212
213#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
Base class for intrinsic lights that are boundable.
Light emitted outward from a sphere.
Definition: sphereLight.h:58
USDLUX_API UsdAttribute CreateTreatAsPointAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTreatAsPointAttr(), 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: sphereLight.h:63
UsdLuxSphereLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxSphereLight on the prim held by schemaObj .
Definition: sphereLight.h:77
virtual USDLUX_API ~UsdLuxSphereLight()
Destructor.
USDLUX_API UsdAttribute CreateRadiusAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRadiusAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetTreatAsPointAttr() const
A hint that this light can be treated as a 'point' light (effectively, a zero-radius sphere) by rende...
USDLUX_API UsdAttribute GetRadiusAttr() const
Radius of the sphere.
static USDLUX_API UsdLuxSphereLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxSphereLight holding the prim adhering to this schema at path on stage.
UsdLuxSphereLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxSphereLight on UsdPrim prim .
Definition: sphereLight.h:69
static USDLUX_API UsdLuxSphereLight 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 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...
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
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