Class UsdRiMaterialAPI
Inheritance
UsdRiMaterialAPI
Namespace: pxr
Syntax
public class UsdRiMaterialAPI : UsdAPISchemaBase, IDisposable
Constructors
UsdRiMaterialAPI()
Declaration
public UsdRiMaterialAPI()
UsdRiMaterialAPI(UsdPrim)
Declaration
public UsdRiMaterialAPI(UsdPrim prim)
Parameters
UsdRiMaterialAPI(UsdSchemaBase)
Declaration
public UsdRiMaterialAPI(UsdSchemaBase schemaObj)
Parameters
UsdRiMaterialAPI(UsdShadeMaterial)
Declaration
public UsdRiMaterialAPI(UsdShadeMaterial material)
Parameters
Methods
Apply(UsdPrim)
Declaration
public static UsdRiMaterialAPI Apply(UsdPrim prim)
Parameters
Returns
Declaration
public SWIGTYPE_p_std__unordered_mapT_UsdShadeInput_std__vectorT_UsdShadeInput_t_UsdShadeInput__Hash_t ComputeInterfaceInputConsumersMap()
Returns
Declaration
public SWIGTYPE_p_std__unordered_mapT_UsdShadeInput_std__vectorT_UsdShadeInput_t_UsdShadeInput__Hash_t ComputeInterfaceInputConsumersMap(bool computeTransitiveConsumers)
Parameters
| Type |
Name |
Description |
| Boolean |
computeTransitiveConsumers |
|
Returns
CreateDisplacementAttr()
Declaration
public UsdAttribute CreateDisplacementAttr()
Returns
CreateDisplacementAttr(VtValue)
Declaration
public UsdAttribute CreateDisplacementAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateDisplacementAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateDisplacementAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateSurfaceAttr()
Declaration
public UsdAttribute CreateSurfaceAttr()
Returns
CreateSurfaceAttr(VtValue)
Declaration
public UsdAttribute CreateSurfaceAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateSurfaceAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateSurfaceAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
CreateVolumeAttr()
Declaration
public UsdAttribute CreateVolumeAttr()
Returns
CreateVolumeAttr(VtValue)
Declaration
public UsdAttribute CreateVolumeAttr(VtValue defaultValue)
Parameters
| Type |
Name |
Description |
| VtValue |
defaultValue |
|
Returns
CreateVolumeAttr(VtValue, Boolean)
Declaration
public UsdAttribute CreateVolumeAttr(VtValue defaultValue, bool writeSparsely)
Parameters
Returns
Dispose()
Declaration
public override void Dispose()
Overrides
Finalize()
Declaration
protected void Finalize()
Get(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdRiMaterialAPI Get(UsdStageWeakPtr stage, SdfPath path)
Parameters
Returns
GetDisplacement()
Declaration
public UsdShadeShader GetDisplacement()
Returns
GetDisplacement(Boolean)
Declaration
public UsdShadeShader GetDisplacement(bool ignoreBaseMaterial)
Parameters
| Type |
Name |
Description |
| Boolean |
ignoreBaseMaterial |
|
Returns
GetDisplacementAttr()
Declaration
public UsdAttribute GetDisplacementAttr()
Returns
GetDisplacementOutput()
Declaration
public UsdShadeOutput GetDisplacementOutput()
Returns
GetSchemaAttributeNames()
Declaration
public static TfTokenVector GetSchemaAttributeNames()
Returns
GetSchemaAttributeNames(Boolean)
Declaration
public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
Parameters
| Type |
Name |
Description |
| Boolean |
includeInherited |
|
Returns
GetSurface()
Declaration
public UsdShadeShader GetSurface()
Returns
GetSurface(Boolean)
Declaration
public UsdShadeShader GetSurface(bool ignoreBaseMaterial)
Parameters
| Type |
Name |
Description |
| Boolean |
ignoreBaseMaterial |
|
Returns
GetSurfaceAttr()
Declaration
public UsdAttribute GetSurfaceAttr()
Returns
GetSurfaceOutput()
Declaration
public UsdShadeOutput GetSurfaceOutput()
Returns
GetVolume()
Declaration
public UsdShadeShader GetVolume()
Returns
GetVolume(Boolean)
Declaration
public UsdShadeShader GetVolume(bool ignoreBaseMaterial)
Parameters
| Type |
Name |
Description |
| Boolean |
ignoreBaseMaterial |
|
Returns
GetVolumeAttr()
Declaration
public UsdAttribute GetVolumeAttr()
Returns
GetVolumeOutput()
Declaration
public UsdShadeOutput GetVolumeOutput()
Returns
SetDisplacementSource(SdfPath)
Declaration
public bool SetDisplacementSource(SdfPath displacementPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
displacementPath |
|
Returns
SetSurfaceSource(SdfPath)
Declaration
public bool SetSurfaceSource(SdfPath surfacePath)
Parameters
| Type |
Name |
Description |
| SdfPath |
surfacePath |
|
Returns
SetVolumeSource(SdfPath)
Declaration
public bool SetVolumeSource(SdfPath volumePath)
Parameters
| Type |
Name |
Description |
| SdfPath |
volumePath |
|
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.