docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdModelAPI

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

    Constructors

    UsdModelAPI()

    Declaration
    public UsdModelAPI()

    UsdModelAPI(UsdPrim)

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

    UsdModelAPI(UsdSchemaBase)

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

    Methods

    Dispose()

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

    Finalize()

    Declaration
    protected void Finalize()

    Get(UsdStageWeakPtr, SdfPath)

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

    GetAssetIdentifier(SdfAssetPath)

    Declaration
    public bool GetAssetIdentifier(SdfAssetPath identifier)
    Parameters
    Type Name Description
    SdfAssetPath identifier
    Returns
    Type Description
    Boolean

    GetAssetInfo(VtDictionary)

    Declaration
    public bool GetAssetInfo(VtDictionary info)
    Parameters
    Type Name Description
    VtDictionary info
    Returns
    Type Description
    Boolean

    GetAssetName(SWIGTYPE_p_std__string)

    Declaration
    public bool GetAssetName(SWIGTYPE_p_std__string assetName)
    Parameters
    Type Name Description
    SWIGTYPE_p_std__string assetName
    Returns
    Type Description
    Boolean

    GetAssetVersion(SWIGTYPE_p_std__string)

    Declaration
    public bool GetAssetVersion(SWIGTYPE_p_std__string version)
    Parameters
    Type Name Description
    SWIGTYPE_p_std__string version
    Returns
    Type Description
    Boolean

    GetKind(TfToken)

    Declaration
    public bool GetKind(TfToken kind)
    Parameters
    Type Name Description
    TfToken kind
    Returns
    Type Description
    Boolean

    GetPayloadAssetDependencies(SdfAssetPathArray)

    Declaration
    public bool GetPayloadAssetDependencies(SdfAssetPathArray assetDeps)
    Parameters
    Type Name Description
    SdfAssetPathArray assetDeps
    Returns
    Type Description
    Boolean

    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

    IsGroup()

    Declaration
    public bool IsGroup()
    Returns
    Type Description
    Boolean

    IsKind(TfToken)

    Declaration
    public bool IsKind(TfToken baseKind)
    Parameters
    Type Name Description
    TfToken baseKind
    Returns
    Type Description
    Boolean

    IsKind(TfToken, UsdModelAPI.KindValidation)

    Declaration
    public bool IsKind(TfToken baseKind, UsdModelAPI.KindValidation validation)
    Parameters
    Type Name Description
    TfToken baseKind
    UsdModelAPI.KindValidation validation
    Returns
    Type Description
    Boolean

    IsModel()

    Declaration
    public bool IsModel()
    Returns
    Type Description
    Boolean

    SetAssetIdentifier(SdfAssetPath)

    Declaration
    public void SetAssetIdentifier(SdfAssetPath identifier)
    Parameters
    Type Name Description
    SdfAssetPath identifier

    SetAssetInfo(VtDictionary)

    Declaration
    public void SetAssetInfo(VtDictionary info)
    Parameters
    Type Name Description
    VtDictionary info

    SetAssetName(String)

    Declaration
    public void SetAssetName(string assetName)
    Parameters
    Type Name Description
    String assetName

    SetAssetVersion(String)

    Declaration
    public void SetAssetVersion(string version)
    Parameters
    Type Name Description
    String version

    SetKind(TfToken)

    Declaration
    public bool SetKind(TfToken kind)
    Parameters
    Type Name Description
    TfToken kind
    Returns
    Type Description
    Boolean

    SetPayloadAssetDependencies(SdfAssetPathArray)

    Declaration
    public void SetPayloadAssetDependencies(SdfAssetPathArray assetDeps)
    Parameters
    Type Name Description
    SdfAssetPathArray assetDeps
    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