Controls to refine a light's shadow behavior. More...

#include <shadowAPI.h>

Inheritance diagram for UsdLuxShadowAPI:

Public Member Functions
	UsdLuxShadowAPI (const UsdPrim &prim=UsdPrim())
	Construct a UsdLuxShadowAPI on UsdPrim `prim` .

	UsdLuxShadowAPI (const UsdSchemaBase &schemaObj)
	Construct a UsdLuxShadowAPI on the prim held by `schemaObj` .

virtual USDLUX_API	~UsdLuxShadowAPI ()
	Destructor.

USDLUX_API UsdAttribute	GetShadowEnableAttr () const
	Enables shadows to be cast by this light.

USDLUX_API UsdAttribute	CreateShadowEnableAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShadowEnableAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDLUX_API UsdAttribute	GetShadowColorAttr () const
	The color of shadows cast by the light.

USDLUX_API UsdAttribute	CreateShadowColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShadowColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDLUX_API UsdAttribute	GetShadowDistanceAttr () const
	The maximum distance shadows are cast.

USDLUX_API UsdAttribute	CreateShadowDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShadowDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDLUX_API UsdAttribute	GetShadowFalloffAttr () const
	The size of the shadow falloff zone within the shadow max distance, which can be used to hide the hard cut-off for shadows seen stretching past the max distance.

USDLUX_API UsdAttribute	CreateShadowFalloffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShadowFalloffAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

USDLUX_API UsdAttribute	GetShadowFalloffGammaAttr () const
	A gamma (i.e., exponential) control over shadow strength with linear distance within the falloff zone.

USDLUX_API UsdAttribute	CreateShadowFalloffGammaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
	See GetShadowFalloffGammaAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

Conversion to and from UsdShadeConnectableAPI
USDLUX_API	UsdLuxShadowAPI (const UsdShadeConnectableAPI &connectable)
	Constructor that takes a ConnectableAPI object.

USDLUX_API UsdShadeConnectableAPI	ConnectableAPI () const
	Contructs and returns a UsdShadeConnectableAPI object with this shadow API prim.

Outputs API
Outputs represent a typed attribute on a shadow API whose value is computed externally.
USDLUX_API UsdShadeOutput	CreateOutput (const TfToken &name, const SdfValueTypeName &typeName)
	Create an output which can either have a value or can be connected.

USDLUX_API UsdShadeOutput	GetOutput (const TfToken &name) const
	Return the requested output if it exists.

USDLUX_API std::vector< UsdShadeOutput >	GetOutputs (bool onlyAuthored=true) const
	Outputs are represented by attributes in the "outputs:" namespace.

Inputs API
Inputs are connectable attribute with a typed value. Shadow API parameters are encoded as inputs.
USDLUX_API UsdShadeInput	CreateInput (const TfToken &name, const SdfValueTypeName &typeName)
	Create an input which can either have a value or can be connected.

USDLUX_API UsdShadeInput	GetInput (const TfToken &name) const
	Return the requested input if it exists.

USDLUX_API std::vector< UsdShadeInput >	GetInputs (bool onlyAuthored=true) const
	Inputs are represented by attributes in the "inputs:" namespace.

Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	Construct a UsdAPISchemaBase on UsdPrim `prim` .

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
	Construct a UsdAPISchemaBase on the prim held by `schemaObj` .

virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor.

Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
	Returns whether or not this class corresponds to a concrete instantiable prim type in scene description.

bool	IsTyped () const
	Returns whether or not this class inherits from UsdTyped.

bool	IsAPISchema () const
	Returns whether this is an API schema or not.

bool	IsAppliedAPISchema () const
	Returns whether this is an applied API schema or not.

bool	IsMultipleApplyAPISchema () const
	Returns whether this is an applied API schema or not.

UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is.

USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store `prim` as the held prim.

USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by `otherSchema`.

virtual USD_API	~UsdSchemaBase ()
	Destructor.

UsdPrim	GetPrim () const
	Return this schema object's held prim.

SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath().

USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const
	Return the prim definition associated with this schema instance if one exists, otherwise return null.

USD_API	operator bool () const
	Return true if this schema object is compatible with its held prim, false otherwise.

