Class UsdShadeMaterialBindingAPI
Inheritance
UsdShadeMaterialBindingAPI
Namespace: pxr
Syntax
public class UsdShadeMaterialBindingAPI : UsdAPISchemaBase, IDisposable
Constructors
UsdShadeMaterialBindingAPI()
Declaration
public UsdShadeMaterialBindingAPI()
UsdShadeMaterialBindingAPI(UsdPrim)
Declaration
public UsdShadeMaterialBindingAPI(UsdPrim prim)
Parameters
UsdShadeMaterialBindingAPI(UsdSchemaBase)
Declaration
public UsdShadeMaterialBindingAPI(UsdSchemaBase schemaObj)
Parameters
Methods
AddPrimToBindingCollection(UsdPrim, TfToken, TfToken)
Declaration
public bool AddPrimToBindingCollection(UsdPrim prim, TfToken bindingName, TfToken materialPurpose)
Parameters
Returns
Apply(UsdPrim)
Declaration
public static UsdShadeMaterialBindingAPI Apply(UsdPrim prim)
Parameters
Returns
Bind(UsdCollectionAPI, UsdShadeMaterial)
Declaration
public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material)
Parameters
Returns
Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken)
Declaration
public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName)
Parameters
Returns
Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken, TfToken)
Declaration
public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName, TfToken bindingStrength)
Parameters
Returns
Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken, TfToken, TfToken)
Declaration
public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName, TfToken bindingStrength, TfToken materialPurpose)
Parameters
Returns
Bind(UsdShadeMaterial)
Declaration
public bool Bind(UsdShadeMaterial material)
Parameters
Returns
Bind(UsdShadeMaterial, TfToken)
Declaration
public bool Bind(UsdShadeMaterial material, TfToken bindingStrength)
Parameters
Returns
Bind(UsdShadeMaterial, TfToken, TfToken)
Declaration
public bool Bind(UsdShadeMaterial material, TfToken bindingStrength, TfToken materialPurpose)
Parameters
Returns
ComputeBoundMaterial()
Declaration
public UsdShadeMaterial ComputeBoundMaterial()
Returns
ComputeBoundMaterial(TfToken)
Declaration
public UsdShadeMaterial ComputeBoundMaterial(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
Returns
ComputeBoundMaterial(TfToken, UsdRelationship)
Declaration
public UsdShadeMaterial ComputeBoundMaterial(TfToken materialPurpose, UsdRelationship bindingRel)
Parameters
Returns
ComputeBoundMaterials(UsdPrimVector)
Declaration
public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims)
Parameters
Returns
ComputeBoundMaterials(UsdPrimVector, TfToken)
Declaration
public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims, TfToken materialPurpose)
Parameters
Returns
ComputeBoundMaterials(UsdPrimVector, TfToken, UsdRelationshipVector)
Declaration
public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims, TfToken materialPurpose, UsdRelationshipVector bindingRels)
Parameters
Returns
CreateMaterialBindSubset(TfToken, VtIntArray)
Declaration
public UsdGeomSubset CreateMaterialBindSubset(TfToken subsetName, VtIntArray indices)
Parameters
Returns
CreateMaterialBindSubset(TfToken, VtIntArray, TfToken)
Declaration
public UsdGeomSubset CreateMaterialBindSubset(TfToken subsetName, VtIntArray indices, TfToken elementType)
Parameters
Returns
Dispose()
Declaration
public override void Dispose()
Overrides
Finalize()
Declaration
protected void Finalize()
Get(UsdStageWeakPtr, SdfPath)
Declaration
public static UsdShadeMaterialBindingAPI Get(UsdStageWeakPtr stage, SdfPath path)
Parameters
Returns
GetCollectionBindingRel(TfToken)
Declaration
public UsdRelationship GetCollectionBindingRel(TfToken bindingName)
Parameters
| Type |
Name |
Description |
| TfToken |
bindingName |
|
Returns
GetCollectionBindingRel(TfToken, TfToken)
Declaration
public UsdRelationship GetCollectionBindingRel(TfToken bindingName, TfToken materialPurpose)
Parameters
Returns
GetCollectionBindingRels()
Declaration
public UsdRelationshipVector GetCollectionBindingRels()
Returns
GetCollectionBindingRels(TfToken)
Declaration
public UsdRelationshipVector GetCollectionBindingRels(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
Returns
GetCollectionBindings()
Declaration
public UsdShadeMaterialBindingAPICollectionBindingVector GetCollectionBindings()
Returns
GetCollectionBindings(TfToken)
Declaration
public UsdShadeMaterialBindingAPICollectionBindingVector GetCollectionBindings(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
Returns
GetDirectBinding()
Declaration
public UsdShadeMaterialBindingAPI.DirectBinding GetDirectBinding()
Returns
GetDirectBinding(TfToken)
Declaration
public UsdShadeMaterialBindingAPI.DirectBinding GetDirectBinding(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
Returns
GetDirectBindingRel()
Declaration
public UsdRelationship GetDirectBindingRel()
Returns
GetDirectBindingRel(TfToken)
Declaration
public UsdRelationship GetDirectBindingRel(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
Returns
GetMaterialBindingStrength(UsdRelationship)
Declaration
public static TfToken GetMaterialBindingStrength(UsdRelationship bindingRel)
Parameters
Returns
GetMaterialBindSubsets()
Declaration
public UsdGeomSubsetVector GetMaterialBindSubsets()
Returns
GetMaterialBindSubsetsFamilyType()
Declaration
public TfToken GetMaterialBindSubsetsFamilyType()
Returns
GetSchemaAttributeNames()
Declaration
public static TfTokenVector GetSchemaAttributeNames()
Returns
GetSchemaAttributeNames(Boolean)
Declaration
public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
Parameters
| Type |
Name |
Description |
| Boolean |
includeInherited |
|
Returns
RemovePrimFromBindingCollection(UsdPrim, TfToken, TfToken)
Declaration
public bool RemovePrimFromBindingCollection(UsdPrim prim, TfToken bindingName, TfToken materialPurpose)
Parameters
Returns
SetMaterialBindingStrength(UsdRelationship, TfToken)
Declaration
public static bool SetMaterialBindingStrength(UsdRelationship bindingRel, TfToken bindingStrength)
Parameters
Returns
SetMaterialBindSubsetsFamilyType(TfToken)
Declaration
public bool SetMaterialBindSubsetsFamilyType(TfToken familyType)
Parameters
| Type |
Name |
Description |
| TfToken |
familyType |
|
Returns
UnbindAllBindings()
Declaration
public bool UnbindAllBindings()
Returns
UnbindCollectionBinding(TfToken)
Declaration
public bool UnbindCollectionBinding(TfToken bindingName)
Parameters
| Type |
Name |
Description |
| TfToken |
bindingName |
|
Returns
UnbindCollectionBinding(TfToken, TfToken)
Declaration
public bool UnbindCollectionBinding(TfToken bindingName, TfToken materialPurpose)
Parameters
Returns
UnbindDirectBinding()
Declaration
public bool UnbindDirectBinding()
Returns
UnbindDirectBinding(TfToken)
Declaration
public bool UnbindDirectBinding(TfToken materialPurpose)
Parameters
| Type |
Name |
Description |
| TfToken |
materialPurpose |
|
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.