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

Renderman-specific attributes for light filters. More...

+ Inheritance diagram for UsdRiRiLightFilterAPI:

Public Member Functions

 UsdRiRiLightFilterAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiRiLightFilterAPI on UsdPrim prim . More...
 
 UsdRiRiLightFilterAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdRiRiLightFilterAPI on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiRiLightFilterAPI ()
 Destructor. More...
 
USDRI_API UsdAttribute GetRiCombineModeAttr () const
 Specifies how this filter combines with others. More...
 
USDRI_API UsdAttribute CreateRiCombineModeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiCombineModeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetRiDensityAttr () const
 Scales the strength of the filter. More...
 
USDRI_API UsdAttribute CreateRiDensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiDensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetRiInvertAttr () const
 When true, inverts the output of the light filter. More...
 
USDRI_API UsdAttribute CreateRiInvertAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiInvertAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetRiIntensityAttr () const
 Multipier for the diffuse and specular result. More...
 
USDRI_API UsdAttribute CreateRiIntensityAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiIntensityAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetRiDiffuseAttr () const
 A multiplier for the effect of this light on the diffuse response of materials. More...
 
USDRI_API UsdAttribute CreateRiDiffuseAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiDiffuseAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetRiSpecularAttr () const
 A multiplier for the effect of this light on the specular response of materials. More...
 
USDRI_API UsdAttribute CreateRiSpecularAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiSpecularAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
- Public Member Functions inherited from UsdSchemaBase
bool IsConcrete () const
 Returns whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
bool IsTyped () const
 Returns whether or not this class inherits from UsdTyped. More...
 
bool IsAPISchema () const
 Returns whether this is an API schema or not. More...
 
bool IsAppliedAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
bool IsMultipleApplyAPISchema () const
 Returns whether this is an applied API schema or not. More...
 
UsdSchemaType GetSchemaType () const
 
USD_API UsdSchemaBase (const UsdPrim &prim=UsdPrim())
 Construct and store prim as the held prim. More...
 
USD_API UsdSchemaBase (const UsdSchemaBase &otherSchema)
 Construct and store for the same prim held by otherSchema. More...
 
virtual USD_API ~UsdSchemaBase ()
 Destructor. More...
 
USD_API operator bool () const
 Return true if this schema object is compatible with its held prim, false otherwise. More...
 
UsdPrim GetPrim () const
 Return this schema object's held prim. More...
 
SdfPath GetPath () const
 Shorthand for GetPrim()->GetPath(). More...
 
USD_API SdfPrimSpecHandle GetSchemaClassPrimDefinition () const
 Return the prim definition associated with this schema instance if one exists, otherwise return null. More...
 

Static Public Member Functions

static USDRI_API const
TfTokenVector
GetSchemaAttributeNames (bool includeInherited=true)
 Return a vector of names of all pre-declared attributes for this schema class and all its ancestor classes. More...
 
static USDRI_API
UsdRiRiLightFilterAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiRiLightFilterAPI holding the prim adhering to this schema at path on stage. More...
 
- Static Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const bool IsConcrete = false
 Compile-time constant indicating whether or not this class corresponds to a concrete instantiable prim type in scene description. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Friends

class UsdSchemaRegistry
 

Additional Inherited Members

- Protected Member Functions inherited from UsdSchemaBase
virtual UsdSchemaType _GetSchemaType () const
 Returns the type of schema this class is. More...
 
const TfType_GetType () const
 
USD_API UsdAttribute _CreateAttr (TfToken const &attrName, SdfValueTypeName const &typeName, bool custom, SdfVariability variability, VtValue const &defaultValue, bool writeSparsely) const
 
virtual USD_API bool _IsCompatible () const
 Subclasses may override _IsCompatible to do specific compatibility checking with the given prim, such as type compatibility or value compatibility. More...
 

Detailed Description

Renderman-specific attributes for light filters.

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

Definition at line 62 of file riLightFilterAPI.h.

Constructor & Destructor Documentation

UsdRiRiLightFilterAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiRiLightFilterAPI on UsdPrim prim .

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

Definition at line 75 of file riLightFilterAPI.h.

UsdRiRiLightFilterAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiRiLightFilterAPI on the prim held by schemaObj .

Should be preferred over UsdRiRiLightFilterAPI(schemaObj.GetPrim()), as it preserves SchemaBase state.

Definition at line 83 of file riLightFilterAPI.h.

virtual USDRI_API ~UsdRiRiLightFilterAPI ( )
virtual

Destructor.

Member Function Documentation

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

See GetRiCombineModeAttr(), 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 CreateRiDensityAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiDensityAttr(), 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 CreateRiDiffuseAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiDiffuseAttr(), 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 CreateRiIntensityAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiIntensityAttr(), 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 CreateRiInvertAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

See GetRiInvertAttr(), 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 CreateRiSpecularAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

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

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

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

* UsdRiRiLightFilterAPI(stage->GetPrimAtPath(path));
*
USDRI_API UsdAttribute GetRiCombineModeAttr ( ) const

Specifies how this filter combines with others.

Valid values are:

  • multiply: The results of filters are multiplied together
  • max: The maximum result of the filters is used. This works best for grey-scale filters.
  • min: The minimum result of the filters is used. This works best for grey-scale filters.
  • screen: Similar to max, but combines gradients in a smoother way by using a screen operation:
    screen(a,b) = 1-(1-a)(1-b)
    This works best for grey-scale filters.

Light filters on a light are grouped by their combine mode. Each group is executed and combined using that mode. Then, the final results of each group are multiplied together.

Fallback: multiply


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback
Allowed Values: [multiply, max, min, screen]

USDRI_API UsdAttribute GetRiDensityAttr ( ) const

Scales the strength of the filter.


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

USDRI_API UsdAttribute GetRiDiffuseAttr ( ) const

A multiplier for the effect of this light on the diffuse response of materials.

This is a non-physical control.


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

USDRI_API UsdAttribute GetRiIntensityAttr ( ) const

Multipier for the diffuse and specular result.


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

USDRI_API UsdAttribute GetRiInvertAttr ( ) const

When true, inverts the output of the light filter.


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

USDRI_API UsdAttribute GetRiSpecularAttr ( ) const

A multiplier for the effect of this light on the specular response of materials.

This is a non-physical control.


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

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

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

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

Member Data Documentation

const bool IsConcrete = false
static

Compile-time constant indicating whether or not this class corresponds to a concrete instantiable prim type in scene description.

If this is true, GetStaticPrimDefinition() will return a valid prim definition with a non-empty typeName.

Definition at line 69 of file riLightFilterAPI.h.


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