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

#include <pxrBarnLightFilter.h>

+ Inheritance diagram for UsdRiPxrBarnLightFilter:

Public Member Functions

 UsdRiPxrBarnLightFilter (const UsdPrim &prim=UsdPrim())
 
 UsdRiPxrBarnLightFilter (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiPxrBarnLightFilter ()
 Destructor. More...
 
USDRI_API UsdAttribute GetBarnModeAttr () const
 
USDRI_API UsdAttribute CreateBarnModeAttr (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 GetRadiusAttr () const
 
USDRI_API UsdAttribute CreateRadiusAttr (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 GetAnalyticDensityNearDistanceAttr () const
 
USDRI_API UsdAttribute CreateAnalyticDensityNearDistanceAttr (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 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 GetEdgeThicknessAttr () const
 
USDRI_API UsdAttribute CreateEdgeThicknessAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetPreBarnEffectAttr () const
 
USDRI_API UsdAttribute CreatePreBarnEffectAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetScaleWidthAttr () const
 
USDRI_API UsdAttribute CreateScaleWidthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetScaleHeightAttr () const
 
USDRI_API UsdAttribute CreateScaleHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetRefineTopAttr () const
 
USDRI_API UsdAttribute CreateRefineTopAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetRefineBottomAttr () const
 
USDRI_API UsdAttribute CreateRefineBottomAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetRefineLeftAttr () const
 
USDRI_API UsdAttribute CreateRefineLeftAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetRefineRightAttr () const
 
USDRI_API UsdAttribute CreateRefineRightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetEdgeScaleTopAttr () const
 
USDRI_API UsdAttribute CreateEdgeScaleTopAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetEdgeScaleBottomAttr () const
 
USDRI_API UsdAttribute CreateEdgeScaleBottomAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetEdgeScaleLeftAttr () const
 
USDRI_API UsdAttribute CreateEdgeScaleLeftAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetEdgeScaleRightAttr () const
 
USDRI_API UsdAttribute CreateEdgeScaleRightAttr (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
UsdRiPxrBarnLightFilter 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API
UsdRiPxrBarnLightFilter 
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. Simulated geometric barn doors that control the spread of 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 pxrBarnLightFilter.h.

Constructor & Destructor Documentation

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

Construct a UsdRiPxrBarnLightFilter on UsdPrim prim . Equivalent to UsdRiPxrBarnLightFilter::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 pxrBarnLightFilter.h.

UsdRiPxrBarnLightFilter::UsdRiPxrBarnLightFilter ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 85 of file pxrBarnLightFilter.h.

virtual USDRI_API UsdRiPxrBarnLightFilter::~UsdRiPxrBarnLightFilter ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiPxrBarnLightFilter::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdLuxLightFilter.

USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::CreateBarnModeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetBarnModeAttr(), 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 UsdRiPxrBarnLightFilter::CreateEdgeScaleBottomAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEdgeScaleBottomAttr(), 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 UsdRiPxrBarnLightFilter::CreateEdgeScaleLeftAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEdgeScaleLeftAttr(), 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 UsdRiPxrBarnLightFilter::CreateEdgeScaleRightAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEdgeScaleRightAttr(), 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 UsdRiPxrBarnLightFilter::CreateEdgeScaleTopAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEdgeScaleTopAttr(), 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 UsdRiPxrBarnLightFilter::CreateEdgeThicknessAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEdgeThicknessAttr(), 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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::CreatePreBarnEffectAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetPreBarnEffectAttr(), 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 UsdRiPxrBarnLightFilter::CreateRadiusAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRadiusAttr(), 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 UsdRiPxrBarnLightFilter::CreateRefineBottomAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRefineBottomAttr(), 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 UsdRiPxrBarnLightFilter::CreateRefineLeftAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRefineLeftAttr(), 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 UsdRiPxrBarnLightFilter::CreateRefineRightAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRefineRightAttr(), 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 UsdRiPxrBarnLightFilter::CreateRefineTopAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRefineTopAttr(), 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 UsdRiPxrBarnLightFilter::CreateScaleHeightAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetScaleHeightAttr(), 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 UsdRiPxrBarnLightFilter::CreateScaleWidthAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetScaleWidthAttr(), 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 UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter UsdRiPxrBarnLightFilter::Get ( const UsdStagePtr &  stage,
const SdfPath path 
)
static

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

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

Shear the projection along the Y axis.

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

Power exponent of the density interpolation.

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

Distance from the barn where the density interpolation ends.

Declaration float analytic:density:farDistance = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::GetAnalyticDensityNearDistanceAttr ( ) const

Distance from the barn where the density interpolation starts.

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

Density multiplier where the density interpolation starts.

Declaration float analytic:density:nearValue = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::GetAnalyticShearXAttr ( ) const

Shear the projection along the X axis.

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

Shear the projection along the Y axis.

Declaration float analytic:shearY = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::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 barn. 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 UsdRiPxrBarnLightFilter::GetBarnModeAttr ( ) const

Chooses a physical or analytic evaluation model for the barn.

Declaration token barnMode = "physical"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values physical, analytic
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetEdgeScaleBottomAttr ( ) const

Additional edge scale adjustment to the top region.

Declaration float edgeScale:bottom = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetEdgeScaleLeftAttr ( ) const

Additional edge scale adjustment to the left region.

Declaration float edgeScale:left = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetEdgeScaleRightAttr ( ) const

Additional edge scale adjustment to the left region.

Declaration float edgeScale:right = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetEdgeScaleTopAttr ( ) const

Additional edge scale adjustment to the top region.

Declaration float edgeScale:top = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetEdgeThicknessAttr ( ) const

Thickness of the edge region. Larger values will soften the edge shape.

Declaration float edgeThickness = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetHeightAttr ( ) const

Height of the inner region of the barn (Y axis).

Declaration float height = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetPreBarnEffectAttr ( ) const

The effect on light before it reaches the barn geometry.

Declaration token preBarnEffect = "noLight"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values noEffect, cone, noLight
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetRadiusAttr ( ) const

Radius of the corners of the inner barn square.

Declaration float radius = 0.5
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetRefineBottomAttr ( ) const

Additional offset adjustment to the top region.

Declaration float refine:bottom = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetRefineLeftAttr ( ) const

Additional offset adjustment to the left region.

Declaration float refine:left = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetRefineRightAttr ( ) const

Additional offset adjustment to the left region.

Declaration float refine:right = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetRefineTopAttr ( ) const

Additional offset adjustment to the top region.

Declaration float refine:top = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetScaleHeightAttr ( ) const

Scale the height of the inner barn shape.

Declaration float scale:height = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrBarnLightFilter::GetScaleWidthAttr ( ) const

Scale the width of the inner barn shape.

Declaration float scale:width = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
static USDRI_API const TfTokenVector& UsdRiPxrBarnLightFilter::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 UsdRiPxrBarnLightFilter::GetWidthAttr ( ) const

Width of the inner region of the barn (X axis).

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 pxrBarnLightFilter.h.

Member Data Documentation

const UsdSchemaType UsdRiPxrBarnLightFilter::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 71 of file pxrBarnLightFilter.h.


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