All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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"
31 #include "pxr/usd/usd/apiSchemaBase.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 // LISTAPI //
51 // -------------------------------------------------------------------------- //
52 
181 {
182 public:
187 
192  explicit UsdLuxListAPI(const UsdPrim& prim=UsdPrim())
193  : UsdAPISchemaBase(prim)
194  {
195  }
196 
200  explicit UsdLuxListAPI(const UsdSchemaBase& schemaObj)
201  : UsdAPISchemaBase(schemaObj)
202  {
203  }
204 
206  USDLUX_API
207  virtual ~UsdLuxListAPI();
208 
212  USDLUX_API
213  static const TfTokenVector &
214  GetSchemaAttributeNames(bool includeInherited=true);
215 
225  USDLUX_API
226  static UsdLuxListAPI
227  Get(const UsdStagePtr &stage, const SdfPath &path);
228 
229 
242  USDLUX_API
243  static UsdLuxListAPI
244  Apply(const UsdPrim &prim);
245 
246 protected:
250  USDLUX_API
251  UsdSchemaType _GetSchemaType() const override;
252 
253 private:
254  // needs to invoke _GetStaticTfType.
255  friend class UsdSchemaRegistry;
256  USDLUX_API
257  static const TfType &_GetStaticTfType();
258 
259  static bool _IsTypedSchema();
260 
261  // override SchemaBase virtuals.
262  USDLUX_API
263  const TfType &_GetTfType() const override;
264 
265 public:
266  // --------------------------------------------------------------------- //
267  // LIGHTLISTCACHEBEHAVIOR
268  // --------------------------------------------------------------------- //
288  USDLUX_API
290 
296  USDLUX_API
297  UsdAttribute CreateLightListCacheBehaviorAttr(VtValue const &defaultValue = VtValue(), bool writeSparsely=false) const;
298 
299 public:
300  // --------------------------------------------------------------------- //
301  // LIGHTLIST
302  // --------------------------------------------------------------------- //
305  USDLUX_API
307 
310  USDLUX_API
312 
313 public:
314  // ===================================================================== //
315  // Feel free to add custom code below this line, it will be preserved by
316  // the code generator.
317  //
318  // Just remember to:
319  // - Close the class declaration with };
320  // - Close the namespace with PXR_NAMESPACE_CLOSE_SCOPE
321  // - Close the include guard with #endif
322  // ===================================================================== //
323  // --(BEGIN CUSTOM CODE)--
324 
326  enum ComputeMode {
332  };
333 
353  USDLUX_API
354  SdfPathSet ComputeLightList(ComputeMode mode) const;
355 
360  USDLUX_API
361  void StoreLightList(const SdfPathSet &) const;
362 
365  USDLUX_API
366  void InvalidateLightList() const;
367 };
368 
369 PXR_NAMESPACE_CLOSE_SCOPE
370 
371 #endif
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...
UsdLuxListAPI(const UsdSchemaBase &schemaObj)
Construct a UsdLuxListAPI on the prim held by schemaObj .
Definition: listAPI.h:200
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr() const
Controls how the lightList should be interpreted.
ComputeMode
Runtime control over whether to consult stored lightList caches.
Definition: listAPI.h:326
static USDLUX_API UsdLuxListAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
The base class for all API schemas.
Consult any caches found on the model hierarchy.
Definition: listAPI.h:329
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
Definition: attribute.h:176
UsdSchemaType
An enum representing which type of schema a given schema class belongs to.
Definition: common.h:149
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
Definition: prim.h:131
std::vector< TfToken > TfTokenVector
Convenience types.
Definition: token.h:438
Single Apply API schema.
static const UsdSchemaType schemaType
Compile time constant representing what kind of schema this class is.
Definition: listAPI.h:186
A path value used to locate objects in layers or scenegraphs.
Definition: path.h:287
USDLUX_API void StoreLightList(const SdfPathSet &) const
Store the given paths as the lightlist for this prim.
A UsdRelationship creates dependencies between scenegraph objects by allowing a prim to target other ...
Definition: relationship.h:128
virtual USDLUX_API ~UsdLuxListAPI()
Destructor.
Contains an asset path and an optional resolved path.
Definition: assetPath.h:43
UsdLuxListAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxListAPI on UsdPrim prim .
Definition: listAPI.h:192
USDLUX_API void InvalidateLightList() const
Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore...
USDLUX_API UsdSchemaType _GetSchemaType() const override
Returns the type of schema this class belongs to.
TfType represents a dynamic runtime type.
Definition: type.h:70
USDLUX_API UsdRelationship GetLightListRel() const
Relationship to lights in the scene.
Singleton registry that provides access to prim and property definition information for registered Us...
API schema to support discovery and publishing of lights in a scene.
Definition: listAPI.h:180
Ignore any caches found, and do a full prim traversal.
Definition: listAPI.h:331
USDLUX_API SdfPathSet ComputeLightList(ComputeMode mode) const
Computes and returns the list of lights and light filters in the stage, optionally consulting a cache...
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. ...
The base class for all schema types in Usd.
Definition: schemaBase.h:56
USDLUX_API UsdRelationship CreateLightListRel() const
See GetLightListRel(), and also Create vs Get Property Methods for when to use Get vs Create...
Provides a container which may hold any type, and provides introspection and iteration over array typ...
Definition: value.h:182
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...