docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdShadeMaterialBindingAPI

    Inheritance
    Object
    UsdSchemaBase
    UsdAPISchemaBase
    UsdShadeMaterialBindingAPI
    Inherited Members
    UsdSchemaBase.swigCMemOwn
    UsdSchemaBase.IsConcrete()
    UsdSchemaBase.IsTyped()
    UsdSchemaBase.IsAPISchema()
    UsdSchemaBase.IsAppliedAPISchema()
    UsdSchemaBase.IsMultipleApplyAPISchema()
    UsdSchemaBase.GetSchemaType()
    UsdSchemaBase.GetPrim()
    UsdSchemaBase.GetPath()
    UsdSchemaBase.GetSchemaClassPrimDefinition()
    UsdSchemaBase.Equals(UsdSchemaBase, UsdSchemaBase)
    UsdSchemaBase.GetHashCode()
    UsdSchemaBase.Equals(Object)
    UsdSchemaBase._IsValid()
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: pxr
    Syntax
    public class UsdShadeMaterialBindingAPI : UsdAPISchemaBase, IDisposable

    Constructors

    UsdShadeMaterialBindingAPI()

    Declaration
    public UsdShadeMaterialBindingAPI()

    UsdShadeMaterialBindingAPI(UsdPrim)

    Declaration
    public UsdShadeMaterialBindingAPI(UsdPrim prim)
    Parameters
    Type Name Description
    UsdPrim prim

    UsdShadeMaterialBindingAPI(UsdSchemaBase)

    Declaration
    public UsdShadeMaterialBindingAPI(UsdSchemaBase schemaObj)
    Parameters
    Type Name Description
    UsdSchemaBase schemaObj

    Methods

    AddPrimToBindingCollection(UsdPrim, TfToken, TfToken)

    Declaration
    public bool AddPrimToBindingCollection(UsdPrim prim, TfToken bindingName, TfToken materialPurpose)
    Parameters
    Type Name Description
    UsdPrim prim
    TfToken bindingName
    TfToken materialPurpose
    Returns
    Type Description
    Boolean

    Apply(UsdPrim)

    Declaration
    public static UsdShadeMaterialBindingAPI Apply(UsdPrim prim)
    Parameters
    Type Name Description
    UsdPrim prim
    Returns
    Type Description
    UsdShadeMaterialBindingAPI

    Bind(UsdCollectionAPI, UsdShadeMaterial)

    Declaration
    public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material)
    Parameters
    Type Name Description
    UsdCollectionAPI collection
    UsdShadeMaterial material
    Returns
    Type Description
    Boolean

    Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken)

    Declaration
    public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName)
    Parameters
    Type Name Description
    UsdCollectionAPI collection
    UsdShadeMaterial material
    TfToken bindingName
    Returns
    Type Description
    Boolean

    Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken, TfToken)

    Declaration
    public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName, TfToken bindingStrength)
    Parameters
    Type Name Description
    UsdCollectionAPI collection
    UsdShadeMaterial material
    TfToken bindingName
    TfToken bindingStrength
    Returns
    Type Description
    Boolean

    Bind(UsdCollectionAPI, UsdShadeMaterial, TfToken, TfToken, TfToken)

    Declaration
    public bool Bind(UsdCollectionAPI collection, UsdShadeMaterial material, TfToken bindingName, TfToken bindingStrength, TfToken materialPurpose)
    Parameters
    Type Name Description
    UsdCollectionAPI collection
    UsdShadeMaterial material
    TfToken bindingName
    TfToken bindingStrength
    TfToken materialPurpose
    Returns
    Type Description
    Boolean

    Bind(UsdShadeMaterial)

    Declaration
    public bool Bind(UsdShadeMaterial material)
    Parameters
    Type Name Description
    UsdShadeMaterial material
    Returns
    Type Description
    Boolean

    Bind(UsdShadeMaterial, TfToken)

    Declaration
    public bool Bind(UsdShadeMaterial material, TfToken bindingStrength)
    Parameters
    Type Name Description
    UsdShadeMaterial material
    TfToken bindingStrength
    Returns
    Type Description
    Boolean

    Bind(UsdShadeMaterial, TfToken, TfToken)

    Declaration
    public bool Bind(UsdShadeMaterial material, TfToken bindingStrength, TfToken materialPurpose)
    Parameters
    Type Name Description
    UsdShadeMaterial material
    TfToken bindingStrength
    TfToken materialPurpose
    Returns
    Type Description
    Boolean

    ComputeBoundMaterial()

    Declaration
    public UsdShadeMaterial ComputeBoundMaterial()
    Returns
    Type Description
    UsdShadeMaterial

    ComputeBoundMaterial(TfToken)

    Declaration
    public UsdShadeMaterial ComputeBoundMaterial(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    UsdShadeMaterial

    ComputeBoundMaterial(TfToken, UsdRelationship)

    Declaration
    public UsdShadeMaterial ComputeBoundMaterial(TfToken materialPurpose, UsdRelationship bindingRel)
    Parameters
    Type Name Description
    TfToken materialPurpose
    UsdRelationship bindingRel
    Returns
    Type Description
    UsdShadeMaterial

    ComputeBoundMaterials(UsdPrimVector)

    Declaration
    public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims)
    Parameters
    Type Name Description
    UsdPrimVector prims
    Returns
    Type Description
    UsdShadeMaterialVector

    ComputeBoundMaterials(UsdPrimVector, TfToken)

    Declaration
    public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims, TfToken materialPurpose)
    Parameters
    Type Name Description
    UsdPrimVector prims
    TfToken materialPurpose
    Returns
    Type Description
    UsdShadeMaterialVector

    ComputeBoundMaterials(UsdPrimVector, TfToken, UsdRelationshipVector)

    Declaration
    public static UsdShadeMaterialVector ComputeBoundMaterials(UsdPrimVector prims, TfToken materialPurpose, UsdRelationshipVector bindingRels)
    Parameters
    Type Name Description
    UsdPrimVector prims
    TfToken materialPurpose
    UsdRelationshipVector bindingRels
    Returns
    Type Description
    UsdShadeMaterialVector

    CreateMaterialBindSubset(TfToken, VtIntArray)

    Declaration
    public UsdGeomSubset CreateMaterialBindSubset(TfToken subsetName, VtIntArray indices)
    Parameters
    Type Name Description
    TfToken subsetName
    VtIntArray indices
    Returns
    Type Description
    UsdGeomSubset

    CreateMaterialBindSubset(TfToken, VtIntArray, TfToken)

    Declaration
    public UsdGeomSubset CreateMaterialBindSubset(TfToken subsetName, VtIntArray indices, TfToken elementType)
    Parameters
    Type Name Description
    TfToken subsetName
    VtIntArray indices
    TfToken elementType
    Returns
    Type Description
    UsdGeomSubset

    Dispose()

    Declaration
    public override void Dispose()
    Overrides
    UsdAPISchemaBase.Dispose()

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

    Declaration
    public static UsdShadeMaterialBindingAPI Get(UsdStageWeakPtr stage, SdfPath path)
    Parameters
    Type Name Description
    UsdStageWeakPtr stage
    SdfPath path
    Returns
    Type Description
    UsdShadeMaterialBindingAPI

    GetCollectionBindingRel(TfToken)

    Declaration
    public UsdRelationship GetCollectionBindingRel(TfToken bindingName)
    Parameters
    Type Name Description
    TfToken bindingName
    Returns
    Type Description
    UsdRelationship

    GetCollectionBindingRel(TfToken, TfToken)

    Declaration
    public UsdRelationship GetCollectionBindingRel(TfToken bindingName, TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken bindingName
    TfToken materialPurpose
    Returns
    Type Description
    UsdRelationship

    GetCollectionBindingRels()

    Declaration
    public UsdRelationshipVector GetCollectionBindingRels()
    Returns
    Type Description
    UsdRelationshipVector

    GetCollectionBindingRels(TfToken)

    Declaration
    public UsdRelationshipVector GetCollectionBindingRels(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    UsdRelationshipVector

    GetCollectionBindings()

    Declaration
    public UsdShadeMaterialBindingAPICollectionBindingVector GetCollectionBindings()
    Returns
    Type Description
    UsdShadeMaterialBindingAPICollectionBindingVector

    GetCollectionBindings(TfToken)

    Declaration
    public UsdShadeMaterialBindingAPICollectionBindingVector GetCollectionBindings(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    UsdShadeMaterialBindingAPICollectionBindingVector

    GetDirectBinding()

    Declaration
    public UsdShadeMaterialBindingAPI.DirectBinding GetDirectBinding()
    Returns
    Type Description
    UsdShadeMaterialBindingAPI.DirectBinding

    GetDirectBinding(TfToken)

    Declaration
    public UsdShadeMaterialBindingAPI.DirectBinding GetDirectBinding(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    UsdShadeMaterialBindingAPI.DirectBinding

    GetDirectBindingRel()

    Declaration
    public UsdRelationship GetDirectBindingRel()
    Returns
    Type Description
    UsdRelationship

    GetDirectBindingRel(TfToken)

    Declaration
    public UsdRelationship GetDirectBindingRel(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    UsdRelationship

    GetMaterialBindingStrength(UsdRelationship)

    Declaration
    public static TfToken GetMaterialBindingStrength(UsdRelationship bindingRel)
    Parameters
    Type Name Description
    UsdRelationship bindingRel
    Returns
    Type Description
    TfToken

    GetMaterialBindSubsets()

    Declaration
    public UsdGeomSubsetVector GetMaterialBindSubsets()
    Returns
    Type Description
    UsdGeomSubsetVector

    GetMaterialBindSubsetsFamilyType()

    Declaration
    public TfToken GetMaterialBindSubsetsFamilyType()
    Returns
    Type Description
    TfToken

    GetSchemaAttributeNames()

    Declaration
    public static TfTokenVector GetSchemaAttributeNames()
    Returns
    Type Description
    TfTokenVector

    GetSchemaAttributeNames(Boolean)

    Declaration
    public static TfTokenVector GetSchemaAttributeNames(bool includeInherited)
    Parameters
    Type Name Description
    Boolean includeInherited
    Returns
    Type Description
    TfTokenVector

    RemovePrimFromBindingCollection(UsdPrim, TfToken, TfToken)

    Declaration
    public bool RemovePrimFromBindingCollection(UsdPrim prim, TfToken bindingName, TfToken materialPurpose)
    Parameters
    Type Name Description
    UsdPrim prim
    TfToken bindingName
    TfToken materialPurpose
    Returns
    Type Description
    Boolean

    SetMaterialBindingStrength(UsdRelationship, TfToken)

    Declaration
    public static bool SetMaterialBindingStrength(UsdRelationship bindingRel, TfToken bindingStrength)
    Parameters
    Type Name Description
    UsdRelationship bindingRel
    TfToken bindingStrength
    Returns
    Type Description
    Boolean

    SetMaterialBindSubsetsFamilyType(TfToken)

    Declaration
    public bool SetMaterialBindSubsetsFamilyType(TfToken familyType)
    Parameters
    Type Name Description
    TfToken familyType
    Returns
    Type Description
    Boolean

    UnbindAllBindings()

    Declaration
    public bool UnbindAllBindings()
    Returns
    Type Description
    Boolean

    UnbindCollectionBinding(TfToken)

    Declaration
    public bool UnbindCollectionBinding(TfToken bindingName)
    Parameters
    Type Name Description
    TfToken bindingName
    Returns
    Type Description
    Boolean

    UnbindCollectionBinding(TfToken, TfToken)

    Declaration
    public bool UnbindCollectionBinding(TfToken bindingName, TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken bindingName
    TfToken materialPurpose
    Returns
    Type Description
    Boolean

    UnbindDirectBinding()

    Declaration
    public bool UnbindDirectBinding()
    Returns
    Type Description
    Boolean

    UnbindDirectBinding(TfToken)

    Declaration
    public bool UnbindDirectBinding(TfToken materialPurpose)
    Parameters
    Type Name Description
    TfToken materialPurpose
    Returns
    Type Description
    Boolean
    Back to top
    Copyright © 2023 Unity Technologies
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on Thursday, October 19, 2023