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

#include <pxrRampLightFilter.h>

+ Inheritance diagram for UsdRiPxrRampLightFilter:

Public Member Functions

 UsdRiPxrRampLightFilter (const UsdPrim &prim=UsdPrim())
 
 UsdRiPxrRampLightFilter (const UsdSchemaBase &schemaObj)
 
virtual USDRI_API ~UsdRiPxrRampLightFilter ()
 Destructor. More...
 
USDRI_API UsdAttribute GetRampModeAttr () const
 
USDRI_API UsdAttribute CreateRampModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetBeginDistanceAttr () const
 
USDRI_API UsdAttribute CreateBeginDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetEndDistanceAttr () const
 
USDRI_API UsdAttribute CreateEndDistanceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetFalloffAttr () const
 
USDRI_API UsdAttribute CreateFalloffAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetFalloffKnotsAttr () const
 
USDRI_API UsdAttribute CreateFalloffKnotsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetFalloffFloatsAttr () const
 
USDRI_API UsdAttribute CreateFalloffFloatsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetFalloffInterpolationAttr () const
 
USDRI_API UsdAttribute CreateFalloffInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorRampAttr () const
 
USDRI_API UsdAttribute CreateColorRampAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorRampKnotsAttr () const
 
USDRI_API UsdAttribute CreateColorRampKnotsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorRampColorsAttr () const
 
USDRI_API UsdAttribute CreateColorRampColorsAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdAttribute GetColorRampInterpolationAttr () const
 
USDRI_API UsdAttribute CreateColorRampInterpolationAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDRI_API UsdRiSplineAPI GetFalloffRampAPI () const
 
USDRI_API UsdRiSplineAPI GetColorRampAPI () const
 
- Public Member Functions inherited from UsdLuxLightFilter
 UsdLuxLightFilter (const UsdPrim &prim=UsdPrim())
 
 UsdLuxLightFilter (const UsdSchemaBase &schemaObj)
 
virtual USDLUX_API ~UsdLuxLightFilter ()
 Destructor. More...
 
USDLUX_API UsdCollectionAPI GetFilterLinkCollectionAPI () const
 
- Public Member Functions inherited from UsdGeomXformable
 UsdGeomXformable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomXformable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomXformable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetXformOpOrderAttr () const
 
USDGEOM_API UsdAttribute CreateXformOpOrderAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdGeomXformOp AddXformOp (UsdGeomXformOp::Type const opType, UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTranslateOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddScaleOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXYZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateXZYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYXZOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateYZXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZXYOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddRotateZYXOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddOrientOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionFloat, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API UsdGeomXformOp AddTransformOp (UsdGeomXformOp::Precision const precision=UsdGeomXformOp::PrecisionDouble, TfToken const &opSuffix=TfToken(), bool isInverseOp=false) const
 
USDGEOM_API bool SetResetXformStack (bool resetXform) const
 
USDGEOM_API bool GetResetXformStack () const
 
USDGEOM_API bool SetXformOpOrder (std::vector< UsdGeomXformOp > const &orderedXformOps, bool resetXformStack=false) const
 
USDGEOM_API std::vector
< UsdGeomXformOp
GetOrderedXformOps (bool *resetsXformStack) const
 
USDGEOM_API bool ClearXformOpOrder () const
 Clears the local transform stack. More...
 
USDGEOM_API UsdGeomXformOp MakeMatrixXform () const
 
USDGEOM_API bool TransformMightBeTimeVarying () const
 
USDGEOM_API bool TransformMightBeTimeVarying (const std::vector< UsdGeomXformOp > &ops) const
 
USDGEOM_API bool GetTimeSamples (std::vector< double > *times) const
 
USDGEOM_API bool GetTimeSamplesInInterval (const GfInterval &interval, std::vector< double > *times) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const UsdTimeCode time=UsdTimeCode::Default()) const
 
USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, bool *resetsXformStack, const std::vector< UsdGeomXformOp > &ops, const UsdTimeCode time=UsdTimeCode::Default()) const
 
- Public Member Functions inherited from UsdGeomImageable
 UsdGeomImageable (const UsdPrim &prim=UsdPrim())
 
 UsdGeomImageable (const UsdSchemaBase &schemaObj)
 
virtual USDGEOM_API ~UsdGeomImageable ()
 Destructor. More...
 
