UsdLuxShadowAPI

Fully qualified name: usdrt::UsdLuxShadowAPI

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 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.

inline explicit operator bool() const

Check if this schema object is compatible with it’s held prim and that the prim is valid.

A typed schema object is compatible if the held prim’s type is or is a subtype of the schema’s type. Based on prim.IsA().

An API schema object is compatible if the API is of type SingleApplyAPI or UsdSchemaType::MultipleApplyAPI, and the schema has been applied to the prim. Based on prim.HasAPI.

This method invokes polymorphic behaviour.

See also

UsdSchemaBase::_IsCompatible()

Returns:

True if the help prim is valid, and the schema object is compatible with its 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.

inline virtual bool _IsCompatible() const

Check whether this APISchema object is valid for the currently held prim.

If this is an applied API schema, this returns true if the held prim is valid and already has the API schema applied to it, along with the instanceName (in the case of multiple-apply). The instanceName should not be empty in the case of a multiple-apply API schema.

This check is performed when clients invoke the explicit bool conversion operator, implemented in UsdSchemaBase.

See also

UsdPrim::HasAPI()

inline const TfToken _GetType() const

Helper for subclasses to get this schema’s type token.

Note

This diverges from Usd and returns a TfToken, since we don’t implements TfType.

Returns:

The token representing the schema’s TfType.