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 | GetTexturePremultipliedAlphaAttr () const |
Textures are usually premultiplied by their alpha. More... | |
USDRI_API UsdAttribute | CreateTexturePremultipliedAlphaAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const |
See GetTexturePremultipliedAlphaAttr(), 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 |
Distance between the center of cookie and the center of projection. 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... | |
USDLUX_API | UsdLuxLightFilter (const UsdShadeConnectableAPI &connectable) |
Constructor that takes a ConnectableAPI object. More... | |
USDLUX_API UsdShadeConnectableAPI | ConnectableAPI () const |
Contructs and returns a UsdShadeConnectableAPI object with this light filter. More... | |
USDLUX_API UsdShadeOutput | CreateOutput (const TfToken &name, const SdfValueTypeName &typeName) |
Create an output which can either have a value or can be connected. More... | |
USDLUX_API UsdShadeOutput | GetOutput (const TfToken &name) const |
Return the requested output if it exists. More... | |
USDLUX_API std::vector < UsdShadeOutput > | GetOutputs (bool onlyAuthored=true) const |
Outputs are represented by attributes in the "outputs:" namespace. More... | |
USDLUX_API UsdShadeInput | CreateInput (const TfToken &name, const SdfValueTypeName &typeName) |
Create an input which can either have a value or can be connected. More... | |
USDLUX_API UsdShadeInput | GetInput (const TfToken &name) const |
Return the requested input if it exists. More... | |
USDLUX_API std::vector < UsdShadeInput > | GetInputs (bool onlyAuthored=true) const |
Inputs are represented by attributes in the "inputs:" namespace. 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 classification of 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 PurposeInfo | ComputePurposeInfo () const |
Calculate the effective purpose information about this prim which includes final computed purpose value of the prim as well as whether the purpose value should be inherited by namespace children without their own purpose opinions. More... | |
USDGEOM_API PurposeInfo | ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) 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 information about this prim, given the computed purpose information of its parent prim. More... | |
USDGEOM_API TfToken | ComputePurpose () const |
Calculate the effective purpose information about this 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... | |
UsdSchemaKind | GetSchemaKind () const |
Returns the kind of schema this class is. More... | |
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 UsdPrimDefinition * | 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 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 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 TfTokenVector & | GetSchemaAttributeNames (bool includeInherited=true) |
Static Public Attributes | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdLuxLightFilter | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::ConcreteTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdGeomXformable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdGeomImageable | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractTyped |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdTyped | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
Static Public Attributes inherited from UsdSchemaBase | |
static const UsdSchemaKind | schemaKind = UsdSchemaKind::AbstractBase |
Compile time constant representing what kind of schema this class is. More... | |
Protected Member Functions | |
USDRI_API UsdSchemaKind | _GetSchemaKind () const override |
Returns the kind 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 | |
virtual UsdSchemaKind | _GetSchemaType () const |
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 |
For any described attribute Fallback Value or Allowed Values below that are text/tokens, the actual token is published and defined in UsdRiTokens. So to set an attribute to the value "rightHanded", use UsdRiTokens->rightHanded as the value.
Definition at line 65 of file pxrCookieLightFilter.h.
|
inlineexplicit |
Construct a UsdRiPxrCookieLightFilter on UsdPrim prim
.
Equivalent to UsdRiPxrCookieLightFilter::Get(prim.GetStage(), prim.GetPath()) for a valid prim
, but will not immediately throw an error for an invalid prim
Definition at line 77 of file pxrCookieLightFilter.h.
|
inlineexplicit |
Construct a UsdRiPxrCookieLightFilter on the prim held by schemaObj
.
Should be preferred over UsdRiPxrCookieLightFilter(schemaObj.GetPrim()), as it preserves SchemaBase state.
Definition at line 85 of file pxrCookieLightFilter.h.
|
virtual |
Destructor.
|
overrideprotectedvirtual |
Returns the kind of schema this class belongs to.
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 CreateTexturePremultipliedAlphaAttr | ( | VtValue const & | defaultValue = VtValue() , |
bool | writeSparsely = false |
||
) | const |
See GetTexturePremultipliedAlphaAttr(), 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 |
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 |
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:
USDRI_API UsdAttribute GetAnalyticApexAttr | ( | ) | const |
Distance between the center of cookie and the center of projection.
Declaration | float analytic:apex = 25 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurAmountAttr | ( | ) | const |
Specify the blur of projected texture from 0-1.
This gets multiplied by the blurNear/blurFar interpolation. This blurs between the projected color and the fill color when the texture is not repeating.
Declaration | float analytic:blur:amount = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurExponentAttr | ( | ) | const |
Power exponent of the blur interpolation.
Declaration | float analytic:blur:exponent = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurFarDistanceAttr | ( | ) | const |
Distance from the cookie where the blur interpolation ends.
Declaration | float analytic:blur:farDistance = 10 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurFarValueAttr | ( | ) | const |
Blur multiplier at the end of interpolation.
Declaration | float analytic:blur:farValue = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurMidpointAttr | ( | ) | const |
Distance between near and far where midValue is located.
Declaration | float analytic:blur:midpoint = 0.5 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurMidValueAttr | ( | ) | const |
Blur multiplier in the middle of interpolation.
Declaration | float analytic:blur:midValue = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurNearDistanceAttr | ( | ) | const |
Distance from the cookie where the blur interpolation starts.
Declaration | float analytic:blur:nearDistance = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurNearValueAttr | ( | ) | const |
Blur multiplier where the blur interpolation starts.
Declaration | float analytic:blur:nearValue = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurSMultAttr | ( | ) | const |
Blur multiplier in the S direction.
Declaration | float analytic:blur:sMult = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticBlurTMultAttr | ( | ) | const |
Blur multiplier in the T direction.
Declaration | float analytic:blur:tMult = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticDensityExponentAttr | ( | ) | const |
Power exponent of the density interpolation.
Declaration | float analytic:density:exponent = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticDensityFarDistanceAttr | ( | ) | const |
Distance from the cookie where the density interpolation ends.
Declaration | float analytic:density:farDistance = 10 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute 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 GetAnalyticDensityMidpointAttr | ( | ) | const |
Distance between near and far where midValue is located.
Declaration | float analytic:density:midpoint = 0.5 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticDensityMidValueAttr | ( | ) | const |
Density multiplier in the middle of interpolation.
Declaration | float analytic:density:midValue = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticDensityNearDistanceAttr | ( | ) | const |
Distance from the cookie where the density interpolation starts.
Declaration | float analytic:density:nearDistance = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticDensityNearValueAttr | ( | ) | const |
Density multiplier where the density interpolation starts.
Declaration | float analytic:density:nearValue = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute 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 GetAnalyticShearXAttr | ( | ) | const |
Shear the projection along the X axis.
Declaration | float analytic:shearX = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetAnalyticShearYAttr | ( | ) | const |
Shear the projection along the Y axis.
Declaration | float analytic:shearY = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
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.
Declaration | bool analytic:useLightDirection = 0 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
USDRI_API UsdAttribute GetColorContrastAttr | ( | ) | const |
Contrast control (less than 1 = contrast reduction, larger than 1 = contrast increase).
Declaration | float color:contrast = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetColorMidpointAttr | ( | ) | const |
Midpoint for the contrast control.
Declaration | float color:midpoint = 0.18 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetColorSaturationAttr | ( | ) | const |
Saturation of the result (0=greyscale, 1=normal, >1=boosted colors).
Declaration | float color:saturation = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetColorTintAttr | ( | ) | const |
USDRI_API UsdAttribute GetColorWhitepointAttr | ( | ) | const |
White point for the contrast control if (contrast > 1.0).
Declaration | float color:whitepoint = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetCookieModeAttr | ( | ) | const |
Chooses a physical or analytic evaluation model for the cookie:
Declaration | token cookieMode = "physical" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | physical, analytic |
USDRI_API UsdAttribute GetHeightAttr | ( | ) | const |
Height of the rect the light is shining through.
Declaration | float height = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
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 |
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.
Declaration | bool texture:invertU = 0 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
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.
Declaration | bool texture:invertV = 0 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
USDRI_API UsdAttribute GetTextureMapAttr | ( | ) | const |
A color texture to use on the cookie.
May use alpha.
Declaration | asset texture:map |
C++ Type | SdfAssetPath |
Usd Type | SdfValueTypeNames->Asset |
USDRI_API UsdAttribute GetTextureOffsetUAttr | ( | ) | const |
Offsets the texture in the U direction.
Declaration | float texture:offsetU = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetTextureOffsetVAttr | ( | ) | const |
Offsets the texture in the V direction.
Declaration | float texture:offsetV = 0 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetTexturePremultipliedAlphaAttr | ( | ) | const |
Textures are usually premultiplied by their alpha.
If this not the case, uncheck this.
Declaration | bool texture:premultipliedAlpha = 1 |
C++ Type | bool |
Usd Type | SdfValueTypeNames->Bool |
USDRI_API UsdAttribute GetTextureScaleUAttr | ( | ) | const |
Scales the U dimension.
Declaration | float texture:scaleU = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetTextureScaleVAttr | ( | ) | const |
Scales the V dimension.
Declaration | float texture:scaleV = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
USDRI_API UsdAttribute GetTextureWrapModeAttr | ( | ) | const |
Specifies what value to use outside the texture's domain:
Declaration | token texture:wrapMode = "off" |
C++ Type | TfToken |
Usd Type | SdfValueTypeNames->Token |
Allowed Values | off, repeat, clamp |
USDRI_API UsdAttribute GetWidthAttr | ( | ) | const |
Width of the rect the light is shining through.
Declaration | float width = 1 |
C++ Type | float |
Usd Type | SdfValueTypeNames->Float |
|
static |
Compile time constant representing what kind of schema this class is.
Definition at line 71 of file pxrCookieLightFilter.h.