USDGEOM_API UsdAttribute GetVisibilityAttr () const
 
USDGEOM_API UsdAttribute CreateVisibilityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdAttribute GetPurposeAttr () const
 
USDGEOM_API UsdAttribute CreatePurposeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 
USDGEOM_API UsdRelationship GetProxyPrimRel () const
 
USDGEOM_API UsdRelationship CreateProxyPrimRel () const
 
USDGEOM_API void MakeVisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API void MakeInvisible (const UsdTimeCode &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API TfToken ComputeVisibility (const TfToken &parentVisibility, UsdTimeCode const &time=UsdTimeCode::Default()) const
 
USDGEOM_API PurposeInfo ComputePurposeInfo () const
 
USDGEOM_API PurposeInfo ComputePurposeInfo (const PurposeInfo &parentPurposeInfo) const
 
USDGEOM_API TfToken ComputePurpose () const
 
USDGEOM_API UsdPrim ComputeProxyPrim (UsdPrim *renderPrim=NULL) const
 
USDGEOM_API bool SetProxyPrim (const UsdPrim &proxy) const
 
USDGEOM_API bool SetProxyPrim (const UsdSchemaBase &proxy) const
 
USDGEOM_API GfBBox3d ComputeWorldBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeLocalBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfBBox3d ComputeUntransformedBound (UsdTimeCode const &time, TfToken const &purpose1=TfToken(), TfToken const &purpose2=TfToken(), TfToken const &purpose3=TfToken(), TfToken const &purpose4=TfToken()) const
 
USDGEOM_API GfMatrix4d ComputeLocalToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API GfMatrix4d ComputeParentToWorldTransform (UsdTimeCode const &time) const
 
USDGEOM_API UsdGeomPrimvar CreatePrimvar (const TfToken &attrName, const SdfValueTypeName &typeName, const TfToken &interpolation=TfToken(), int elementSize=-1) const
 
USDGEOM_API UsdGeomPrimvar GetPrimvar (const TfToken &name) const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetPrimvars () const
 
USDGEOM_API std::vector
< UsdGeomPrimvar
GetAuthoredPrimvars () const
 
USDGEOM_API bool HasPrimvar (const TfToken &name) const
 
- Public Member Functions inherited from UsdTyped
 UsdTyped (const UsdPrim &prim=UsdPrim())
 
 UsdTyped (const UsdSchemaBase &schemaObj)
 
virtual USD_API ~UsdTyped ()
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 
bool IsTyped () const
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 
bool IsMultipleApplyAPISchema () const
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API const UsdPrimDefinitionGetSchemaClassPrimDefinition () const
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDRI_API
UsdRiPxrRampLightFilter 
Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDRI_API
UsdRiPxrRampLightFilter 
Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdLuxLightFilter
static USDLUX_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDLUX_API UsdLuxLightFilter Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDLUX_API UsdLuxLightFilter Define (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdGeomXformable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomXformable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API bool GetTimeSamples (std::vector< UsdGeomXformOp > const &orderedXformOps, std::vector< double > *times)
 
static USDGEOM_API bool GetTimeSamplesInInterval (std::vector< UsdGeomXformOp > const &orderedXformOps, const GfInterval &interval, std::vector< double > *times)
 
static USDGEOM_API bool GetLocalTransformation (GfMatrix4d *transform, std::vector< UsdGeomXformOp > const &ops, const UsdTimeCode time)
 
static USDGEOM_API bool IsTransformationAffectedByAttrNamed (const TfToken &attrName)
 
- Static Public Member Functions inherited from UsdGeomImageable
static USDGEOM_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 
static USDGEOM_API UsdGeomImageable Get (const UsdStagePtr &stage, const SdfPath &path)
 
static USDGEOM_API const
TfTokenVector
GetOrderedPurposeTokens ()
 
- Static Public Member Functions inherited from UsdTyped
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 
static USD_API UsdTyped Get (const UsdStagePtr &stage, const SdfPath &path)
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

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

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 
- Protected Member Functions inherited from UsdTyped
USD_API bool _IsCompatible () const override
 
- Protected Member Functions inherited from UsdSchemaBase
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 

Friends

class UsdSchemaRegistry
 

Detailed Description

Deprecated:
This schema will be replaced in a future release. A ramp to modulate how a light falls off with distance.

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 68 of file pxrRampLightFilter.h.

Constructor & Destructor Documentation

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

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

Definition at line 80 of file pxrRampLightFilter.h.

UsdRiPxrRampLightFilter::UsdRiPxrRampLightFilter ( const UsdSchemaBase schemaObj)
inlineexplicit

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

Definition at line 88 of file pxrRampLightFilter.h.

virtual USDRI_API UsdRiPxrRampLightFilter::~UsdRiPxrRampLightFilter ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaType UsdRiPxrRampLightFilter::_GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdLuxLightFilter.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateBeginDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetBeginDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateColorRampAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetColorRampAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateColorRampColorsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetColorRampColorsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateColorRampInterpolationAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetColorRampInterpolationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateColorRampKnotsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetColorRampKnotsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateEndDistanceAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetEndDistanceAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateFalloffAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetFalloffAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateFalloffFloatsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetFalloffFloatsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateFalloffInterpolationAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetFalloffInterpolationAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateFalloffKnotsAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetFalloffKnotsAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::CreateRampModeAttr ( VtValue const defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRampModeAttr(), and also Usd_Create_Or_Get_Property for when to use Get vs Create. If specified, author defaultValue as the attribute's default, sparsely (when it makes sense to do so) if writeSparsely is true - the default for writeSparsely is false.

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

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

UsdRiPxrRampLightFilter(stage->GetPrimAtPath(path));
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetBeginDistanceAttr ( ) const

Distance where the ramp starts.

Declaration float beginDistance = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdRiSplineAPI UsdRiPxrRampLightFilter::GetColorRampAPI ( ) const

Return the UsdRiSplineAPI interface used for examining and modifying the color ramp.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetColorRampAttr ( ) const

Controls the color gradient for the transition.

Declaration int colorRamp = 4
C++ Type int
Usd Type SdfValueTypeNames->Int
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetColorRampColorsAttr ( ) const

Color values of the colorRamp spline.

Declaration color3f[] colorRamp:colors = [(1, 1, 1), (1, 1, 1), (1, 1, 1), (1, 1, 1)]
C++ Type VtArray<GfVec3f>
Usd Type SdfValueTypeNames->Color3fArray
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetColorRampInterpolationAttr ( ) const

ColorRamp spline type.

Declaration token colorRamp:interpolation = "linear"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values linear, catmull-rom, bspline, constant
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetColorRampKnotsAttr ( ) const

Knots of the colorRamp spline.

Declaration float[] colorRamp:knots = [0, 0, 1, 1]
C++ Type VtArray<float>
Usd Type SdfValueTypeNames->FloatArray
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetEndDistanceAttr ( ) const

Distance where the ramp ends.

Declaration float endDistance = 10
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetFalloffAttr ( ) const

Controls the transition from the core to the edge.

Declaration int falloff = 4
C++ Type int
Usd Type SdfValueTypeNames->Int
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetFalloffFloatsAttr ( ) const

Float values of the falloff spline.

Declaration float[] falloff:floats = [0, 0, 1, 1]
C++ Type VtArray<float>
Usd Type SdfValueTypeNames->FloatArray
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetFalloffInterpolationAttr ( ) const

Falloff spline type.

Declaration token falloff:interpolation = "linear"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values linear, catmull-rom, bspline, constant
USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetFalloffKnotsAttr ( ) const

Knots of the falloff spline.

Declaration float[] falloff:knots = [0, 0, 1, 1]
C++ Type VtArray<float>
Usd Type SdfValueTypeNames->FloatArray
USDRI_API UsdRiSplineAPI UsdRiPxrRampLightFilter::GetFalloffRampAPI ( ) const

Return the UsdRiSplineAPI interface used for examining and modifying the falloff ramp.

USDRI_API UsdAttribute UsdRiPxrRampLightFilter::GetRampModeAttr ( ) const

Specifies the direction in which the ramp is applied

Declaration token rampMode = "distanceToLight"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values distanceToLight, linear, spherical, radial
static USDRI_API const TfTokenVector& UsdRiPxrRampLightFilter::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.

Friends And Related Function Documentation

friend class UsdSchemaRegistry
friend

Definition at line 152 of file pxrRampLightFilter.h.

Member Data Documentation

const UsdSchemaType UsdRiPxrRampLightFilter::schemaType = UsdSchemaType::ConcreteTyped
static

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

See Also
UsdSchemaType

Definition at line 74 of file pxrRampLightFilter.h.


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