All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
pluginLight.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_PLUGINLIGHT_H
8#define USDLUX_GENERATED_PLUGINLIGHT_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"
17
19
20#include "pxr/base/vt/value.h"
21
22#include "pxr/base/gf/vec3d.h"
23#include "pxr/base/gf/vec3f.h"
25
26#include "pxr/base/tf/token.h"
27#include "pxr/base/tf/type.h"
28
29PXR_NAMESPACE_OPEN_SCOPE
30
31class SdfAssetPath;
32
33// -------------------------------------------------------------------------- //
34// PLUGINLIGHT //
35// -------------------------------------------------------------------------- //
36
48{
49public:
53 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
54
59 explicit UsdLuxPluginLight(const UsdPrim& prim=UsdPrim())
60 : UsdGeomXformable(prim)
61 {
62 }
63
67 explicit UsdLuxPluginLight(const UsdSchemaBase& schemaObj)
68 : UsdGeomXformable(schemaObj)
69 {
70 }
71
73 USDLUX_API
75
79 USDLUX_API
80 static const TfTokenVector &
81 GetSchemaAttributeNames(bool includeInherited=true);
82
92 USDLUX_API
94 Get(const UsdStagePtr &stage, const SdfPath &path);
95
118 USDLUX_API
119 static UsdLuxPluginLight
120 Define(const UsdStagePtr &stage, const SdfPath &path);
121
122protected:
126 USDLUX_API
128
129private:
130 // needs to invoke _GetStaticTfType.
131 friend class UsdSchemaRegistry;
132 USDLUX_API
133 static const TfType &_GetStaticTfType();
134
135 static bool _IsTypedSchema();
136
137 // override SchemaBase virtuals.
138 USDLUX_API
139 const TfType &_GetTfType() const override;
140
141public:
142 // ===================================================================== //
143 // Feel free to add custom code below this line, it will be preserved by
144 // the code generator.
145 //
146 // Just remember to:
147 // - Close the class declaration with };
148 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
149 // - Close the include guard with #endif
150 // ===================================================================== //
151 // --(BEGIN CUSTOM CODE)--
152
156 USDLUX_API
158};
159
160PXR_NAMESPACE_CLOSE_SCOPE
161
162#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
Base class for all transformable prims, which allows arbitrary sequences of component affine transfor...
Definition: xformable.h:242
Light that provides properties that allow it to identify an external SdrShadingNode definition,...
Definition: pluginLight.h:48
USDLUX_API UsdShadeNodeDefAPI GetNodeDefAPI() const
Convenience method for accessing the UsdShadeNodeDefAPI functionality for this prim.
static USDLUX_API UsdLuxPluginLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxPluginLight holding the prim adhering to this schema at path on stage.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: pluginLight.h:53
virtual USDLUX_API ~UsdLuxPluginLight()
Destructor.
UsdLuxPluginLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxPluginLight on the prim held by schemaObj .
Definition: pluginLight.h:67
static USDLUX_API UsdLuxPluginLight 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...
UsdLuxPluginLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxPluginLight on UsdPrim prim .
Definition: pluginLight.h:59
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...
UsdShadeNodeDefAPI is an API schema that provides attributes for a prim to select a corresponding Sha...
Definition: nodeDefAPI.h:68
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