Loading...
Searching...
No Matches
volumeLightAPI.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_VOLUMELIGHTAPI_H
25#define USDLUX_GENERATED_VOLUMELIGHTAPI_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// VOLUMELIGHTAPI //
51// -------------------------------------------------------------------------- //
52
67{
68public:
72 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
73
78 explicit UsdLuxVolumeLightAPI(const UsdPrim& prim=UsdPrim())
79 : UsdAPISchemaBase(prim)
80 {
81 }
82
86 explicit UsdLuxVolumeLightAPI(const UsdSchemaBase& schemaObj)
87 : UsdAPISchemaBase(schemaObj)
88 {
89 }
90
92 USDLUX_API
94
98 USDLUX_API
99 static const TfTokenVector &
100 GetSchemaAttributeNames(bool includeInherited=true);
101
111 USDLUX_API
113 Get(const UsdStagePtr &stage, const SdfPath &path);
114
115
132 USDLUX_API
133 static bool
134 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
135
151 USDLUX_API
153 Apply(const UsdPrim &prim);
154
155protected:
159 USDLUX_API
161
162private:
163 // needs to invoke _GetStaticTfType.
164 friend class UsdSchemaRegistry;
165 USDLUX_API
166 static const TfType &_GetStaticTfType();
167
168 static bool _IsTypedSchema();
169
170 // override SchemaBase virtuals.
171 USDLUX_API
172 const TfType &_GetTfType() const override;
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:290
TfType represents a dynamic runtime type.
Definition: type.h:65
The base class for all API schemas.
This is the preferred API schema to apply to Volume type prims when adding light behaviors to a volum...
static USDLUX_API UsdLuxVolumeLightAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxVolumeLightAPI holding the prim adhering to this schema at path on stage.
virtual USDLUX_API ~UsdLuxVolumeLightAPI()
Destructor.
UsdLuxVolumeLightAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxVolumeLightAPI on UsdPrim prim .
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
UsdLuxVolumeLightAPI(const UsdSchemaBase &schemaObj)
Construct a UsdLuxVolumeLightAPI on the prim held by schemaObj .
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...
static USDLUX_API bool CanApply(const UsdPrim &prim, std::string *whyNot=nullptr)
Returns true if this single-apply API schema can be applied to the given prim.
static USDLUX_API UsdLuxVolumeLightAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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...
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