Static Public Member Functions
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 classes.

static USDLUX_API UsdLuxShadowAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
	Return a UsdLuxShadowAPI holding the prim adhering to this schema at `path` on `stage`.

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

static USDLUX_API UsdLuxShadowAPI	Apply (const UsdPrim &prim)
	Applies this single-apply API schema to the given `prim`.

Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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 classes.

Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
	Compile time constant representing what kind of schema this class is.

Protected Member Functions
USDLUX_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaKind	_GetSchemaKind () const override
	Returns the kind of schema this class belongs to.

	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on UsdPrim `prim` with the specified `instanceName`.

	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
	Construct a multiple-apply UsdAPISchemaBase on the prim held by `schemaObj` with the given `instanceName`.

const TfToken &	_GetInstanceName () const
	Returns the instance name of the API schema object belonging to a multiple-apply API schema.

USD_API bool	_IsCompatible () const override
	Check whether this APISchema object is valid for the currently held prim.

Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaKind	_GetSchemaType () const

const TfType &	_GetType () const

USD_API UsdAttribute	_CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const

Friends
class	UsdSchemaRegistry

Additional Inherited Members
Static Protected Member Functions inherited from UsdAPISchemaBase
static USD_API TfTokenVector	_GetMultipleApplyInstanceNames (const UsdPrim &prim, const TfType &schemaType)
	Returns a vector of names of API schema objects belonging to a multiple-apply API schema applied to a given prim.

Detailed Description

Controls to refine a light's shadow behavior.

These are non-physical controls that are valuable for visual lighting work.

Definition at line 44 of file shadowAPI.h.

Constructor & Destructor Documentation

◆ UsdLuxShadowAPI() [1/3]

UsdLuxShadowAPI ( const UsdPrim & prim = UsdPrim() )

inlineexplicit

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

Definition at line 56 of file shadowAPI.h.

◆ UsdLuxShadowAPI() [2/3]

UsdLuxShadowAPI ( const UsdSchemaBase & schemaObj )

inlineexplicit

Construct a UsdLuxShadowAPI on the prim held by schemaObj .

Should be preferred over UsdLuxShadowAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 64 of file shadowAPI.h.

◆ ~UsdLuxShadowAPI()

virtual USDLUX_API ~UsdLuxShadowAPI ( )

virtual

Destructor.

◆ UsdLuxShadowAPI() [3/3]

USDLUX_API UsdLuxShadowAPI ( const UsdShadeConnectableAPI & connectable )

Constructor that takes a ConnectableAPI object.

Allow implicit conversion of UsdShadeConnectableAPI to UsdLuxShadowAPI.

Member Function Documentation

◆ _GetSchemaKind()

USDLUX_API UsdSchemaKind _GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See also: UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

◆ Apply()

static USDLUX_API UsdLuxShadowAPI Apply ( const UsdPrim & prim )

static

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.

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.

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ CanApply()

static USDLUX_API bool CanApply	(	const UsdPrim &	prim,
		std::string *	whyNot = `nullptr`
	)

static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See also: UsdPrim::GetAppliedSchemas(); UsdPrim::HasAPI(); UsdPrim::CanApplyAPI(); UsdPrim::ApplyAPI(); UsdPrim::RemoveAPI()

◆ ConnectableAPI()

USDLUX_API UsdShadeConnectableAPI ConnectableAPI ( ) const

Contructs and returns a UsdShadeConnectableAPI object with this shadow API prim.

Note that a valid UsdLuxShadowAPI will only return a valid UsdShadeConnectableAPI if the its prim's Typed schema type is actually connectable.

◆ CreateInput()

USDLUX_API UsdShadeInput CreateInput	(	const TfToken &	name,
		const SdfValueTypeName &	typeName
	)

Create an input which can either have a value or can be connected.

The attribute representing the input is created in the "inputs:" namespace. Inputs on shadow API are connectable.

◆ CreateOutput()

USDLUX_API UsdShadeOutput CreateOutput	(	const TfToken &	name,
		const SdfValueTypeName &	typeName
	)

Create an output which can either have a value or can be connected.

The attribute representing the output is created in the "outputs:" namespace. Outputs on a shadow API cannot be connected, as their value is assumed to be computed externally.