lightListAPI.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_LIGHTLISTAPI_H
25 #define USDLUX_GENERATED_LIGHTLISTAPI_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"
34 #include "pxr/usd/usdLux/tokens.h"
35 
36 #include "pxr/base/vt/value.h"
37 
38 #include "pxr/base/gf/vec3d.h"
39 #include "pxr/base/gf/vec3f.h"
40 #include "pxr/base/gf/matrix4d.h"
41 
42 #include "pxr/base/tf/token.h"
43 #include "pxr/base/tf/type.h"
44 
45 PXR_NAMESPACE_OPEN_SCOPE
46 
47 class SdfAssetPath;
48 
49 // -------------------------------------------------------------------------- //
50 // LIGHTLISTAPI //
51 // -------------------------------------------------------------------------- //
52 
181 {
182 public:
187 
192  explicit UsdLuxLightListAPI(const UsdPrim& prim=UsdPrim())
193  : UsdAPISchemaBase(prim)
194  {
195  }
196 
200  explicit UsdLuxLightListAPI(const UsdSchemaBase& schemaObj)
201  : UsdAPISchemaBase(schemaObj)
202  {
203  }
204 
206  USDLUX_API
207  virtual ~UsdLuxLightListAPI();
208 
212  USDLUX_API
213  static const TfTokenVector &
214  GetSchemaAttributeNames(bool includeInherited=true);
215 
225  USDLUX_API
226  static UsdLuxLightListAPI
227  Get(const UsdStagePtr &stage, const SdfPath &path);
228 
229 
246  USDLUX_API
247  static bool
248  CanApply(const UsdPrim &prim, std::string *whyNot=nullptr);
249 
265  USDLUX_API
266  static UsdLuxLightListAPI
267  Apply(const UsdPrim &prim);
268 
269 protected:
273  USDLUX_API
274  UsdSchemaKind _GetSchemaKind() const override;
275 
276 private:
277  // needs to invoke _GetStaticTfType.
278  friend class UsdSchemaRegistry;
279  USDLUX_API
280  static const TfType &_GetStaticTfType();
281 
282  static bool _IsTypedSchema();
283 
284  // override SchemaBase virtuals.
285  USDLUX_API
286  const TfType &_GetTfType() const override;
287 
288 public:
289  // --------------------------------------------------------------------- //
290  // LIGHTLISTCACHEBEHAVIOR
291  // --------------------------------------------------------------------- //
312  USDLUX_API
314 
320  USDLUX_API
321  UsdAttribute CreateLightListCacheBehaviorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
322 
323 public:
324  // --------------------------------------------------------------------- //
325  // LIGHTLIST
326  // --------------------------------------------------------------------- //
329  USDLUX_API
331 
334  USDLUX_API
336 
337 public:
338  // ===================================================================== //
339  // Feel free to add custom code below this line, it will be preserved by
340  // the code generator.
341  //
342  // Just remember to:
343  // - Close the class declaration with };
344  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
345  // - Close the include guard with #endif
346  // ===================================================================== //
347  // --(BEGIN CUSTOM CODE)--
348 
350  enum ComputeMode {
356  };
357 
377  USDLUX_API
378  SdfPathSet ComputeLightList(ComputeMode mode) const;
379 
384  USDLUX_API
385  void StoreLightList(const SdfPathSet &) const;
386 
389  USDLUX_API
390  void InvalidateLightList() const;
391 };
392 
393 PXR_NAMESPACE_CLOSE_SCOPE
394 
395 #endif
USDLUX_API void InvalidateLightList() const
Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore.
UsdLuxLightListAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxLightListAPI on UsdPrim prim .
Definition: lightListAPI.h:192
API schema to support discovery and publishing of lights in a scene.
Definition: lightListAPI.h:180
Ignore any caches found, and do a full prim traversal.
Definition: lightListAPI.h:355
USDLUX_API UsdRelationship CreateLightListRel() const
See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create.
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
ComputeMode
Runtime control over whether to consult stored lightList caches.
Definition: lightListAPI.h:350
The base class for all API schemas.
static USDLUX_API UsdLuxLightListAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdLuxLightListAPI holding the prim adhering to this schema at path on stage.
Scenegraph object for authoring and retrieving numeric, string, and array valued data,...
Definition: attribute.h:176
UsdLuxLightListAPI(const UsdSchemaBase &schemaObj)
Construct a UsdLuxLightListAPI on the prim held by schemaObj .
Definition: lightListAPI.h:200
static USDLUX_API UsdLuxLightListAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
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.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
Definition: common.h:127
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr() const
Controls how the lightList should be interpreted.
Single Apply API schema.
virtual USDLUX_API ~UsdLuxLightListAPI()
Destructor.
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 SdfPathSet ComputeLightList(ComputeMode mode) const
Computes and returns the list of lights and light filters in the stage, optionally consulting a cache...
USDLUX_API void StoreLightList(const SdfPathSet &) const
Store the given paths as the lightlist for this prim.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:134
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:442
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:290
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
Definition: lightListAPI.h:186
Contains an asset path and an optional resolved path.
Definition: assetPath.h:47
USDLUX_API UsdRelationship GetLightListRel() const
Relationship to lights in the scene.
TfType represents a dynamic runtime type.
Definition: type.h:64
Singleton registry that provides access to schema type information and the prim definitions for regis...
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...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:166
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
Consult any caches found on the model hierarchy.
Definition: lightListAPI.h:353