UsdLuxShadowAPI Class Reference

#include <shadowAPI.h>

Inheritance diagram for UsdLuxShadowAPI:

Public Member Functions
	UsdLuxShadowAPI (const UsdPrim &prim=UsdPrim())
	UsdLuxShadowAPI (const UsdSchemaBase &schemaObj)
virtual USDLUX_API	~UsdLuxShadowAPI ()
	Destructor. More...
USDLUX_API UsdAttribute	GetShadowEnableAttr () const
USDLUX_API UsdAttribute	CreateShadowEnableAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdAttribute	GetShadowColorAttr () const
USDLUX_API UsdAttribute	CreateShadowColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdAttribute	GetShadowDistanceAttr () const
USDLUX_API UsdAttribute	CreateShadowDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdAttribute	GetShadowFalloffAttr () const
USDLUX_API UsdAttribute	CreateShadowFalloffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
USDLUX_API UsdAttribute	GetShadowFalloffGammaAttr () const
USDLUX_API UsdAttribute	CreateShadowFalloffGammaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
Conversion to and from UsdShadeConnectableAPI
USDLUX_API	UsdLuxShadowAPI (const UsdShadeConnectableAPI &connectable)
USDLUX_API UsdShadeConnectableAPI	ConnectableAPI () const
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)
USDLUX_API UsdShadeOutput	GetOutput (const TfToken &name) const
USDLUX_API std::vector < UsdShadeOutput >	GetOutputs (bool onlyAuthored=true) const
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)
USDLUX_API UsdShadeInput	GetInput (const TfToken &name) const
USDLUX_API std::vector < UsdShadeInput >	GetInputs (bool onlyAuthored=true) const
Public Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
	UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
virtual USD_API	~UsdAPISchemaBase ()=0
	Destructor. More...
Public Member Functions inherited from UsdSchemaBase
bool	IsConcrete () const
bool	IsTyped () const
bool	IsAPISchema () const
	Returns whether this is an API schema or not. More...
bool	IsAppliedAPISchema () const
bool	IsMultipleApplyAPISchema () const
UsdSchemaKind	GetSchemaKind () const
	Returns the kind of schema this class is. More...
USD_API	UsdSchemaBase (const UsdPrim &prim=UsdPrim())
	Construct and store prim as the held prim. More...
USD_API	UsdSchemaBase (const UsdSchemaBase &otherSchema)
	Construct and store for the same prim held by otherSchema. More...
virtual USD_API	~UsdSchemaBase ()
	Destructor. More...
USD_API	operator bool () const
UsdPrim	GetPrim () const
	Return this schema object's held prim. More...
SdfPath	GetPath () const
	Shorthand for GetPrim()->GetPath(). More...
USD_API const UsdPrimDefinition *	GetSchemaClassPrimDefinition () const

Static Public Member Functions
static USDLUX_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
static USDLUX_API UsdLuxShadowAPI	Get (const UsdStagePtr &stage, const SdfPath &path)
static USDLUX_API bool	CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
static USDLUX_API UsdLuxShadowAPI	Apply (const UsdPrim &prim)
Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)
Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVector &	GetSchemaAttributeNames (bool includeInherited=true)

Static Public Attributes
static const UsdSchemaKind	schemaKind = UsdSchemaKind::SingleApplyAPI
Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase
Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaKind	schemaKind = UsdSchemaKind::AbstractBase

Protected Member Functions
USDLUX_API UsdSchemaKind	_GetSchemaKind () const override
Protected Member Functions inherited from UsdAPISchemaBase
	UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
	UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
const TfToken &	_GetInstanceName () const
USD_API bool	_IsCompatible () const override
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)

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 61 of file shadowAPI.h.

Constructor & Destructor Documentation

UsdLuxShadowAPI::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 73 of file shadowAPI.h.

UsdLuxShadowAPI::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 81 of file shadowAPI.h.

virtual USDLUX_API UsdLuxShadowAPI::~UsdLuxShadowAPI ( )

virtual

Destructor.

USDLUX_API UsdLuxShadowAPI::UsdLuxShadowAPI

(

const UsdShadeConnectableAPI &

connectable

)

Constructor that takes a ConnectableAPI object. Allow implicit conversion of UsdShadeConnectableAPI to UsdLuxShadowAPI.

Member Function Documentation

USDLUX_API UsdSchemaKind UsdLuxShadowAPI::_GetSchemaKind ( ) const

overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also

UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDLUX_API UsdLuxShadowAPI 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()

static USDLUX_API bool UsdLuxShadowAPI::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()

USDLUX_API UsdShadeConnectableAPI UsdLuxShadowAPI::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.

USDLUX_API UsdShadeInput UsdLuxShadowAPI::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.

USDLUX_API UsdShadeOutput UsdLuxShadowAPI::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.

USDLUX_API UsdAttribute UsdLuxShadowAPI::CreateShadowColorAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetShadowColorAttr(), and also Usd_Create_Or_Get_Property 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.

USDLUX_API UsdAttribute UsdLuxShadowAPI::CreateShadowDistanceAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetShadowDistanceAttr(), and also Usd_Create_Or_Get_Property 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.

USDLUX_API UsdAttribute UsdLuxShadowAPI::CreateShadowEnableAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetShadowEnableAttr(), and also Usd_Create_Or_Get_Property 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.

USDLUX_API UsdAttribute UsdLuxShadowAPI::CreateShadowFalloffAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetShadowFalloffAttr(), and also Usd_Create_Or_Get_Property 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.

USDLUX_API UsdAttribute UsdLuxShadowAPI::CreateShadowFalloffGammaAttr	(	VtValue const &	defaultValue = VtValue(),
		bool	writeSparsely = false
	)		const

See GetShadowFalloffGammaAttr(), and also Usd_Create_Or_Get_Property 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.

static USDLUX_API UsdLuxShadowAPI UsdLuxShadowAPI::Get ( const UsdStagePtr &  stage, const SdfPath &  path  )

static

Return a UsdLuxShadowAPI holding the prim adhering to this schema at path on stage. If no prim exists at path on stage, or if the prim at that path does not adhere to this schema, return an invalid schema object. This is shorthand for the following:

UsdLuxShadowAPI(stage->GetPrimAtPath(path));

USDLUX_API UsdShadeInput UsdLuxShadowAPI::GetInput

(

const TfToken &

name

)

const

Return the requested input if it exists.

USDLUX_API std::vector<UsdShadeInput> UsdLuxShadowAPI::GetInputs

(

bool

onlyAuthored = true

)

const

Inputs are represented by attributes in the "inputs:" namespace. If onlyAuthored is true (the default), then only return authored attributes; otherwise, this also returns un-authored builtins.

USDLUX_API UsdShadeOutput UsdLuxShadowAPI::GetOutput

(

const TfToken &

name

)

const

Return the requested output if it exists.

USDLUX_API std::vector<UsdShadeOutput> UsdLuxShadowAPI::GetOutputs

(

bool

onlyAuthored = true

)

const

Outputs are represented by attributes in the "outputs:" namespace. If onlyAuthored is true (the default), then only return authored attributes; otherwise, this also returns un-authored builtins.

static USDLUX_API const TfTokenVector& UsdLuxShadowAPI::GetSchemaAttributeNames ( bool  includeInherited = true )

static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDLUX_API UsdAttribute UsdLuxShadowAPI::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

USDLUX_API UsdAttribute UsdLuxShadowAPI::GetShadowDistanceAttr

(

)

const

The maximum distance shadows are cast. The distance is measured as the distance between the point on the surface and the occluder. The default value (-1) indicates no limit.

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

USDLUX_API UsdAttribute UsdLuxShadowAPI::GetShadowEnableAttr

(

)

const

Enables shadows to be cast by this light.

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

USDLUX_API UsdAttribute UsdLuxShadowAPI::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. The falloff zone is the area that fades from full shadowing at the beginning of the falloff zone to no shadowing at the max distance from the occluder. The falloff zone distance cannot exceed the shadow max distance. A falloff value equal to or less than zero (with -1 as the default) indicates no falloff.

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

USDLUX_API UsdAttribute UsdLuxShadowAPI::GetShadowFalloffGammaAttr

(

)

const

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

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

Friends And Related Function Documentation

friend class UsdSchemaRegistry

friend

Definition at line 159 of file shadowAPI.h.

Member Data Documentation

const UsdSchemaKind UsdLuxShadowAPI::schemaKind = UsdSchemaKind::SingleApplyAPI

static

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

See Also

UsdSchemaKind

Definition at line 67 of file shadowAPI.h.

---

The documentation for this class was generated from the following file:

• pxr/usd/usdLux/shadowAPI.h