HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
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
 
- 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
 
UsdSchemaType GetSchemaType () const
 
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
 

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 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 TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDLUX_API UsdSchemaType _GetSchemaType () 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
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
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 

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 58 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 70 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 78 of file shadowAPI.h.

virtual USDLUX_API UsdLuxShadowAPI::~UsdLuxShadowAPI ( )
virtual

Destructor.

Member Function Documentation

USDLUX_API UsdSchemaType UsdLuxShadowAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

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::ApplyAPI()
UsdPrim::RemoveAPI()
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));
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 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 default value (-1) indicates no limit.

Declaration float 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 shadow:enable = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDLUX_API UsdAttribute UsdLuxShadowAPI::GetShadowFalloffAttr ( ) const

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

Declaration float 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 requires the use of shadowDistance and shadowFalloff.

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

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 135 of file shadowAPI.h.

Member Data Documentation

const UsdSchemaType UsdLuxShadowAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 64 of file shadowAPI.h.


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