docs.unity3d.com
    Show / Hide Table of Contents

    Class UsdAttribute

    Inheritance
    Object
    UsdObject
    UsdProperty
    UsdAttribute
    Inherited Members
    UsdProperty.GetPropertyStack(UsdTimeCode)
    UsdProperty.GetPropertyStack()
    UsdProperty.GetBaseName()
    UsdProperty.GetNamespace()
    UsdProperty.SplitName()
    UsdProperty.GetDisplayGroup()
    UsdProperty.SetDisplayGroup(String)
    UsdProperty.ClearDisplayGroup()
    UsdProperty.HasAuthoredDisplayGroup()
    UsdProperty.GetNestedDisplayGroups()
    UsdProperty.SetNestedDisplayGroups(StdStringVector)
    UsdProperty.GetDisplayName()
    UsdProperty.SetDisplayName(String)
    UsdProperty.ClearDisplayName()
    UsdProperty.HasAuthoredDisplayName()
    UsdProperty.IsCustom()
    UsdProperty.SetCustom(Boolean)
    UsdProperty.IsDefined()
    UsdProperty.IsAuthored()
    UsdProperty.IsAuthoredAt(UsdEditTarget)
    UsdProperty.FlattenTo(UsdPrim)
    UsdProperty.FlattenTo(UsdPrim, TfToken)
    UsdProperty.FlattenTo(UsdProperty)
    UsdObject.swigCMemOwn
    UsdObject.Equals(Object)
    UsdObject.IsValid()
    UsdObject.GetStage()
    UsdObject.GetPath()
    UsdObject.GetPrimPath()
    UsdObject.GetPrim()
    UsdObject.GetName()
    UsdObject.GetDescription()
    UsdObject.SetMetadata(TfToken, VtValue)
    UsdObject.ClearMetadata(TfToken)
    UsdObject.HasMetadata(TfToken)
    UsdObject.HasAuthoredMetadata(TfToken)
    UsdObject.SetMetadataByDictKey(TfToken, TfToken, VtValue)
    UsdObject.ClearMetadataByDictKey(TfToken, TfToken)
    UsdObject.HasMetadataDictKey(TfToken, TfToken)
    UsdObject.HasAuthoredMetadataDictKey(TfToken, TfToken)
    UsdObject.GetAllMetadata()
    UsdObject.GetAllAuthoredMetadata()
    UsdObject.IsHidden()
    UsdObject.SetHidden(Boolean)
    UsdObject.ClearHidden()
    UsdObject.HasAuthoredHidden()
    UsdObject.GetCustomData()
    UsdObject.GetCustomDataByKey(TfToken)
    UsdObject.SetCustomData(VtDictionary)
    UsdObject.SetCustomDataByKey(TfToken, VtValue)
    UsdObject.ClearCustomData()
    UsdObject.ClearCustomDataByKey(TfToken)
    UsdObject.HasCustomData()
    UsdObject.HasCustomDataKey(TfToken)
    UsdObject.HasAuthoredCustomData()
    UsdObject.HasAuthoredCustomDataKey(TfToken)
    UsdObject.GetAssetInfo()
    UsdObject.GetAssetInfoByKey(TfToken)
    UsdObject.SetAssetInfo(VtDictionary)
    UsdObject.SetAssetInfoByKey(TfToken, VtValue)
    UsdObject.ClearAssetInfo()
    UsdObject.ClearAssetInfoByKey(TfToken)
    UsdObject.HasAssetInfo()
    UsdObject.HasAssetInfoKey(TfToken)
    UsdObject.HasAuthoredAssetInfo()
    UsdObject.HasAuthoredAssetInfoKey(TfToken)
    UsdObject.GetDocumentation()
    UsdObject.SetDocumentation(String)
    UsdObject.ClearDocumentation()
    UsdObject.HasAuthoredDocumentation()
    UsdObject.GetNamespaceDelimiter()
    UsdObject.Equals(UsdObject, UsdObject)
    UsdObject.GetHashCode()
    UsdObject._IsValid()
    UsdObject.GetMetadata(TfToken)
    UsdObject.GetMetadataByDictKey(TfToken, TfToken)
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: pxr
    Syntax
    public class UsdAttribute : UsdProperty, IDisposable

    Constructors

    UsdAttribute()

    Declaration
    public UsdAttribute()

    Methods

    AddConnection(SdfPath)

    Declaration
    public bool AddConnection(SdfPath source)
    Parameters
    Type Name Description
    SdfPath source
    Returns
    Type Description
    Boolean

    AddConnection(SdfPath, UsdListPosition)

    Declaration
    public bool AddConnection(SdfPath source, UsdListPosition position)
    Parameters
    Type Name Description
    SdfPath source
    UsdListPosition position
    Returns
    Type Description
    Boolean

    Block()

    Declaration
    public void Block()

    BlockConnections()

    Declaration
    public bool BlockConnections()
    Returns
    Type Description
    Boolean

    Clear()

    Declaration
    public bool Clear()
    Returns
    Type Description
    Boolean

    ClearAtTime(UsdTimeCode)

    Declaration
    public bool ClearAtTime(UsdTimeCode time)
    Parameters
    Type Name Description
    UsdTimeCode time
    Returns
    Type Description
    Boolean

    ClearColorSpace()

    Declaration
    public bool ClearColorSpace()
    Returns
    Type Description
    Boolean

    ClearConnections()

    Declaration
    public bool ClearConnections()
    Returns
    Type Description
    Boolean

    ClearDefault()

    Declaration
    public bool ClearDefault()
    Returns
    Type Description
    Boolean

    Dispose()

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

    Finalize()

    Declaration
    protected void Finalize()

    Get()

    Declaration
    public VtValue Get()
    Returns
    Type Description
    VtValue

    Get(UsdTimeCode)

    Declaration
    public VtValue Get(UsdTimeCode time)
    Parameters
    Type Name Description
    UsdTimeCode time
    Returns
    Type Description
    VtValue

    Get(VtValue, UsdTimeCode)

    Declaration
    public bool Get(VtValue value, UsdTimeCode time)
    Parameters
    Type Name Description
    VtValue value
    UsdTimeCode time
    Returns
    Type Description
    Boolean

    GetBracketingTimeSamples(Double, out Double, out Double, out Double)

    Declaration
    public bool GetBracketingTimeSamples(double desiredTime, out double lower, out double upper, out double hasTimeSamples)
    Parameters
    Type Name Description
    Double desiredTime
    Double lower
    Double upper
    Double hasTimeSamples
    Returns
    Type Description
    Boolean

    GetColorSpace()

    Declaration
    public TfToken GetColorSpace()
    Returns
    Type Description
    TfToken

    GetConnections(SdfPathVector)

    Declaration
    public bool GetConnections(SdfPathVector sources)
    Parameters
    Type Name Description
    SdfPathVector sources
    Returns
    Type Description
    Boolean

    GetNumTimeSamples()

    Declaration
    public uint GetNumTimeSamples()
    Returns
    Type Description
    UInt32

    GetResolveInfo()

    Declaration
    public UsdResolveInfo GetResolveInfo()
    Returns
    Type Description
    UsdResolveInfo

    GetResolveInfo(UsdTimeCode)

    Declaration
    public UsdResolveInfo GetResolveInfo(UsdTimeCode time)
    Parameters
    Type Name Description
    UsdTimeCode time
    Returns
    Type Description
    UsdResolveInfo

    GetRoleName()

    Declaration
    public TfToken GetRoleName()
    Returns
    Type Description
    TfToken

    GetTimeSamples()

    Declaration
    public StdDoubleVector GetTimeSamples()
    Returns
    Type Description
    StdDoubleVector

    GetTimeSamplesInInterval(GfInterval)

    Declaration
    public StdDoubleVector GetTimeSamplesInInterval(GfInterval interval)
    Parameters
    Type Name Description
    GfInterval interval
    Returns
    Type Description
    StdDoubleVector

    GetTypeName()

    Declaration
    public SdfValueTypeName GetTypeName()
    Returns
    Type Description
    SdfValueTypeName

    GetUnionedTimeSamples(UsdAttributeVector, StdDoubleVector)

    Declaration
    public static bool GetUnionedTimeSamples(UsdAttributeVector attrs, StdDoubleVector times)
    Parameters
    Type Name Description
    UsdAttributeVector attrs
    StdDoubleVector times
    Returns
    Type Description
    Boolean

    GetUnionedTimeSamplesInInterval(UsdAttributeVector, GfInterval, StdDoubleVector)

    Declaration
    public static bool GetUnionedTimeSamplesInInterval(UsdAttributeVector attrs, GfInterval interval, StdDoubleVector times)
    Parameters
    Type Name Description
    UsdAttributeVector attrs
    GfInterval interval
    StdDoubleVector times
    Returns
    Type Description
    Boolean

    GetVariability()

    Declaration
    public SdfVariability GetVariability()
    Returns
    Type Description
    SdfVariability

    HasAuthoredConnections()

    Declaration
    public bool HasAuthoredConnections()
    Returns
    Type Description
    Boolean

    HasAuthoredValue()

    Declaration
    public bool HasAuthoredValue()
    Returns
    Type Description
    Boolean

    HasAuthoredValueOpinion()

    Declaration
    public bool HasAuthoredValueOpinion()
    Returns
    Type Description
    Boolean

    HasColorSpace()

    Declaration
    public bool HasColorSpace()
    Returns
    Type Description
    Boolean

    HasFallbackValue()

    Declaration
    public bool HasFallbackValue()
    Returns
    Type Description
    Boolean

    HasValue()

    Declaration
    public bool HasValue()
    Returns
    Type Description
    Boolean

    RemoveConnection(SdfPath)

    Declaration
    public bool RemoveConnection(SdfPath source)
    Parameters
    Type Name Description
    SdfPath source
    Returns
    Type Description
    Boolean

    Set(VtValue)

    Declaration
    public bool Set(VtValue value)
    Parameters
    Type Name Description
    VtValue value
    Returns
    Type Description
    Boolean

    Set(VtValue, UsdTimeCode)

    Declaration
    public bool Set(VtValue value, UsdTimeCode time)
    Parameters
    Type Name Description
    VtValue value
    UsdTimeCode time
    Returns
    Type Description
    Boolean

    SetColorSpace(TfToken)

    Declaration
    public void SetColorSpace(TfToken colorSpace)
    Parameters
    Type Name Description
    TfToken colorSpace

    SetConnections(SdfPathVector)

    Declaration
    public bool SetConnections(SdfPathVector sources)
    Parameters
    Type Name Description
    SdfPathVector sources
    Returns
    Type Description
    Boolean

    SetTypeName(SdfValueTypeName)

    Declaration
    public bool SetTypeName(SdfValueTypeName typeName)
    Parameters
    Type Name Description
    SdfValueTypeName typeName
    Returns
    Type Description
    Boolean

    SetVariability(SdfVariability)

    Declaration
    public bool SetVariability(SdfVariability variability)
    Parameters
    Type Name Description
    SdfVariability variability
    Returns
    Type Description
    Boolean

    ValueMightBeTimeVarying()

    Declaration
    public bool ValueMightBeTimeVarying()
    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