Loading...
Searching...
No Matches
cylinderLight.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_CYLINDERLIGHT_H
25#define USDLUX_GENERATED_CYLINDERLIGHT_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// CYLINDERLIGHT //
51// -------------------------------------------------------------------------- //
52
61{
62public:
66 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
67
72 explicit UsdLuxCylinderLight(const UsdPrim& prim=UsdPrim())
74 {
75 }
76
80 explicit UsdLuxCylinderLight(const UsdSchemaBase& schemaObj)
81 : UsdLuxBoundableLightBase(schemaObj)
82 {
83 }
84
86 USDLUX_API
88
92 USDLUX_API
93 static const TfTokenVector &
94 GetSchemaAttributeNames(bool includeInherited=true);
95
105 USDLUX_API
107 Get(const UsdStagePtr &stage, const SdfPath &path);
108
131 USDLUX_API
133 Define(const UsdStagePtr &stage, const SdfPath &path);
134
135protected:
139 USDLUX_API
141
142private:
143 // needs to invoke _GetStaticTfType.
144 friend class UsdSchemaRegistry;
145 USDLUX_API
146 static const TfType &_GetStaticTfType();
147
148 static bool _IsTypedSchema();
149
150 // override SchemaBase virtuals.
151 USDLUX_API
152 const TfType &_GetTfType() const override;
153
154public:
155 // --------------------------------------------------------------------- //
156 // LENGTH
157 // --------------------------------------------------------------------- //
165 USDLUX_API
167
173 USDLUX_API
174 UsdAttribute CreateLengthAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
175
176public:
177 // --------------------------------------------------------------------- //
178 // RADIUS
179 // --------------------------------------------------------------------- //
187 USDLUX_API
189
195 USDLUX_API
196 UsdAttribute CreateRadiusAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
197
198public:
199 // --------------------------------------------------------------------- //
200 // TREATASLINE
201 // --------------------------------------------------------------------- //
212 USDLUX_API
214
220 USDLUX_API
221 UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
222
223public:
224 // ===================================================================== //
225 // Feel free to add custom code below this line, it will be preserved by
226 // the code generator.
227 //
228 // Just remember to:
229 // - Close the class declaration with };
230 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
231 // - Close the include guard with #endif
232 // ===================================================================== //
233 // --(BEGIN CUSTOM CODE)--
234};
235
236PXR_NAMESPACE_CLOSE_SCOPE
237
238#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 cylinder.
Definition: cylinderLight.h:61
UsdLuxCylinderLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxCylinderLight on the prim held by schemaObj .
Definition: cylinderLight.h:80
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: cylinderLight.h:66
virtual USDLUX_API ~UsdLuxCylinderLight()
Destructor.
USDLUX_API UsdAttribute CreateTreatAsLineAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetTreatAsLineAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
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 GetRadiusAttr() const
Radius of the cylinder.
USDLUX_API UsdAttribute CreateLengthAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLengthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdAttribute GetTreatAsLineAttr() const
A hint that this light can be treated as a 'line' light (effectively, a zero-radius cylinder) by rend...
static USDLUX_API UsdLuxCylinderLight 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 GetLengthAttr() const
Length of the cylinder, in the local X axis.
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...
UsdLuxCylinderLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxCylinderLight on UsdPrim prim .
Definition: cylinderLight.h:72
static USDLUX_API UsdLuxCylinderLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxCylinderLight holding the prim adhering to this schema at path on stage.
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