All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
geometryLight.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_GEOMETRYLIGHT_H
8#define USDLUX_GENERATED_GEOMETRYLIGHT_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// GEOMETRYLIGHT //
34// -------------------------------------------------------------------------- //
35
43{
44public:
48 static const UsdSchemaKind schemaKind = UsdSchemaKind::ConcreteTyped;
49
54 explicit UsdLuxGeometryLight(const UsdPrim& prim=UsdPrim())
56 {
57 }
58
62 explicit UsdLuxGeometryLight(const UsdSchemaBase& schemaObj)
64 {
65 }
66
68 USDLUX_API
70
74 USDLUX_API
75 static const TfTokenVector &
76 GetSchemaAttributeNames(bool includeInherited=true);
77
87 USDLUX_API
89 Get(const UsdStagePtr &stage, const SdfPath &path);
90
113 USDLUX_API
115 Define(const UsdStagePtr &stage, const SdfPath &path);
116
117protected:
121 USDLUX_API
123
124private:
125 // needs to invoke _GetStaticTfType.
126 friend class UsdSchemaRegistry;
127 USDLUX_API
128 static const TfType &_GetStaticTfType();
129
130 static bool _IsTypedSchema();
131
132 // override SchemaBase virtuals.
133 USDLUX_API
134 const TfType &_GetTfType() const override;
135
136public:
137 // --------------------------------------------------------------------- //
138 // GEOMETRY
139 // --------------------------------------------------------------------- //
142 USDLUX_API
144
147 USDLUX_API
149
150public:
151 // ===================================================================== //
152 // Feel free to add custom code below this line, it will be preserved by
153 // the code generator.
154 //
155 // Just remember to:
156 // - Close the class declaration with };
157 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
158 // - Close the include guard with #endif
159 // ===================================================================== //
160 // --(BEGIN CUSTOM CODE)--
161};
162
163PXR_NAMESPACE_CLOSE_SCOPE
164
165#endif
Contains an asset path and an optional resolved path.
Definition: assetPath.h:30
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
static USDLUX_API UsdLuxGeometryLight Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxGeometryLight holding the prim adhering to this schema at path on stage.
UsdLuxGeometryLight(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxGeometryLight on UsdPrim prim .
Definition: geometryLight.h:54
UsdLuxGeometryLight(const UsdSchemaBase &schemaObj)
Construct a UsdLuxGeometryLight on the prim held by schemaObj .
Definition: geometryLight.h:62
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: geometryLight.h:48
USDLUX_API UsdRelationship GetGeometryRel() const
Relationship to the geometry to use as the light source.
static USDLUX_API UsdLuxGeometryLight 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 UsdRelationship CreateGeometryRel() const
See GetGeometryRel(), and also Create vs Get Property Methods for when to use Get vs Create.
virtual USDLUX_API ~UsdLuxGeometryLight()
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...
Base class for intrinsic lights that are not boundable.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:117
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:111
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...
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