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

A textured surface that filters light. More...

+ Inheritance diagram for UsdRiPxrCookieLightFilter:

Public Member Functions

 UsdRiPxrCookieLightFilter (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiPxrCookieLightFilter on UsdPrim prim . More...
 
 UsdRiPxrCookieLightFilter (const UsdSchemaBase &schemaObj)
 Construct a UsdRiPxrCookieLightFilter on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiPxrCookieLightFilter ()
 Destructor. More...
 
USDRI_API UsdAttribute GetCookieModeAttr () const
 Chooses a physical or analytic evaluation model for the cookie: More...
 
USDRI_API UsdAttribute CreateCookieModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetCookieModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetWidthAttr () const
 Width of the rect the light is shining through. More...
 
USDRI_API UsdAttribute CreateWidthAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetHeightAttr () const
 Height of the rect the light is shining through. More...
 
USDRI_API UsdAttribute CreateHeightAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureMapAttr () const
 A color texture to use on the cookie. More...
 
USDRI_API UsdAttribute CreateTextureMapAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureMapAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureWrapModeAttr () const
 Specifies what value to use outside the texture's domain: More...
 
USDRI_API UsdAttribute CreateTextureWrapModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureWrapModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureFillColorAttr () const
 If the texture is not repeating, this specifies the color for the region outside of and behind the projected rectangle. More...
 
USDRI_API UsdAttribute CreateTextureFillColorAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureFillColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureInvertUAttr () const
 Flips the texture from left to right. More...
 
USDRI_API UsdAttribute CreateTextureInvertUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureInvertUAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureInvertVAttr () const
 Flips the texture from top to bottom. More...
 
USDRI_API UsdAttribute CreateTextureInvertVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureInvertVAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureScaleUAttr () const
 Scales the U dimension. More...
 
USDRI_API UsdAttribute CreateTextureScaleUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureScaleUAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureScaleVAttr () const
 Scales the V dimension. More...
 
USDRI_API UsdAttribute CreateTextureScaleVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureScaleVAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureOffsetUAttr () const
 Offsets the texture in the U direction. More...
 
USDRI_API UsdAttribute CreateTextureOffsetUAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureOffsetUAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetTextureOffsetVAttr () const
 Offsets the texture in the V direction. More...
 
USDRI_API UsdAttribute CreateTextureOffsetVAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetTextureOffsetVAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDirectionalAttr () const
 When this is on, the texture projects along a direction using the orthographic projection. More...
 
USDRI_API UsdAttribute CreateAnalyticDirectionalAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDirectionalAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticShearXAttr () const
 Shear the projection along the X axis. More...
 
USDRI_API UsdAttribute CreateAnalyticShearXAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticShearXAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticShearYAttr () const
 Shear the projection along the Y axis. More...
 
USDRI_API UsdAttribute CreateAnalyticShearYAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticShearYAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticApexAttr () const
 Shear the projection along the Y axis. More...
 
USDRI_API UsdAttribute CreateAnalyticApexAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticApexAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute 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. More...
 
USDRI_API UsdAttribute CreateAnalyticUseLightDirectionAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticUseLightDirectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurAmountAttr () const
 Specify the blur of projected texture from 0-1. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurAmountAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurAmountAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurSMultAttr () const
 Blur multiplier in the S direction. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurSMultAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurSMultAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurTMultAttr () const
 Blur multiplier in the T direction. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurTMultAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurTMultAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurNearDistanceAttr () const
 Distance from the cookie where the blur interpolation starts. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurNearDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurNearDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurMidpointAttr () const
 Distance between near and far where midValue is located. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurFarDistanceAttr () const
 Distance from the cookie where the blur interpolation ends. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurFarDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurFarDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurNearValueAttr () const
 Blur multiplier where the blur interpolation starts. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurNearValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurNearValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurMidValueAttr () const
 Blur multiplier in the middle of interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurMidValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurMidValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurFarValueAttr () const
 Blur multiplier at the end of interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurFarValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurFarValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticBlurExponentAttr () const
 Power exponent of the blur interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticBlurExponentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticBlurExponentAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr () const
 Distance from the cookie where the density interpolation starts. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityNearDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityNearDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityMidpointAttr () const
 Distance between near and far where midValue is located. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr () const
 Distance from the cookie where the density interpolation ends. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityFarDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityFarDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr () const
 Density multiplier where the density interpolation starts. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityNearValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityNearValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityMidValueAttr () const
 Density multiplier in the middle of interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityMidValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityMidValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityFarValueAttr () const
 Density multiplier at the end of interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityFarValueAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityFarValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetAnalyticDensityExponentAttr () const
 Power exponent of the density interpolation. More...
 
USDRI_API UsdAttribute CreateAnalyticDensityExponentAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetAnalyticDensityExponentAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetColorSaturationAttr () const
 Saturation of the result (0=greyscale, 1=normal, >1=boosted colors). More...
 
USDRI_API UsdAttribute CreateColorSaturationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetColorSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetColorMidpointAttr () const
 Midpoint for the contrast control. More...
 
USDRI_API UsdAttribute CreateColorMidpointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetColorMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetColorContrastAttr () const
 Contrast control (less than 1 = contrast reduction, larger than 1 = contrast increase). More...
 
USDRI_API UsdAttribute CreateColorContrastAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetColorContrastAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetColorWhitepointAttr () const
 White point for the contrast control if (contrast > 1.0). More...
 
USDRI_API UsdAttribute CreateColorWhitepointAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetColorWhitepointAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetColorTintAttr () const
 Tint of the resulting color after saturation, contrast and clamp. More...
 
USDRI_API UsdAttribute CreateColorTintAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetColorTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdLuxLightFilter
 UsdLuxLightFilter (const UsdPrim &prim=UsdPrim())
 Construct a UsdLuxLightFilter on UsdPrim prim . More...
 
 UsdLuxLightFilter (const UsdSchemaBase &schemaObj)
 Construct a UsdLuxLightFilter on the prim held by schemaObj . More...
 
virtual USDLUX_API ~UsdLuxLightFilter ()
 Destructor. More...
 
USDLUX_API UsdCollectionAPI GetFilterLinkCollectionAPI () const
 Return the UsdCollectionAPI interface used for examining and modifying the filter-linking of this light filter. More...
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 Construct a UsdGeomXformable on UsdPrim prim . More...
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 Construct a UsdGeomXformable on the prim held by schemaObj . More...
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 Encodes the sequence of transformation operations in the order in which they should be pushed onto a transform stack while visiting a UsdStage's prims in a graph traversal that will effect the desired positioning for this prim and its descendant prims. More...
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetXformOpOrderAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add an affine transformation to the local stack represented by this Xformable. More...
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a translate operation to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a scale operation to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation about the X-axis to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation about the YX-axis to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation about the Z-axis to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with XYZ rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with XZY rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with YXZ rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with YZX rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with ZXY rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a rotation op with ZYX rotation order to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a orient op (arbitrary axis/angle rotation) to the local stack represented by this xformable. More...
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 Add a tranform op (4x4 matrix transformation) to the local stack represented by this xformable. More...
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 Specify whether this prim's transform should reset the transformation stack inherited from its parent prim. More...
 
USDGEOM_API bool GetResetXformStack () const
 Does this prim reset its parent's inherited transformation? More...
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 Reorder the already-existing transform ops on this prim. More...
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 Return the ordered list of transform operations to be applied to this prim, in least-to-most-local order. More...
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 Clears the existing local transform stack and creates a new xform op of type 'transform'. More...
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 Determine whether there is any possibility that this prim's local transformation may vary over time. More...
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Determine whether there is any possibility that this prim's local transformation may vary over time, using a pre-fetched (cached) list of ordered xform ops supplied by the client. More...
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 Sets times to the union of all the timesamples at which xformOps that are included in the xformOpOrder attribute are authored. More...
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 Sets times to the union of all the timesamples in the interval, interval, at which xformOps that are included in the xformOpOrder attribute are authored. More...
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 Computes the fully-combined, local-to-parent transformation for this prim. More...
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Computes the fully-combined, local-to-parent transformation for this prim as efficiently as possible, using a pre-fetched (cached) list of ordered xform ops supplied by the client. More...
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 Construct a UsdGeomImageable on UsdPrim prim . More...
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 Construct a UsdGeomImageable on the prim held by schemaObj . More...
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 Visibility is meant to be the simplest form of "pruning" visibility that is supported by most DCC apps. More...
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetVisibilityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 Purpose is a concept we have found useful in our pipeline for classifying geometry into categories that can each be independently included or excluded from traversals of prims on a stage, such as rendering or bounding-box computation traversals. More...
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetPurposeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 The proxyPrim relationship allows us to link a prim whose purpose is "render" to its (single target) purpose="proxy" prim. More...
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 See GetProxyPrimRel(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 Make the imageable visible if it is invisible at the given time. More...
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 Makes the imageable invisible if it is visible at the given time. More...
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 Calculate the effective visibility of this prim, as defined by its most ancestral authored "invisible" opinion, if any. More...
 
USDGEOM_API TfToken ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective visibility of this prim, given the computed visibility of its parent prim at the given time. More...
 
USDGEOM_API TfToken ComputePurpose () const
 Calculate the effective purpose of this prim, as defined by its most ancestral authored non-"default" opinion, if any. More...
 
USDGEOM_API TfToken ComputePurpose (const TfToken &parentPurpose) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Calculates the effective purpose of this prim, given the computed purpose of its parent prim. More...
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 Find the prim whose purpose is proxy that serves as the proxy for this prim, as established by the GetProxyPrimRel(), or an invalid UsdPrim if this prim has no proxy. More...
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 Convenience function for authoring the renderProxy rel on this prim to target the given proxy prim. More...
 
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
 Compute the bound of this prim in world space, at the specified time, and for the specified purposes. More...
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 Compute the bound of this prim in local space, at the specified time, and for the specified purposes. More...
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 Compute the untransformed bound of this prim, at the specified time, and for the specified purposes. More...
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 Compute the transformation matrix for this prim at the given time, including the transform authored on the Prim itself, if present. More...
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 Compute the transformation matrix for this prim at the given time, NOT including the transform authored on the prim itself. More...
 
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())
 Construct a UsdTyped on UsdPrim prim . More...
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 Construct a UsdTyped on the prim wrapped by schemaObj . More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
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
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API SdfPrimSpecHandle GetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDRI_API
UsdRiPxrCookieLightFilter 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiPxrCookieLightFilter holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API
UsdRiPxrCookieLightFilter 
Define (const UsdStagePtr &stage, const SdfPath &path)
 Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More...
 
- Static Public Member Functions inherited from UsdLuxLightFilter
static USDLUX_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDLUX_API UsdLuxLightFilter Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdLuxLightFilter holding the prim adhering to this schema at path on stage. More...
 
static USDLUX_API UsdLuxLightFilter Define (const UsdStagePtr &stage, const SdfPath &path)
 Attempt to ensure a UsdPrim adhering to this schema at path is defined (according to UsdPrim::IsDefined()) on this stage. More...
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdGeomXformable holding the prim adhering to this schema at path on stage. More...
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 Returns the union of all the timesamples at which the attributes belonging to the given orderedXformOps are authored. More...
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 Returns the union of all the timesamples in the interval at which the attributes belonging to the given orderedXformOps are authored. More...
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. This is a static version of the preceding function that takes a cached list of ordered xform ops. More...
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 Returns true if the attribute named attrName could affect the local transformation of an xformable prim. More...
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdGeomImageable holding the prim adhering to this schema at path on stage. More...
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 Returns an ordered list of allowed values of the purpose attribute. More...
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdTyped holding the prim adhering to this schema at path on stage. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdLuxLightFilter
static const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdGeomXformable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdGeomImageable
static const UsdSchemaType schemaType = UsdSchemaType::AbstractTyped
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdTyped
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...
 
- 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

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 62 of file pxrCookieLightFilter.h.

Constructor & Destructor Documentation

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 74 of file pxrCookieLightFilter.h.

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 82 of file pxrCookieLightFilter.h.

virtual USDRI_API ~UsdRiPxrCookieLightFilter ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdLuxLightFilter.

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

See GetAnalyticApexAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurAmountAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurExponentAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurFarDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurFarValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurMidValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurNearDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurNearValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurSMultAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticBlurTMultAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityExponentAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityFarDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityFarValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityMidValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityNearDistanceAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDensityNearValueAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticDirectionalAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticShearXAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticShearYAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetAnalyticUseLightDirectionAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetColorContrastAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetColorMidpointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetColorSaturationAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetColorTintAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetColorWhitepointAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetCookieModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetHeightAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureFillColorAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureInvertUAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureInvertVAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureMapAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureOffsetUAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureOffsetVAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureScaleUAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureScaleVAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetTextureWrapModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

See GetWidthAttr(), and also Create vs Get Property Methods for when to use Get vs Create.

If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

static USDRI_API 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 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 GetAnalyticApexAttr ( ) const

Shear the projection along the Y axis.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute 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.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurExponentAttr ( ) const

Power exponent of the blur interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurFarDistanceAttr ( ) const

Distance from the cookie where the blur interpolation ends.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurFarValueAttr ( ) const

Blur multiplier at the end of interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurMidpointAttr ( ) const

Distance between near and far where midValue is located.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurMidValueAttr ( ) const

Blur multiplier in the middle of interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurNearDistanceAttr ( ) const

Distance from the cookie where the blur interpolation starts.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurNearValueAttr ( ) const

Blur multiplier where the blur interpolation starts.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurSMultAttr ( ) const

Blur multiplier in the S direction.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticBlurTMultAttr ( ) const

Blur multiplier in the T direction.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityExponentAttr ( ) const

Power exponent of the density interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr ( ) const

Distance from the cookie where the density interpolation ends.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityFarValueAttr ( ) const

Density multiplier at the end of interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityMidpointAttr ( ) const

Distance between near and far where midValue is located.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityMidValueAttr ( ) const

Density multiplier in the middle of interpolation.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr ( ) const

Distance from the cookie where the density interpolation starts.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr ( ) const

Density multiplier where the density interpolation starts.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute 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.


C++ Type: bool
Usd Type: SdfValueTypeNames->Bool
Variability: SdfVariabilityVarying
Fallback Value: False

USDRI_API UsdAttribute GetAnalyticShearXAttr ( ) const

Shear the projection along the X axis.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetAnalyticShearYAttr ( ) const

Shear the projection along the Y axis.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute 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.


C++ Type: bool
Usd Type: SdfValueTypeNames->Bool
Variability: SdfVariabilityVarying
Fallback Value: False

USDRI_API UsdAttribute GetColorContrastAttr ( ) const

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


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

USDRI_API UsdAttribute GetColorMidpointAttr ( ) const

Midpoint for the contrast control.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.180000007153

USDRI_API UsdAttribute GetColorSaturationAttr ( ) const

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


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

USDRI_API UsdAttribute GetColorTintAttr ( ) const

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


C++ Type: GfVec3f
Usd Type: SdfValueTypeNames->Color3f
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdAttribute GetColorWhitepointAttr ( ) const

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


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

USDRI_API UsdAttribute 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.


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: physical
Allowed Values: [physical, analytic]

USDRI_API UsdAttribute GetHeightAttr ( ) const

Height of the rect the light is shining through.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

static USDRI_API const TfTokenVector& GetSchemaAttributeNames ( bool  includeInherited = true)
static

Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes.

Does not include attributes that may be authored by custom/extended methods of the schemas involved.

USDRI_API UsdAttribute GetTextureFillColorAttr ( ) const

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


C++ Type: GfVec3f
Usd Type: SdfValueTypeNames->Color3f
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdAttribute 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.


C++ Type: bool
Usd Type: SdfValueTypeNames->Bool
Variability: SdfVariabilityVarying
Fallback Value: False

USDRI_API UsdAttribute 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.


C++ Type: bool
Usd Type: SdfValueTypeNames->Bool
Variability: SdfVariabilityVarying
Fallback Value: False

USDRI_API UsdAttribute GetTextureMapAttr ( ) const

A color texture to use on the cookie.

May use alpha.


C++ Type: SdfAssetPath
Usd Type: SdfValueTypeNames->Asset
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdAttribute GetTextureOffsetUAttr ( ) const

Offsets the texture in the U direction.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetTextureOffsetVAttr ( ) const

Offsets the texture in the V direction.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 0.0

USDRI_API UsdAttribute GetTextureScaleUAttr ( ) const

Scales the U dimension.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

USDRI_API UsdAttribute GetTextureScaleVAttr ( ) const

Scales the V dimension.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

USDRI_API UsdAttribute 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


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: off
Allowed Values: [off, repeat, clamp]

USDRI_API UsdAttribute GetWidthAttr ( ) const

Width of the rect the light is shining through.


C++ Type: float
Usd Type: SdfValueTypeNames->Float
Variability: SdfVariabilityVarying
Fallback Value: 1.0

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 68 of file pxrCookieLightFilter.h.


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