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

This API provides outputs that connect a material prim to prman shaders and RIS objects. More...

+ Inheritance diagram for UsdRiMaterialAPI:

Public Member Functions

 UsdRiMaterialAPI (const UsdPrim &prim=UsdPrim())
 Construct a UsdRiMaterialAPI on UsdPrim prim . More...
 
 UsdRiMaterialAPI (const UsdSchemaBase &schemaObj)
 Construct a UsdRiMaterialAPI on the prim held by schemaObj . More...
 
virtual USDRI_API ~UsdRiMaterialAPI ()
 Destructor. More...
 
USDRI_API UsdAttribute GetSurfaceAttr () const
 
C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback More...
 
USDRI_API UsdAttribute CreateSurfaceAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetSurfaceAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetDisplacementAttr () const
 
C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback More...
 
USDRI_API UsdAttribute CreateDisplacementAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetDisplacementAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
USDRI_API UsdAttribute GetVolumeAttr () const
 
C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback More...
 
USDRI_API UsdAttribute CreateVolumeAttr (VtValue const &defaultValue=VtValue(), bool writeSparsely=false) const
 See GetVolumeAttr(), and also Create vs Get Property Methods for when to use Get vs Create. More...
 
 UsdRiMaterialAPI (const UsdShadeMaterial &material)
 A constructor for creating a MaterialAPI object from a material prim. More...
 
Outputs API
USDRI_API UsdShadeOutput GetSurfaceOutput () const
 Returns the "surface" output associated with the material. More...
 
USDRI_API UsdShadeOutput GetDisplacementOutput () const
 Returns the "displacement" output associated with the material. More...
 
USDRI_API UsdShadeOutput GetVolumeOutput () const
 Returns the "volume" output associated with the material. More...
 
API for setting sources of outputs
USDRI_API bool SetSurfaceSource (const SdfPath &surfacePath) const
 
USDRI_API bool SetDisplacementSource (const SdfPath &displacementPath) const
 
USDRI_API bool SetVolumeSource (const SdfPath &volumePath) const
 
Shaders API
USDRI_API UsdShadeShader GetSurface (bool ignoreBaseMaterial=false) const
 Returns a valid shader object if the "surface" output on the material is connected to one. More...
 
USDRI_API UsdShadeShader GetDisplacement (bool ignoreBaseMaterial=false) const
 Returns a valid shader object if the "displacement" output on the material is connected to one. More...
 
USDRI_API UsdShadeShader GetVolume (bool ignoreBaseMaterial=false) const
 Returns a valid shader object if the "volume" output on the material is connected to one. More...
 
Convenience API

This API is provided here mainly to handle backwards compatibility with the old encoding of shading networks.

USDRI_API bool SetInterfaceInputConsumer (UsdShadeInput &interfaceInput, const UsdShadeInput &consumer) const
 Set the input consumer of the given interfaceInput to the specified input, consumer. More...
 
USDRI_API
UsdShadeNodeGraph::InterfaceInputConsumersMap 
ComputeInterfaceInputConsumersMap (bool computeTransitiveConsumers=false) const
 Walks the namespace subtree below the material and computes a map containing the list of all inputs on the material and the associated vector of consumers of their values. More...
 
USDRI_API std::vector
< UsdShadeInput
GetInterfaceInputs () const
 Returns all the interface inputs belonging to the material. 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...
 
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 UsdRiMaterialAPI Get (const UsdStagePtr &stage, const SdfPath &path)
 Return a UsdRiMaterialAPI holding the prim adhering to this schema at path on stage. More...
 
static USDRI_API UsdRiMaterialAPI 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 UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdAPISchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 
- Static Public Attributes inherited from UsdSchemaBase
static const UsdSchemaType schemaType = UsdSchemaType::AbstractBase
 Compile time constant representing what kind of schema this class is. More...
 

Protected Member Functions

USDRI_API UsdSchemaType _GetSchemaType () const override
 Returns the type of schema this class belongs to. More...
 
