Loading...
Searching...
No Matches
listAPI.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_LISTAPI_H
25#define USDLUX_GENERATED_LISTAPI_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// LISTAPI //
51// -------------------------------------------------------------------------- //
52
66{
67public:
71 static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI;
72
77 explicit UsdLuxListAPI(const UsdPrim& prim=UsdPrim())
78 : UsdAPISchemaBase(prim)
79 {
80 }
81
85 explicit UsdLuxListAPI(const UsdSchemaBase& schemaObj)
86 : UsdAPISchemaBase(schemaObj)
87 {
88 }
89
91 USDLUX_API
92 virtual ~UsdLuxListAPI();
93
97 USDLUX_API
98 static const TfTokenVector &
99 GetSchemaAttributeNames(bool includeInherited=true);
100
110 USDLUX_API
111 static UsdLuxListAPI
112 Get(const UsdStagePtr &stage, const SdfPath &path);
113
114
131 USDLUX_API
132 static bool
133 CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
134
150 USDLUX_API
151 static UsdLuxListAPI
152 Apply(const UsdPrim &prim);
153
154protected:
158 USDLUX_API
160
161private:
162 // needs to invoke _GetStaticTfType.
163 friend class UsdSchemaRegistry;
164 USDLUX_API
165 static const TfType &_GetStaticTfType();
166
167 static bool _IsTypedSchema();
168
169 // override SchemaBase virtuals.
170 USDLUX_API
171 const TfType &_GetTfType() const override;
172
173public:
174 // --------------------------------------------------------------------- //
175 // LIGHTLISTCACHEBEHAVIOR
176 // --------------------------------------------------------------------- //
197 USDLUX_API
199
205 USDLUX_API
206 UsdAttribute CreateLightListCacheBehaviorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
207
208public:
209 // --------------------------------------------------------------------- //
210 // LIGHTLIST
211 // --------------------------------------------------------------------- //
214 USDLUX_API
216
219 USDLUX_API
221
222public:
223 // ===================================================================== //
224 // Feel free to add custom code below this line, it will be preserved by
225 // the code generator.
226 //
227 // Just remember to:
228 // - Close the class declaration with };
229 // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
230 // - Close the include guard with #endif
231 // ===================================================================== //
232 // --(BEGIN CUSTOM CODE)--
233
241 };
242
262 USDLUX_API
263 SdfPathSet ComputeLightList(ComputeMode mode) const;
264
269 USDLUX_API
270 void StoreLightList(const SdfPathSet &) const;
271
274 USDLUX_API
276};
277
278PXR_NAMESPACE_CLOSE_SCOPE
279
280#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.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
USDLUX_API void StoreLightList(const SdfPathSet &) const
Store the given paths as the lightlist for this prim.
UsdLuxListAPI(const UsdSchemaBase &schemaObj)
Construct a UsdLuxListAPI on the prim held by schemaObj .
Definition: listAPI.h:85
USDLUX_API SdfPathSet ComputeLightList(ComputeMode mode) const
Computes and returns the list of lights and light filters in the stage, optionally consulting a cache...
USDLUX_API UsdRelationship GetLightListRel() const
Relationship to lights in the scene.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: listAPI.h:71
virtual USDLUX_API ~UsdLuxListAPI()
Destructor.
ComputeMode
Runtime control over whether to consult stored lightList caches.
Definition: listAPI.h:235
@ ComputeModeConsultModelHierarchyCache
Consult any caches found on the model hierarchy.
Definition: listAPI.h:238
@ ComputeModeIgnoreCache
Ignore any caches found, and do a full prim traversal.
Definition: listAPI.h:240
static USDLUX_API UsdLuxListAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDLUX_API UsdRelationship CreateLightListRel() const
See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API void InvalidateLightList() const
Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore.
USDLUX_API UsdAttribute CreateLightListCacheBehaviorAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetLightListCacheBehaviorAttr(), and also Create vs Get Property Methods for when to use Get vs C...
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr() const
Controls how the lightList should be interpreted.
UsdLuxListAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxListAPI on UsdPrim prim .
Definition: listAPI.h:77
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 UsdLuxListAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxListAPI 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
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
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