usdrt::UsdLuxShadowAPI

Defined in usdrt/scenegraph/usd/usdLux/shadowAPI.h

Functions

usdrt::UsdLuxShadowAPI::Apply: Applies this single-apply API schema to the given prim . This information is stored by adding "ShadowAPI" to the token-valued, listOp metadata apiSchemas on the prim.
usdrt::UsdLuxShadowAPI::CreateShadowColorAttr: See GetShadowColorAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::UsdLuxShadowAPI::CreateShadowDistanceAttr: See GetShadowDistanceAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::UsdLuxShadowAPI::CreateShadowEnableAttr: See GetShadowEnableAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::UsdLuxShadowAPI::CreateShadowFalloffAttr: See GetShadowFalloffAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::UsdLuxShadowAPI::CreateShadowFalloffGammaAttr: See GetShadowFalloffGammaAttr() , and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false .
usdrt::DestructionSchemaDestructibleBaseAPI::GetPath: Return the SdfPath to this schema object's held prim.
usdrt::DestructionSchemaDestructibleBaseAPI::GetPrim: Return this schema object's held prim.
usdrt::UsdLuxShadowAPI::GetShadowColorAttr: The color of shadows cast by the light. This is a non-physical control. The default is to cast black shadows.
usdrt::UsdLuxShadowAPI::GetShadowDistanceAttr: The maximum distance shadows are cast. The default value (-1) indicates no limit.
usdrt::UsdLuxShadowAPI::GetShadowEnableAttr: Enables shadows to be cast by this light.
usdrt::UsdLuxShadowAPI::GetShadowFalloffAttr: The near distance at which shadow falloff begins. The default value (-1) indicates no falloff.
usdrt::UsdLuxShadowAPI::GetShadowFalloffGammaAttr: A gamma (i.e., exponential) control over shadow strength with linear distance within the falloff zone. This requires the use of shadowDistance and shadowFalloff.
usdrt::UsdLuxShadowAPI::UsdLuxShadowAPI: Construct a UsdLuxShadowAPI on UsdPrim prim . Equivalent to UsdLuxShadowAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim .
usdrt::UsdLuxShadowAPI::UsdLuxShadowAPI: Construct a UsdLuxShadowAPI on the prim held by schemaObj . Should be preferred over UsdLuxShadowAPI (schemaObj.GetPrim()), as it preserves SchemaBase state.
usdrt::DestructionSchemaDestructibleBaseAPI::_GetInstanceName: Returns the instance name of the API schema object belonging to a multiple-apply API schema.
usdrt::UsdLuxShadowAPI::operator bool: Boolean operator.
usdrt::UsdLuxShadowAPI::~UsdLuxShadowAPI: Destructor.

Variables

usdrt::UsdLuxShadowAPI::schemaType: Compile time constant representing what kind of schema this class is.

class UsdLuxShadowAPI : public usdrt::UsdAPISchemaBase 

Controls to refine a light’s shadow behavior. These are non-physical controls that are valuable for visual lighting work.

Public Functions

inline explicit UsdLuxShadowAPI(const UsdPrim &prim = UsdPrim()): Construct a UsdLuxShadowAPI on UsdPrim prim. Equivalent to UsdLuxShadowAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim , but will not immediately throw an error for an invalid prim.

inline explicit UsdLuxShadowAPI(const UsdSchemaBase &schemaObj): Construct a UsdLuxShadowAPI on the prim held by schemaObj . Should be preferred over UsdLuxShadowAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

inline virtual ~UsdLuxShadowAPI(): Destructor.

inline operator bool() const

Boolean operator.

Returns: Return true if the contained prim is has this api schema applied using HasAPI, and false otherwise.

inline UsdAttribute GetShadowEnableAttr() const

Enables shadows to be cast by this light.


Declaration	`bool inputs:shadow:enable = 1`
C++ Type	bool
Usd Type	SdfValueTypeNames->Bool

inline UsdAttribute CreateShadowEnableAttr() const: See GetShadowEnableAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetShadowColorAttr() const

The color of shadows cast by the light. This is a non-physical control. The default is to cast black shadows.


Declaration	`color3f inputs:shadow:color = (0, 0, 0)`
C++ Type	GfVec3f
Usd Type	SdfValueTypeNames->Color3f

inline UsdAttribute CreateShadowColorAttr() const: See GetShadowColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetShadowDistanceAttr() const

The maximum distance shadows are cast. The default value (-1) indicates no limit.


Declaration	`float inputs:shadow:distance = -1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShadowDistanceAttr() const: See GetShadowDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetShadowFalloffAttr() const

The near distance at which shadow falloff begins. The default value (-1) indicates no falloff.


Declaration	`float inputs:shadow:falloff = -1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShadowFalloffAttr() const: See GetShadowFalloffAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

inline UsdAttribute GetShadowFalloffGammaAttr() const

A gamma (i.e., exponential) control over shadow strength with linear distance within the falloff zone. This requires the use of shadowDistance and shadowFalloff.


Declaration	`float inputs:shadow:falloffGamma = 1`
C++ Type	float
Usd Type	SdfValueTypeNames->Float

inline UsdAttribute CreateShadowFalloffGammaAttr() const: See GetShadowFalloffGammaAttr(), and also Create vs Get Property Methods for when to use Get vs Create. If specified, author defaultValue as the attribute’s default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

UsdPrim GetPrim() const: Return this schema object’s held prim.

SdfPath GetPath() const: Return the SdfPath to this schema object’s held prim.

Public Static Functions

static inline UsdLuxShadowAPI Apply(const UsdPrim &prim)

Applies this single-apply API schema to the given prim. This information is stored by adding “ShadowAPI” to the token-valued, listOp metadata apiSchemas on the prim.

See also

UsdPrim::GetAppliedSchemas()

See also

UsdPrim::HasAPI()

See also

UsdPrim::ApplyAPI()

See also

UsdPrim::RemoveAPI()

Returns: A valid UsdLuxShadowAPI object is returned upon success. An invalid (or empty) UsdLuxShadowAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.

Public Static Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI 

Compile time constant representing what kind of schema this class is.

See also

UsdSchemaType

Protected Functions

inline const TfToken &_GetInstanceName() const

Returns the instance name of the API schema object belonging to a multiple-apply API schema.

The returned instance name will be empty for non-applied and single-apply API schemas.