- Protected Member Functions inherited from 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
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

This API provides outputs that connect a material prim to prman shaders and RIS objects.

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 materialAPI.h.

Constructor & Destructor Documentation

UsdRiMaterialAPI ( const UsdPrim prim = UsdPrim())
inlineexplicit

Construct a UsdRiMaterialAPI on UsdPrim prim .

Equivalent to UsdRiMaterialAPI::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 materialAPI.h.

UsdRiMaterialAPI ( const UsdSchemaBase schemaObj)
inlineexplicit

Construct a UsdRiMaterialAPI on the prim held by schemaObj .

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

Definition at line 88 of file materialAPI.h.

virtual USDRI_API ~UsdRiMaterialAPI ( )
virtual

Destructor.

UsdRiMaterialAPI ( const UsdShadeMaterial material)
inlineexplicit

A constructor for creating a MaterialAPI object from a material prim.

Definition at line 229 of file materialAPI.h.

Member Function Documentation

USDRI_API UsdSchemaType _GetSchemaType ( ) const
overrideprotectedvirtual

Returns the type of schema this class belongs to.

See Also
UsdSchemaType

Reimplemented from UsdAPISchemaBase.

static USDRI_API UsdRiMaterialAPI Apply ( const UsdPrim prim)
static

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

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

Returns
A valid UsdRiMaterialAPI object is returned upon success. An invalid (or empty) UsdRiMaterialAPI object is returned upon failure. See UsdAPISchemaBase::_ApplyAPISchema() for conditions resulting in failure.
See Also
UsdPrim::GetAppliedSchemas()
UsdPrim::HasAPI()
USDRI_API UsdShadeNodeGraph::InterfaceInputConsumersMap ComputeInterfaceInputConsumersMap ( bool  computeTransitiveConsumers = false) const

Walks the namespace subtree below the material and computes a map containing the list of all inputs on the material and the associated vector of consumers of their values.

The consumers can be inputs on shaders within the material or on node-graphs under it.

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

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

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

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

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

* UsdRiMaterialAPI(stage->GetPrimAtPath(path));
*
USDRI_API UsdShadeShader GetDisplacement ( bool  ignoreBaseMaterial = false) const

Returns a valid shader object if the "displacement" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "displacement" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute GetDisplacementAttr ( ) const


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdShadeOutput GetDisplacementOutput ( ) const

Returns the "displacement" output associated with the material.

USDRI_API std::vector<UsdShadeInput> GetInterfaceInputs ( ) const

Returns all the interface inputs belonging to the material.

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

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

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

USDRI_API UsdShadeShader GetSurface ( bool  ignoreBaseMaterial = false) const

Returns a valid shader object if the "surface" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "surface" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute GetSurfaceAttr ( ) const


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdShadeOutput GetSurfaceOutput ( ) const

Returns the "surface" output associated with the material.

USDRI_API UsdShadeShader GetVolume ( bool  ignoreBaseMaterial = false) const

Returns a valid shader object if the "volume" output on the material is connected to one.

If ignoreBaseMaterial is true and if the "volume" shader source is specified in the base-material of this material, then this returns an invalid shader object.

USDRI_API UsdAttribute GetVolumeAttr ( ) const


C++ Type: TfToken
Usd Type: SdfValueTypeNames->Token
Variability: SdfVariabilityVarying
Fallback Value: No Fallback

USDRI_API UsdShadeOutput GetVolumeOutput ( ) const

Returns the "volume" output associated with the material.

USDRI_API bool SetInterfaceInputConsumer ( UsdShadeInput interfaceInput,
const UsdShadeInput consumer 
) const

Set the input consumer of the given interfaceInput to the specified input, consumer.

This sets the connected source of consumer to interfaceInput.

Member Data Documentation

const UsdSchemaType schemaType = UsdSchemaType::SingleApplyAPI
static

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

See Also
UsdSchemaType

Definition at line 74 of file materialAPI.h.


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