docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdRiMaterialAPI

    Inheritance
    Object
    UsdSchemaBase
    UsdAPISchemaBase
    UsdRiMaterialAPI
    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 UsdRiMaterialAPI : UsdAPISchemaBase, IDisposable

    Constructors

    UsdRiMaterialAPI()

    Declaration
    public UsdRiMaterialAPI()

    UsdRiMaterialAPI(UsdPrim)

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

    UsdRiMaterialAPI(UsdSchemaBase)

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

    UsdRiMaterialAPI(UsdShadeMaterial)

    Declaration
    public UsdRiMaterialAPI(UsdShadeMaterial material)
    Parameters
    Type Name Description
    UsdShadeMaterial material

    Methods

    Apply(UsdPrim)

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

    ComputeInterfaceInputConsumersMap()

    Declaration
    public SWIGTYPE_p_std__unordered_mapT_UsdShadeInput_std__vectorT_UsdShadeInput_t_UsdShadeInput__Hash_t ComputeInterfaceInputConsumersMap()
    Returns
    Type Description
    SWIGTYPE_p_std__unordered_mapT_UsdShadeInput_std__vectorT_UsdShadeInput_t_UsdShadeInput__Hash_t

    ComputeInterfaceInputConsumersMap(Boolean)

    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
    Type Description
    SWIGTYPE_p_std__unordered_mapT_UsdShadeInput_std__vectorT_UsdShadeInput_t_UsdShadeInput__Hash_t

    CreateDisplacementAttr()

    Declaration
    public UsdAttribute CreateDisplacementAttr()
    Returns
    Type Description
    UsdAttribute

    CreateDisplacementAttr(VtValue)

    Declaration
    public UsdAttribute CreateDisplacementAttr(VtValue defaultValue)
    Parameters
    Type Name Description
    VtValue defaultValue
    Returns
    Type Description
    UsdAttribute

    CreateDisplacementAttr(VtValue, Boolean)

    Declaration
    public UsdAttribute CreateDisplacementAttr(VtValue defaultValue, bool writeSparsely)
    Parameters
    Type Name Description
    VtValue defaultValue
    Boolean writeSparsely
    Returns
    Type Description
    UsdAttribute

    CreateSurfaceAttr()

    Declaration
    public UsdAttribute CreateSurfaceAttr()
    Returns
    Type Description
    UsdAttribute

    CreateSurfaceAttr(VtValue)

    Declaration
    public UsdAttribute CreateSurfaceAttr(VtValue defaultValue)
    Parameters
    Type Name Description
    VtValue defaultValue
    Returns
    Type Description
    UsdAttribute

    CreateSurfaceAttr(VtValue, Boolean)

    Declaration
    public UsdAttribute CreateSurfaceAttr(VtValue defaultValue, bool writeSparsely)
    Parameters
    Type Name Description
    VtValue defaultValue
    Boolean writeSparsely
    Returns
    Type Description
    UsdAttribute

    CreateVolumeAttr()

    Declaration
    public UsdAttribute CreateVolumeAttr()
    Returns
    Type Description
    UsdAttribute

    CreateVolumeAttr(VtValue)

    Declaration
    public UsdAttribute CreateVolumeAttr(VtValue defaultValue)
    Parameters
    Type Name Description
    VtValue defaultValue
    Returns
    Type Description
    UsdAttribute

    CreateVolumeAttr(VtValue, Boolean)

    Declaration
    public UsdAttribute CreateVolumeAttr(VtValue defaultValue, bool writeSparsely)
    Parameters
    Type Name Description
    VtValue defaultValue
    Boolean writeSparsely
    Returns
    Type Description
    UsdAttribute

    Dispose()

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

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

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

    GetDisplacement()

    Declaration
    public UsdShadeShader GetDisplacement()
    Returns
    Type Description
    UsdShadeShader

    GetDisplacement(Boolean)

    Declaration
    public UsdShadeShader GetDisplacement(bool ignoreBaseMaterial)
    Parameters
    Type Name Description
    Boolean ignoreBaseMaterial
    Returns
    Type Description
    UsdShadeShader

    GetDisplacementAttr()

    Declaration
    public UsdAttribute GetDisplacementAttr()
    Returns
    Type Description
    UsdAttribute

    GetDisplacementOutput()

    Declaration
    public UsdShadeOutput GetDisplacementOutput()
    Returns
    Type Description
    UsdShadeOutput

    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

    GetSurface()

    Declaration
    public UsdShadeShader GetSurface()
    Returns
    Type Description
    UsdShadeShader

    GetSurface(Boolean)

    Declaration
    public UsdShadeShader GetSurface(bool ignoreBaseMaterial)
    Parameters
    Type Name Description
    Boolean ignoreBaseMaterial
    Returns
    Type Description
    UsdShadeShader

    GetSurfaceAttr()

    Declaration
    public UsdAttribute GetSurfaceAttr()
    Returns
    Type Description
    UsdAttribute

    GetSurfaceOutput()

    Declaration
    public UsdShadeOutput GetSurfaceOutput()
    Returns
    Type Description
    UsdShadeOutput

    GetVolume()

    Declaration
    public UsdShadeShader GetVolume()
    Returns
    Type Description
    UsdShadeShader

    GetVolume(Boolean)

    Declaration
    public UsdShadeShader GetVolume(bool ignoreBaseMaterial)
    Parameters
    Type Name Description
    Boolean ignoreBaseMaterial
    Returns
    Type Description
    UsdShadeShader

    GetVolumeAttr()

    Declaration
    public UsdAttribute GetVolumeAttr()
    Returns
    Type Description
    UsdAttribute

    GetVolumeOutput()

    Declaration
    public UsdShadeOutput GetVolumeOutput()
    Returns
    Type Description
    UsdShadeOutput

    SetDisplacementSource(SdfPath)

    Declaration
    public bool SetDisplacementSource(SdfPath displacementPath)
    Parameters
    Type Name Description
    SdfPath displacementPath
    Returns
    Type Description
    Boolean

    SetSurfaceSource(SdfPath)

    Declaration
    public bool SetSurfaceSource(SdfPath surfacePath)
    Parameters
    Type Name Description
    SdfPath surfacePath
    Returns
    Type Description
    Boolean

    SetVolumeSource(SdfPath)

    Declaration
    public bool SetVolumeSource(SdfPath volumePath)
    Parameters
    Type Name Description
    SdfPath volumePath
    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