All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
diskLight.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_DISKLIGHT_H
8#define USDLUX_GENERATED_DISKLIGHT_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// DISKLIGHT //
34// -------------------------------------------------------------------------- //
35
42{
43public:
47 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
48
53 explicit UsdLuxDiskLight(const UsdPrim& prim=UsdPrim())
55 {
56 }
57
61 explicit UsdLuxDiskLight(const UsdSchemaBase& schemaObj)
62 : UsdLuxBoundableLightBase(schemaObj)
63 {
64 }
65
67 USDLUX_API
69
73 USDLUX_API
74 static const TfTokenVector &
75 GetSchemaAttributeNames(bool includeInherited=true);
76
86 USDLUX_API
87 static UsdLuxDiskLight
88 Get(const UsdStagePtr &stage, const SdfPath &path);
89
112 USDLUX_API
113 static UsdLuxDiskLight
114 Define(const UsdStagePtr &stage, const SdfPath &path);
115
116protected:
120 USDLUX_API
122
123private:
124 // needs to invoke _GetStaticTfType.
125 friend class UsdSchemaRegistry;
126 USDLUX_API
127 static const TfType &_GetStaticTfType();
128
129 static bool _IsTypedSchema();
130
131 // override SchemaBase virtuals.
132 USDLUX_API
133 const TfType &_GetTfType() const override;
134
135public:
136 // --------------------------------------------------------------------- //
137 // RADIUS
138 // --------------------------------------------------------------------- //
146 USDLUX_API
148
154 USDLUX_API
155 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
156
157public:
158 // ===================================================================== //
159 // Feel free to add custom code below this line, it will be preserved by
160 // the code generator.
161 //
162 // Just remember to:
163 // - Close the class declaration with };
164 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
165 // - Close the include guard with #endif
166 // ===================================================================== //
167 // --(BEGIN CUSTOM CODE)--
168};
169
170PXR_NAMESPACE_CLOSE_SCOPE
171
172#endif
Contains an asset path and optional evaluated and resolved paths.
Definition: assetPath.h:73
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:167
Base class for intrinsic lights that are boundable.
Light emitted from one side of a circular disk.
Definition: diskLight.h:42
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:61
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: diskLight.h:47
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:53
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: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