Loading...
Searching...
No Matches
diskLight.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_DISKLIGHT_H
25#define USDLUX_GENERATED_DISKLIGHT_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// DISKLIGHT //
51// -------------------------------------------------------------------------- //
52
59{
60public:
64 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
65
70 explicit UsdLuxDiskLight(const UsdPrim& prim=UsdPrim())
72 {
73 }
74
78 explicit UsdLuxDiskLight(const UsdSchemaBase& schemaObj)
79 : UsdLuxBoundableLightBase(schemaObj)
80 {
81 }
82
84 USDLUX_API
86
90 USDLUX_API
91 static const TfTokenVector &
92 GetSchemaAttributeNames(bool includeInherited=true);
93
103 USDLUX_API
104 static UsdLuxDiskLight
105 Get(const UsdStagePtr &stage, const SdfPath &path);
106
129 USDLUX_API
130 static UsdLuxDiskLight
131 Define(const UsdStagePtr &stage, const SdfPath &path);
132
133protected:
137 USDLUX_API
139
140private:
141 // needs to invoke _GetStaticTfType.
142 friend class UsdSchemaRegistry;
143 USDLUX_API
144 static const TfType &_GetStaticTfType();
145
146 static bool _IsTypedSchema();
147
148 // override SchemaBase virtuals.
149 USDLUX_API
150 const TfType &_GetTfType() const override;
151
152public:
153 // --------------------------------------------------------------------- //
154 // RADIUS
155 // --------------------------------------------------------------------- //
163 USDLUX_API
165
171 USDLUX_API
172 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
173
174public:
175 // ===================================================================== //
176 // Feel free to add custom code below this line, it will be preserved by
177 // the code generator.
178 //
179 // Just remember to:
180 // - Close the class declaration with };
181 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
182 // - Close the include guard with #endif
183 // ===================================================================== //
184 // --(BEGIN CUSTOM CODE)--
185};
186
187PXR_NAMESPACE_CLOSE_SCOPE
188
189#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:291
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 from one side of a circular disk.
Definition: diskLight.h:59
static USDLUX_API UsdLuxDiskLight Define(const UsdStagePtr &stage, const SdfPath &path)
Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefin...
UsdLuxDiskLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxDiskLight on the prim held by schemaObj .
Definition: diskLight.h:78
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: diskLight.h:64
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.
static USDLUX_API UsdLuxDiskLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxDiskLight holding the prim adhering to this schema at path on stage.
USDLUX_API UsdAttribute GetRadiusAttr() const
Radius of the disk.
UsdLuxDiskLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxDiskLight on UsdPrim prim .
Definition: diskLight.h:70
virtual USDLUX_API ~UsdLuxDiskLight()
Destructor.
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:165
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