24 #ifndef USDRI_GENERATED_LIGHTAPI_H
25 #define USDRI_GENERATED_LIGHTAPI_H
30 #include "pxr/usd/usdRi/api.h"
36 #include "pxr/base/vt/value.h"
43 #include "pxr/base/tf/type.h"
45 PXR_NAMESPACE_OPEN_SCOPE
109 Get(
const UsdStagePtr &stage,
const SdfPath &path);
162 static const TfType &_GetStaticTfType();
164 static bool _IsTypedSchema();
168 const TfType &_GetTfType()
const override;
333 PXR_NAMESPACE_CLOSE_SCOPE
USDRI_API UsdAttribute GetRiSamplingImportanceMultiplierAttr() const
Importance of this light for noise control.
USDRI_API UsdAttribute CreateRiTraceLightPathsAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiTraceLightPathsAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
USDRI_API UsdAttribute CreateRiShadowThinShadowAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiShadowThinShadowAttr(), and also Create vs Get Property Methods for when to use Get vs Creat...
USDRI_API UsdAttribute GetRiIntensityNearDistAttr() const
Near distance between the point being illuminated and the light at which the sample doesn't get brigh...
virtual USDRI_API ~UsdRiLightAPI()
Destructor.
The base class for all API schemas.
USDRI_API UsdAttribute CreateRiLightGroupAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiLightGroupAttr(), and also Create vs Get Property Methods for when to use Get vs Create...
Scenegraph object for authoring and retrieving numeric, string, and array valued data, sampled over time.
USDRI_API UsdAttribute CreateRiSamplingImportanceMultiplierAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiSamplingImportanceMultiplierAttr(), and also Create vs Get Property Methods for when to use ...
static const UsdSchemaKind schemaKind
Compile time constant representing what kind of schema this class is.
static USDRI_API UsdRiLightAPI Get(const UsdStagePtr &stage, const SdfPath &path)
Return a UsdRiLightAPI holding the prim adhering to this schema at path on stage. ...
UsdRiLightAPI(const UsdSchemaBase &schemaObj)
Construct a UsdRiLightAPI on the prim held by schemaObj .
UsdSchemaKind
An enum representing which kind of schema a given schema class belongs to.
UsdRiLightAPI(const UsdPrim &prim=UsdPrim())
Construct a UsdRiLightAPI on UsdPrim prim .
static USDRI_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 USDRI_API UsdRiLightAPI Apply(const UsdPrim &prim)
Applies this single-apply API schema to the given prim.
USDRI_API UsdAttribute GetRiShadowThinShadowAttr() const
Enable thin shadow and disable refraction caustics for this light.
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.
USDRI_API UsdSchemaKind _GetSchemaKind() const override
Returns the kind of schema this class belongs to.
Contains an asset path and an optional resolved path.
USDRI_API UsdAttribute CreateRiIntensityNearDistAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiIntensityNearDistAttr(), and also Create vs Get Property Methods for when to use Get vs Crea...
USDRI_API UsdAttribute GetRiSamplingFixedSampleCountAttr() const
Specifies an override of the number of light samples to be taken for this light source.
TfType represents a dynamic runtime type.
USDRI_API UsdAttribute GetRiLightGroupAttr() const
Specify the light group name used for light group LPEs.
Singleton registry that provides access to schema type information and the prim definitions for regis...
USDRI_API UsdAttribute CreateRiSamplingFixedSampleCountAttr(VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
See GetRiSamplingFixedSampleCountAttr(), and also Create vs Get Property Methods for when to use Get ...
The base class for all schema types in Usd.
USDRI_API UsdAttribute GetRiTraceLightPathsAttr() const
Enable light and photon tracing from this light.
Provides a container which may hold any type, and provides introspection and iteration over array typ...
TfToken class for efficient string referencing and hashing, plus conversions to and from stl string c...
static USDRI_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...