HDK
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
usdKarmaLightSettingsAPI Class Reference

#include <lightSettingsAPI.h>

+ Inheritance diagram for usdKarmaLightSettingsAPI:

Public Member Functions

 usdKarmaLightSettingsAPI (const UsdPrim &prim=UsdPrim())
 
 usdKarmaLightSettingsAPI (const UsdSchemaBase &schemaObj)
 
virtual USDKARMA_API ~usdKarmaLightSettingsAPI () override
 Destructor. More...
 
USDKARMA_API UsdAttribute GetKarmaLightActiveradiusAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightActiveradiusAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightCategoryAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightCategoryAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightForce_uniform_samplingAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightForce_uniform_samplingAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightHdri_max_isizeAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightHdri_max_isizeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightLightgeocastsshadowAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightLightgeocastsshadowAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightLpetagAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightLpetagAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightMisbiasAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightMisbiasAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightRenderlightgeoAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightRenderlightgeoAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightSamplingqualityAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightSamplingqualityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightShaderAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightShaderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightShadowtracesetAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightShadowtracesetAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDKARMA_API UsdAttribute GetKarmaLightSinglesidedAttr () const
 
USDKARMA_API UsdAttribute CreateKarmaLightSinglesidedAttr (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 USDKARMA_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDKARMA_API
usdKarmaLightSettingsAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDKARMA_API
usdKarmaLightSettingsAPI 
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

USDKARMA_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdAPISchemaBase
USD_API UsdSchemaType _GetSchemaType () const override
 
 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

Definition at line 56 of file lightSettingsAPI.h.

Constructor & Destructor Documentation

usdKarmaLightSettingsAPI::usdKarmaLightSettingsAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a usdKarmaLightSettingsAPI on UsdPrim prim . Equivalent to usdKarmaLightSettingsAPI::Get(prim.GetStage(), prim.GetPath()) for a valid prim, but will not immediately throw an error for an invalid prim

Definition at line 68 of file lightSettingsAPI.h.

usdKarmaLightSettingsAPI::usdKarmaLightSettingsAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a usdKarmaLightSettingsAPI on the prim held by schemaObj . Should be preferred over usdKarmaLightSettingsAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 76 of file lightSettingsAPI.h.

usdKarmaLightSettingsAPI::~usdKarmaLightSettingsAPI ( )
overridevirtual

Destructor.

Definition at line 43 of file lightSettingsAPI.cpp.

Member Function Documentation

UsdSchemaType usdKarmaLightSettingsAPI::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdSchemaBase.

Definition at line 60 of file lightSettingsAPI.cpp.

usdKarmaLightSettingsAPI usdKarmaLightSettingsAPI::Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim. This information is stored by adding "KarmaLightSettingsAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid usdKarmaLightSettingsAPI object is returned upon success. An invalid (or empty) usdKarmaLightSettingsAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()

Definition at line 66 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightActiveradiusAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightActiveradiusAttr(), 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.

Definition at line 104 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightCategoryAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightCategoryAttr(), 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.

Definition at line 121 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightForce_uniform_samplingAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightForce_uniform_samplingAttr(), 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.

Definition at line 138 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightHdri_max_isizeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightHdri_max_isizeAttr(), 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.

Definition at line 155 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightLightgeocastsshadowAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightLightgeocastsshadowAttr(), 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.

Definition at line 172 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightLpetagAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightLpetagAttr(), 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.

Definition at line 189 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightMisbiasAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightMisbiasAttr(), 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.

Definition at line 206 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightRenderlightgeoAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightRenderlightgeoAttr(), 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.

Definition at line 223 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightSamplingqualityAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightSamplingqualityAttr(), 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.

Definition at line 240 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightShaderAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightShaderAttr(), 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.

Definition at line 257 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightShadowtracesetAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightShadowtracesetAttr(), 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.

Definition at line 274 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::CreateKarmaLightSinglesidedAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetKarmaLightSinglesidedAttr(), 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.

Definition at line 291 of file lightSettingsAPI.cpp.

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

Return a usdKarmaLightSettingsAPI 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:

usdKarmaLightSettingsAPI(stage->GetPrimAtPath(path));

Definition at line 49 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightActiveradiusAttr ( ) const

Outside this radius, the light will have no effect.

Declaration float karma:light:activeradius = -1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 98 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightCategoryAttr ( ) const

The category identifier used to select this light source for illumination.

Declaration string karma:light:category = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 115 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightForce_uniform_samplingAttr ( ) const

When using the light tree for rendering, Karma will try to put any light source that's compatible into the tree. This option can force a light to be excluded from the tree and subject to uniform sampling, which can sometimes yield an improved sampling quality the light at the expense of speed.

Declaration bool karma:light:force_uniform_sampling = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 132 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightHdri_max_isizeAttr ( ) const

If an environment map is larger than this resolution, it will be scaled down when performing texture analysis. If the map has some very small, very bright values, this filtering may affect how sampling of the environment map is performed.

Declaration int karma:light:hdri_max_isize = 2048
C++ Type int
Usd Type SdfValueTypeNames->Int

Definition at line 149 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightLightgeocastsshadowAttr ( ) const

Causes the light source geometry to cast shadows in the render.

Declaration bool karma:light:lightgeocastsshadow = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 166 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightLpetagAttr ( ) const

Custom label assigned to lights or objects for use with light path expression.

Declaration string karma:light:lpetag = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 183 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightMisbiasAttr ( ) const

Controls whether multiple importance sampling will sample from the BSDF, the light, or both the BSDF and light.

Declaration float karma:light:misbias = 0
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 200 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightRenderlightgeoAttr ( ) const

Causes the light source geometry to be visible in the render.

Declaration bool karma:light:renderlightgeo = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 217 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightSamplingqualityAttr ( ) const

This is the per-light sampling quality. Increasing the quality will add additional samples for this light source, improving the sampling quality of this light relative to other light sources.

Declaration float karma:light:samplingquality = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Definition at line 234 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightShaderAttr ( ) const

Defines a VEX shader to be used for light evaluation. If the string is empty, the value will be taken from the HOUDINI_VEX_DEFAULT_LIGHTSURFACE configuration variable.

Declaration string karma:light:shader = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 251 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightShadowtracesetAttr ( ) const

The trace-set of geometry which act as occluders for this light source.

Declaration string karma:light:shadowtraceset = ""
C++ Type std::string
Usd Type SdfValueTypeNames->String

Definition at line 268 of file lightSettingsAPI.cpp.

UsdAttribute usdKarmaLightSettingsAPI::GetKarmaLightSinglesidedAttr ( ) const

Does the light emit light from a single side (ie along the normal) or from both sides? This only has effect on planar area light types.

Declaration bool karma:light:singlesided = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool

Definition at line 285 of file lightSettingsAPI.cpp.

const TfTokenVector & usdKarmaLightSettingsAPI::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.

Definition at line 315 of file lightSettingsAPI.cpp.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 133 of file lightSettingsAPI.h.

Member Data Documentation

const UsdSchemaType usdKarmaLightSettingsAPI::schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 62 of file lightSettingsAPI.h.


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