UsdLuxShadowAPI Class Reference

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

+ Inheritance diagram for UsdLuxShadowAPI:

Public Member Functions

 UsdLuxShadowAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdLuxShadowAPI on UsdPrim prim . More...
 
 UsdLuxShadowAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdLuxShadowAPI on the prim held by schemaObj . More...
 
virtual USDLUX_API ~UsdLuxShadowAPI ()
 Destructor. More...
 
USDLUX_API UsdAttribute GetShadowEnableAttr () const
 Enables shadows to be cast by this light. More...
 
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. More...
 
USDLUX_API UsdAttribute GetShadowColorAttr () const
 The color of shadows cast by the light. More...
 
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. More...
 
USDLUX_API UsdAttribute GetShadowDistanceAttr () const
 The maximum distance shadows are cast. More...
 
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. More...
 
USDLUX_API UsdAttribute GetShadowFalloffAttr () const
 The near distance at which shadow falloff begins. More...
 
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. More...
 
USDLUX_API UsdAttribute GetShadowFalloffGammaAttr () const
 A gamma (i.e., exponential) control over shadow strength with linear distance within the falloff zone. More...
 
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. More...
 
Conversion to and from UsdShadeConnectableAPI
USDLUX_API UsdLuxShadowAPI (const UsdShadeConnectableAPI &connectable)
 Constructor that takes a ConnectableAPI object. More...
 
USDLUX_API UsdShadeConnectableAPI ConnectableAPI () const
 Contructs and returns a UsdShadeConnectableAPI object with this shadow API prim. More...
 
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. More...
 
USDLUX_API UsdShadeOutput GetOutput (const TfToken &name) const
 Return the requested output if it exists. More...
 
USDLUX_API std::vector< UsdShadeOutputGetOutputs (bool onlyAuthored=true) const
 Outputs are represented by attributes in the "outputs:" namespace. More...
 
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. More...
 
USDLUX_API UsdShadeInput GetInput (const TfToken &name) const
 Return the requested input if it exists. More...
 
USDLUX_API std::vector< UsdShadeInputGetInputs (bool onlyAuthored=true) const
 Inputs are represented by attributes in the "inputs:" namespace. More...
 
- Public Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim . More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj . More...
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. More...
 
- 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. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
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 UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDLUX_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
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. More...
 
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. More...
 
static USDLUX_API UsdLuxShadowAPI Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_API const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

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

Protected Member Functions

USDLUX_API UsdSchemaKind _GetSchemaKind () const override
 Returns the kind of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName. More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName. More...
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema. More...
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held. More...
 
- 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. More...
 

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() [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 73 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 81 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.

◆ CreateShadowColorAttr()

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.

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.

◆ CreateShadowDistanceAttr()

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.

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.

◆ CreateShadowEnableAttr()

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.

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.

◆ CreateShadowFalloffAttr()

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.

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.

◆ CreateShadowFalloffGammaAttr()

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.

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.

◆ Get()

static USDLUX_API 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));

◆ GetInput()

USDLUX_API UsdShadeInput GetInput ( const TfToken name) const

Return the requested input if it exists.

◆ GetInputs()

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

◆ GetOutput()

USDLUX_API UsdShadeOutput GetOutput ( const TfToken name) const

Return the requested output if it exists.

◆ GetOutputs()

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

◆ GetSchemaAttributeNames()

static USDLUX_API const TfTokenVector& 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.

◆ GetShadowColorAttr()

USDLUX_API 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

◆ GetShadowDistanceAttr()

USDLUX_API 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

◆ GetShadowEnableAttr()

USDLUX_API UsdAttribute GetShadowEnableAttr ( ) const

Enables shadows to be cast by this light.

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

◆ GetShadowFalloffAttr()

USDLUX_API 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

◆ GetShadowFalloffGammaAttr()

USDLUX_API 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

Member Data Documentation

◆ schemaKind

const UsdSchemaKind 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: