Class UsdObject

Inheritance

Object

UsdObject

UsdPrim

UsdProperty

Inherited Members

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class UsdObject : IDisposable

Constructors

UsdObject()

Declaration

public UsdObject()

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
Boolean

Methods

_IsValid()

Declaration

public bool _IsValid()

Returns

Type	Description
Boolean

ClearAssetInfo()

Declaration

public void ClearAssetInfo()

ClearAssetInfoByKey(TfToken)

Declaration

public void ClearAssetInfoByKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

ClearCustomData()

Declaration

public void ClearCustomData()

ClearCustomDataByKey(TfToken)

Declaration

public void ClearCustomDataByKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

ClearDocumentation()

Declaration

public bool ClearDocumentation()

Returns

Type	Description
Boolean

ClearHidden()

Declaration

public bool ClearHidden()

Returns

Type	Description
Boolean

ClearMetadata(TfToken)

Declaration

public bool ClearMetadata(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
Boolean

ClearMetadataByDictKey(TfToken, TfToken)

Declaration

public bool ClearMetadataByDictKey(TfToken key, TfToken keyPath)

Parameters

Type	Name	Description
TfToken	key
TfToken	keyPath

Returns

Type	Description
Boolean

Dispose()

Declaration

public virtual void Dispose()

Implements

IDisposable.Dispose()

Equals(UsdObject, UsdObject)

Declaration

public static bool Equals(UsdObject lhs, UsdObject rhs)

Parameters

Type	Name	Description
UsdObject	lhs
UsdObject	rhs

Returns

Type	Description
Boolean

Equals(Object)

Declaration

public override bool Equals(object rhs)

Parameters

Type	Name	Description
Object	rhs

Returns

Type	Description
Boolean

Overrides

Object.Equals(Object)

Finalize()

Declaration

protected void Finalize()

GetAllAuthoredMetadata()

Declaration

public UsdMetadataValueMap GetAllAuthoredMetadata()

Returns

Type	Description
UsdMetadataValueMap

GetAllMetadata()

Declaration

public UsdMetadataValueMap GetAllMetadata()

Returns

Type	Description
UsdMetadataValueMap

GetAssetInfo()

Declaration

public VtDictionary GetAssetInfo()

Returns

Type	Description
VtDictionary

GetAssetInfoByKey(TfToken)

Declaration

public VtValue GetAssetInfoByKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
VtValue

GetCustomData()

Declaration

public VtDictionary GetCustomData()

Returns

Type	Description
VtDictionary

GetCustomDataByKey(TfToken)

Declaration

public VtValue GetCustomDataByKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
VtValue

GetDescription()

Declaration

public string GetDescription()

Returns

Type	Description
String

GetDocumentation()

Declaration

public string GetDocumentation()

Returns

Type	Description
String

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetMetadata(TfToken)

Declaration

public VtValue GetMetadata(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
VtValue

GetMetadataByDictKey(TfToken, TfToken)

Declaration

public VtValue GetMetadataByDictKey(TfToken key, TfToken keyPath)

Parameters

Type	Name	Description
TfToken	key
TfToken	keyPath

Returns

Type	Description
VtValue

GetName()

Declaration

public TfToken GetName()

Returns

Type	Description
TfToken

GetNamespaceDelimiter()

Declaration

public static char GetNamespaceDelimiter()

Returns

Type	Description
Char

GetPath()

Declaration

public SdfPath GetPath()

Returns

Type	Description
SdfPath

GetPrim()

Declaration

public UsdPrim GetPrim()

Returns

Type	Description
UsdPrim

GetPrimPath()

Declaration

public SdfPath GetPrimPath()

Returns

Type	Description
SdfPath

GetStage()

Declaration

public UsdStageWeakPtr GetStage()

Returns

Type	Description
UsdStageWeakPtr

HasAssetInfo()

Declaration

public bool HasAssetInfo()

Returns

Type	Description
Boolean

HasAssetInfoKey(TfToken)

Declaration

public bool HasAssetInfoKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
Boolean

HasAuthoredAssetInfo()

Declaration

public bool HasAuthoredAssetInfo()

Returns

Type	Description
Boolean

HasAuthoredAssetInfoKey(TfToken)

Declaration

public bool HasAuthoredAssetInfoKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
Boolean

HasAuthoredCustomData()

Declaration

public bool HasAuthoredCustomData()

Returns

Type	Description
Boolean

HasAuthoredCustomDataKey(TfToken)

Declaration

public bool HasAuthoredCustomDataKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
Boolean

HasAuthoredDocumentation()

Declaration

public bool HasAuthoredDocumentation()

Returns

Type	Description
Boolean

HasAuthoredHidden()

Declaration

public bool HasAuthoredHidden()

Returns

Type	Description
Boolean

HasAuthoredMetadata(TfToken)

Declaration

public bool HasAuthoredMetadata(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
Boolean

HasAuthoredMetadataDictKey(TfToken, TfToken)

Declaration

public bool HasAuthoredMetadataDictKey(TfToken key, TfToken keyPath)

Parameters

Type	Name	Description
TfToken	key
TfToken	keyPath

Returns

Type	Description
Boolean

HasCustomData()

Declaration

public bool HasCustomData()

Returns

Type	Description
Boolean

HasCustomDataKey(TfToken)

Declaration

public bool HasCustomDataKey(TfToken keyPath)

Parameters

Type	Name	Description
TfToken	keyPath

Returns

Type	Description
Boolean

HasMetadata(TfToken)

Declaration

public bool HasMetadata(TfToken key)

Parameters

Type	Name	Description
TfToken	key

Returns

Type	Description
Boolean

HasMetadataDictKey(TfToken, TfToken)

Declaration

public bool HasMetadataDictKey(TfToken key, TfToken keyPath)

Parameters

Type	Name	Description
TfToken	key
TfToken	keyPath

Returns

Type	Description
Boolean

IsHidden()

Declaration

public bool IsHidden()

Returns

Type	Description
Boolean

IsValid()

Declaration

public bool IsValid()

Returns

Type	Description
Boolean

SetAssetInfo(VtDictionary)

Declaration

public void SetAssetInfo(VtDictionary customData)

Parameters

Type	Name	Description
VtDictionary	customData

SetAssetInfoByKey(TfToken, VtValue)

Declaration

public void SetAssetInfoByKey(TfToken keyPath, VtValue value)

Parameters

Type	Name	Description
TfToken	keyPath
VtValue	value

SetCustomData(VtDictionary)

Declaration

public void SetCustomData(VtDictionary customData)

Parameters

Type	Name	Description
VtDictionary	customData

SetCustomDataByKey(TfToken, VtValue)

Declaration

public void SetCustomDataByKey(TfToken keyPath, VtValue value)

Parameters

Type	Name	Description
TfToken	keyPath
VtValue	value

SetDocumentation(String)

Declaration

public bool SetDocumentation(string doc)

Parameters

Type	Name	Description
String	doc

Returns

Type	Description
Boolean

SetHidden(Boolean)

Declaration

public bool SetHidden(bool hidden)

Parameters

Type	Name	Description
Boolean	hidden

Returns

Type	Description
Boolean

SetMetadata(TfToken, VtValue)

Declaration

public bool SetMetadata(TfToken key, VtValue value)

Parameters

Type	Name	Description
TfToken	key
VtValue	value

Returns

Type	Description
Boolean

SetMetadataByDictKey(TfToken, TfToken, VtValue)

Declaration

public bool SetMetadataByDictKey(TfToken key, TfToken keyPath, VtValue value)

Parameters

Type	Name	Description
TfToken	key
TfToken	keyPath
VtValue	value

Returns

Type	Description
Boolean

Operators

Equality(UsdObject, UsdObject)

Declaration

public static bool operator ==(UsdObject lhs, UsdObject rhs)

Parameters

Type	Name	Description
UsdObject	lhs
UsdObject	rhs

Returns

Type	Description
Boolean

Implicit(UsdObject to Boolean)

Declaration

public static implicit operator bool (UsdObject obj)

Parameters

Type	Name	Description
UsdObject	obj

Returns

Type	Description
Boolean

Inequality(UsdObject, UsdObject)

Declaration

public static bool operator !=(UsdObject lhs, UsdObject rhs)

Parameters

Type	Name	Description
UsdObject	lhs
UsdObject	rhs

Returns

Type	Description
Boolean