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

#include <pxrCookieLightFilter.h>

+ Inheritance diagram for UsdRiPxrCookieLightFilter:

Public Member Functions

 UsdRiPxrCookieLightFilter (const UsdPrim &prim=UsdPrim())
 
 UsdRiPxrCookieLightFilter (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiPxrCookieLightFilter ()
 Destructor. More...
 
USDRI_API UsdAttribute GetCookieModeAttr () const
 
USDRI_API UsdAttribute CreateCookieModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetWidthAttr () const
 
USDRI_API UsdAttribute CreateWidthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetHeightAttr () const
 
USDRI_API UsdAttribute CreateHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureMapAttr () const
 
USDRI_API UsdAttribute CreateTextureMapAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureWrapModeAttr () const
 
USDRI_API UsdAttribute CreateTextureWrapModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureFillColorAttr () const
 
USDRI_API UsdAttribute CreateTextureFillColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTexturePremultipliedAlphaAttr () const
 
USDRI_API UsdAttribute CreateTexturePremultipliedAlphaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureInvertUAttr () const
 
USDRI_API UsdAttribute CreateTextureInvertUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureInvertVAttr () const
 
USDRI_API UsdAttribute CreateTextureInvertVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureScaleUAttr () const
 
USDRI_API UsdAttribute CreateTextureScaleUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureScaleVAttr () const
 
USDRI_API UsdAttribute CreateTextureScaleVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureOffsetUAttr () const
 
USDRI_API UsdAttribute CreateTextureOffsetUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetTextureOffsetVAttr () const
 
USDRI_API UsdAttribute CreateTextureOffsetVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDirectionalAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDirectionalAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticShearXAttr () const
 
USDRI_API UsdAttribute CreateAnalyticShearXAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticShearYAttr () const
 
USDRI_API UsdAttribute CreateAnalyticShearYAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticApexAttr () const
 
USDRI_API UsdAttribute CreateAnalyticApexAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticUseLightDirectionAttr () const
 
USDRI_API UsdAttribute CreateAnalyticUseLightDirectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurAmountAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurAmountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurSMultAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurSMultAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurTMultAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurTMultAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurNearDistanceAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurNearDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurMidpointAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurFarDistanceAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurFarDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurNearValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurNearValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurMidValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurMidValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurFarValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurFarValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticBlurExponentAttr () const
 
USDRI_API UsdAttribute CreateAnalyticBlurExponentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityNearDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityMidpointAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityFarDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityNearValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityMidValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityMidValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityFarValueAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityFarValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetAnalyticDensityExponentAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityExponentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorSaturationAttr () const
 
USDRI_API UsdAttribute CreateColorSaturationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorMidpointAttr () const
 
USDRI_API UsdAttribute CreateColorMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorContrastAttr () const
 
USDRI_API UsdAttribute CreateColorContrastAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorWhitepointAttr () const
 
USDRI_API UsdAttribute CreateColorWhitepointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorTintAttr () const
 
USDRI_API UsdAttribute CreateColorTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
- Public Member Functions inherited from UsdLuxLightFilter
 UsdLuxLightFilter (const UsdPrim &prim=UsdPrim())
 
 UsdLuxLightFilter (const UsdSchemaBase &schemaObj)
 
virtual USDLUX_API ~UsdLuxLightFilter ()
 Destructor. More...
 
USDLUX_API UsdCollectionAPI GetFilterLinkCollectionAPI () const
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 
USDGEOM_API bool GetResetXformStack () const
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API PurposeInfo ComputePurposeInfo () const
 
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
 
USDGEOM_API TfToken ComputePurpose () const
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
 
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API UsdGeomPrimvar CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
USDGEOM_API UsdGeomPrimvar GetPrimvar (const TfToken &name) const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetPrimvars () const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetAuthoredPrimvars () const
 
USDGEOM_API bool HasPrimvar (const TfToken &name) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- 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 USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API
UsdRiPxrCookieLightFilter 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API
UsdRiPxrCookieLightFilter 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdLuxLightFilter
static USDLUX_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDLUX_API UsdLuxLightFilter Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDLUX_API UsdLuxLightFilter Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdLuxLightFilter
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 
- Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
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
 

Detailed Description

Deprecated:
This schema will be replaced in a future release. A textured surface that filters light.

For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRiTokens. So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded as the value.

Definition at line 65 of file pxrCookieLightFilter.h.

Constructor & Destructor Documentation

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

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

Definition at line 77 of file pxrCookieLightFilter.h.

UsdRiPxrCookieLightFilter::UsdRiPxrCookieLightFilter ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 85 of file pxrCookieLightFilter.h.

virtual USDRI_API UsdRiPxrCookieLightFilter::~UsdRiPxrCookieLightFilter ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiPxrCookieLightFilter::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdLuxLightFilter.

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticApexAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurAmountAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurExponentAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurFarDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurFarValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurMidpointAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurMidValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurNearDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurNearValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurSMultAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticBlurTMultAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityExponentAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityFarDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityFarValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityMidpointAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityMidValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityNearDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDensityNearValueAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticDirectionalAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticShearXAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticShearYAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateAnalyticUseLightDirectionAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateColorContrastAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateColorMidpointAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateColorSaturationAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateColorTintAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateColorWhitepointAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateCookieModeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateHeightAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureFillColorAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureInvertUAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureInvertVAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureMapAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureOffsetUAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureOffsetVAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTexturePremultipliedAlphaAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureScaleUAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureScaleVAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateTextureWrapModeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::CreateWidthAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetWidthAttr(), 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 USDRI_API UsdRiPxrCookieLightFilter UsdRiPxrCookieLightFilter::Define ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage.

If a prim adhering to this schema at path is already defined on this stage, return that prim. Otherwise author an SdfPrimSpec with specifier == SdfSpecifierDef and this schema's prim type name for the prim at path at the current EditTarget. Author SdfPrimSpec s with specifier == SdfSpecifierDef and empty typeName at the current EditTarget for any nonexistent, or existing but not Defined ancestors.

The given path must be an absolute prim path that does not contain any variant selections.

If it is impossible to author any of the necessary PrimSpecs, (for example, in case path cannot map to the current UsdEditTarget's namespace) issue an error and return an invalid UsdPrim.

Note that this method may return a defined prim whose typeName does not specify this schema class, in case a stronger typeName opinion overrides the opinion at the current EditTarget.

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

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

UsdRiPxrCookieLightFilter(stage->GetPrimAtPath(path));
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticApexAttr ( ) const

Distance between the center of cookie and the center of projection.

Declaration float analytic:apex = 25
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurAmountAttr ( ) const

Specify the blur of projected texture from 0-1. This gets multiplied by the blurNear/blurFar interpolation. This blurs between the projected color and the fill color when the texture is not repeating.

Declaration float analytic:blur:amount = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurExponentAttr ( ) const

Power exponent of the blur interpolation.

Declaration float analytic:blur:exponent = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurFarDistanceAttr ( ) const

Distance from the cookie where the blur interpolation ends.

Declaration float analytic:blur:farDistance = 10
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurFarValueAttr ( ) const

Blur multiplier at the end of interpolation.

Declaration float analytic:blur:farValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurMidpointAttr ( ) const

Distance between near and far where midValue is located.

Declaration float analytic:blur:midpoint = 0.5
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurMidValueAttr ( ) const

Blur multiplier in the middle of interpolation.

Declaration float analytic:blur:midValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurNearDistanceAttr ( ) const

Distance from the cookie where the blur interpolation starts.

Declaration float analytic:blur:nearDistance = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurNearValueAttr ( ) const

Blur multiplier where the blur interpolation starts.

Declaration float analytic:blur:nearValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurSMultAttr ( ) const

Blur multiplier in the S direction.

Declaration float analytic:blur:sMult = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticBlurTMultAttr ( ) const

Blur multiplier in the T direction.

Declaration float analytic:blur:tMult = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityExponentAttr ( ) const

Power exponent of the density interpolation.

Declaration float analytic:density:exponent = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityFarDistanceAttr ( ) const

Distance from the cookie where the density interpolation ends.

Declaration float analytic:density:farDistance = 10
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityFarValueAttr ( ) const

Density multiplier at the end of interpolation.

Declaration float analytic:density:farValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityMidpointAttr ( ) const

Distance between near and far where midValue is located.

Declaration float analytic:density:midpoint = 0.5
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityMidValueAttr ( ) const

Density multiplier in the middle of interpolation.

Declaration float analytic:density:midValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityNearDistanceAttr ( ) const

Distance from the cookie where the density interpolation starts.

Declaration float analytic:density:nearDistance = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDensityNearValueAttr ( ) const

Density multiplier where the density interpolation starts.

Declaration float analytic:density:nearValue = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticDirectionalAttr ( ) const

When this is on, the texture projects along a direction using the orthographic projection. When it is off, the texture projects using a focal point specified by the analytic:apex.

Declaration bool analytic:directional = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticShearXAttr ( ) const

Shear the projection along the X axis.

Declaration float analytic:shearX = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticShearYAttr ( ) const

Shear the projection along the Y axis.

Declaration float analytic:shearY = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetAnalyticUseLightDirectionAttr ( ) const

When this is on, If this is on, the projection direction is determined by the position of the center of the light source. Otherwise, it only follows the orientation of the filter. WARNING: This does not work with dome and mesh lights.

Declaration bool analytic:useLightDirection = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetColorContrastAttr ( ) const

Contrast control (less than 1 = contrast reduction, larger than 1 = contrast increase).

Declaration float color:contrast = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetColorMidpointAttr ( ) const

Midpoint for the contrast control.

Declaration float color:midpoint = 0.18
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetColorSaturationAttr ( ) const

Saturation of the result (0=greyscale, 1=normal, >1=boosted colors).

Declaration float color:saturation = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetColorTintAttr ( ) const

Tint of the resulting color after saturation, contrast and clamp.

Declaration color3f color:tint = (1, 1, 1)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Color3f
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetColorWhitepointAttr ( ) const

White point for the contrast control if (contrast > 1.0).

Declaration float color:whitepoint = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetCookieModeAttr ( ) const

Chooses a physical or analytic evaluation model for the cookie:

  • physical: The cookie behaves like a stained glass window through which light falls. The falloff and blur are determined by the size of the light, the distance to the light and distance from the cookie.
  • analytic: The cookie has a fixed projection and manual blur and falloff controls.
Declaration token cookieMode = "physical"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values physical, analytic
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetHeightAttr ( ) const

Height of the rect the light is shining through.

Declaration float height = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
static USDRI_API const TfTokenVector& UsdRiPxrCookieLightFilter::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.

USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureFillColorAttr ( ) const

If the texture is not repeating, this specifies the color for the region outside of and behind the projected rectangle.

Declaration color3f texture:fillColor = (1, 1, 1)
C++ Type GfVec3f
Usd Type SdfValueTypeNames->Color3f
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureInvertUAttr ( ) const

Flips the texture from left to right. By default, the orientation of the texture as seen from the light source matches the orientation as it is viewed in an image viewer.

Declaration bool texture:invertU = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureInvertVAttr ( ) const

Flips the texture from top to bottom. By default, the orientation of the texture as seen from the light source matches the orientation as it is viewed in an image viewer.

Declaration bool texture:invertV = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureMapAttr ( ) const

A color texture to use on the cookie. May use alpha.

Declaration asset texture:map
C++ Type SdfAssetPath
Usd Type SdfValueTypeNames->Asset
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureOffsetUAttr ( ) const

Offsets the texture in the U direction.

Declaration float texture:offsetU = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureOffsetVAttr ( ) const

Offsets the texture in the V direction.

Declaration float texture:offsetV = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTexturePremultipliedAlphaAttr ( ) const

Textures are usually premultiplied by their alpha. If this not the case, uncheck this.

Declaration bool texture:premultipliedAlpha = 1
C++ Type bool
Usd Type SdfValueTypeNames->Bool
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureScaleUAttr ( ) const

Scales the U dimension.

Declaration float texture:scaleU = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureScaleVAttr ( ) const

Scales the V dimension.

Declaration float texture:scaleV = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetTextureWrapModeAttr ( ) const

Specifies what value to use outside the texture's domain:

  • off: no repeat
  • repeat: repeats in X and Y
  • clamp: uses the value from the nearest edge
Declaration token texture:wrapMode = "off"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values off, repeat, clamp
USDRI_API UsdAttribute UsdRiPxrCookieLightFilter::GetWidthAttr ( ) const

Width of the rect the light is shining through.

Declaration float width = 1
C++ Type float
Usd Type SdfValueTypeNames->Float

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 149 of file pxrCookieLightFilter.h.

Member Data Documentation

const UsdSchemaType UsdRiPxrCookieLightFilter::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 71 of file pxrCookieLightFilter.h.


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