All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
UsdRiLightFilterAPI Class Reference
+ Inheritance diagram for UsdRiLightFilterAPI:

Public Member Functions

 UsdRiLightFilterAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiLightFilterAPI on UsdPrim prim . More...
 
 UsdRiLightFilterAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdRiLightFilterAPI on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiLightFilterAPI ()
 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 GetRiExposureAttr () const
 Exposure control for the multiplier. More...
 
USDRI_API UsdAttribute CreateRiExposureAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetRiExposureAttr(), 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 UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim=UsdPrim())
 Construct a UsdAPISchemaBase on UsdPrim prim . More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj)
 Construct a UsdAPISchemaBase on the prim held by schemaObj . More...
 
virtual USD_API ~UsdAPISchemaBase ()=0
 Destructor. 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 UsdPrimDefinitionGetSchemaClassPrimDefinition () 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
UsdRiLightFilterAPI 
Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiLightFilterAPI holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API bool CanApply (const UsdPrim &prim, std::string *whyNot=nullptr)
 Returns true if this single-apply API schema can be applied to the given prim. More...
 
static USDRI_API
UsdRiLightFilterAPI 
Apply (const UsdPrim &prim)
 Applies this single-apply API schema to the given prim. More...
 
- Static Public Member Functions inherited from UsdAPISchemaBase
static USD_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 Public Member Functions inherited from UsdSchemaBase
static const TfTokenVectorGetSchemaAttributeNames (bool includeInherited=true)
 

Static Public Attributes

static const UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdAPISchemaBase
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 UsdAPISchemaBase
 UsdAPISchemaBase (const UsdPrim &prim, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on UsdPrim prim with the specified instanceName. More...
 
 UsdAPISchemaBase (const UsdSchemaBase &schemaObj, const TfToken &instanceName)
 Construct a multiple-apply UsdAPISchemaBase on the prim held by schemaObj with the given instanceName. More...
 
const TfToken_GetInstanceName () const
 Returns the instance name of the API schema object belonging to a multiple-apply API schema. More...
 
USD_API bool _IsCompatible () const override
 Check whether this APISchema object is valid for the currently held prim. 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
 

Additional Inherited Members

- Static Protected Member Functions inherited from UsdAPISchemaBase
template<typename APISchemaType >
static APISchemaType _ApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName)
 Helper method to apply a single-apply API schema with the given schema name apiSchemaName' and C++ type 'APISchemaType'. More...
 
template<typename APISchemaType >
static APISchemaType _MultipleApplyAPISchema (const UsdPrim &prim, const TfToken &apiSchemaName, const TfToken &instanceName)
 Helper method to apply a multiple-apply API schema with the given schema name apiSchemaName', C++ type 'APISchemaType' and instance name instanceName. More...
 

Detailed Description

Deprecated:
RenderMan-specific light filter settings will move to a new schema in a future release.

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 66 of file lightFilterAPI.h.

Constructor & Destructor Documentation

UsdRiLightFilterAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiLightFilterAPI on UsdPrim prim .

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

Definition at line 78 of file lightFilterAPI.h.

UsdRiLightFilterAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiLightFilterAPI on the prim held by schemaObj .

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

Definition at line 86 of file lightFilterAPI.h.

virtual USDRI_API ~UsdRiLightFilterAPI ( )
virtual

Destructor.

Member Function Documentation

USDRI_API UsdSchemaKind _GetSchemaKind ( ) const
overrideprotectedvirtual

Returns the kind of schema this class belongs to.

See Also
UsdSchemaKind

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiLightFilterAPI Apply ( const UsdPrim prim)
static

Applies this single-apply API schema to the given prim.

This information is stored by adding "RiLightFilterAPI" to the token-valued, listOp metadata apiSchemas on the prim.

Returns
A valid UsdRiLightFilterAPI object is returned upon success. An invalid (or empty) UsdRiLightFilterAPI object is returned upon failure. See UsdPrim::ApplyAPI() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
static USDRI_API bool CanApply ( const UsdPrim prim,
std::string *  whyNot = nullptr 
)
static

Returns true if this single-apply API schema can be applied to the given prim.

If this schema can not be a applied to the prim, this returns false and, if provided, populates whyNot with the reason it can not be applied.

Note that if CanApply returns false, that does not necessarily imply that calling Apply will fail. Callers are expected to call CanApply before calling Apply if they want to ensure that it is valid to apply a schema.

See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
UsdPrim::CanApplyAPI()
UsdPrim::ApplyAPI()
UsdPrim::RemoveAPI()
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 CreateRiExposureAttr ( VtValue const &  defaultValue = VtValue(),
bool  writeSparsely = false 
) const

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

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

* UsdRiLightFilterAPI(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

Declaration token ri:combineMode = "multiply"
C++ Type TfToken
Usd Type SdfValueTypeNames->Token
Allowed Values multiply, max, min, screen
USDRI_API UsdAttribute GetRiDensityAttr ( ) const

Scales the strength of the filter.

Declaration float ri:density = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
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.

Declaration float ri:diffuse = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute GetRiExposureAttr ( ) const

Exposure control for the multiplier.

Declaration float ri:exposure = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute GetRiIntensityAttr ( ) const

Multipier for the diffuse and specular result.

Declaration float ri:intensity = 0
C++ Type float
Usd Type SdfValueTypeNames->Float
USDRI_API UsdAttribute GetRiInvertAttr ( ) const

When true, inverts the output of the light filter.

Declaration bool ri:invert = 0
C++ Type bool
Usd Type SdfValueTypeNames->Bool
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.

Declaration float ri:specular = 1
C++ Type float
Usd Type SdfValueTypeNames->Float
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 UsdSchemaKind schemaKind = UsdSchemaKind::SingleApplyAPI
static

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

See Also
UsdSchemaKind

Definition at line 72 of file lightFilterAPI.h.


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