24 #ifndef USDLUX_GENERATED_LISTAPI_H
25 #define USDLUX_GENERATED_LISTAPI_H
30 #include "pxr/usd/usdLux/api.h"
36 #include "pxr/base/vt/value.h"
43 #include "pxr/base/tf/type.h"
45 PXR_NAMESPACE_OPEN_SCOPE
227 Get(
const UsdStagePtr &stage,
const SdfPath &path);
280 static const TfType &_GetStaticTfType();
282 static bool _IsTypedSchema();
286 const TfType &_GetTfType()
const override;
393 PXR_NAMESPACE_CLOSE_SCOPE
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 .
USDLUX_API UsdAttribute GetLightListCacheBehaviorAttr() const
Controls how the lightList should be interpreted.
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
ComputeMode
Runtime control over whether to consult stored lightList caches.
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.
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
USDLUX_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
UsdPrim is the sole persistent scenegraph object on a UsdStage, and is the embodiment of a "Prim" as ...
std::vector< TfToken > TfTokenVector
Convenience types.
A path value used to locate objects in layers or scenegraphs.
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.
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 ...
virtual USDLUX_API ~UsdLuxListAPI()
Destructor.
Contains an asset path and an optional resolved path.
UsdLuxListAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdLuxListAPI on UsdPrim prim .
USDLUX_API void InvalidateLightList() const
Mark any stored lightlist as invalid, by setting the lightList:cacheBehavior attribute to ignore...
TfType represents a dynamic runtime type.
USDLUX_API UsdRelationship GetLightListRel() const
Relationship to lights in the scene.
Singleton registry that provides access to schema type information and the prim definitions for regis...
API schema to support discovery and publishing of lights in a scene.
Ignore any caches found, and do a full prim traversal.
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.
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...
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...
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...