Class UsdObject
Namespace: pxr
Syntax
public class UsdObject : IDisposable
Constructors
UsdObject()
Declaration
Fields
swigCMemOwn
Declaration
protected bool swigCMemOwn
Field Value
Methods
_IsValid()
Declaration
Returns
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
ClearHidden()
Declaration
public bool ClearHidden()
Returns
Declaration
public bool ClearMetadata(TfToken key)
Parameters
Returns
Declaration
public bool ClearMetadataByDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
Dispose()
Declaration
public virtual void Dispose()
Implements
Equals(UsdObject, UsdObject)
Declaration
public static bool Equals(UsdObject lhs, UsdObject rhs)
Parameters
Returns
Equals(Object)
Declaration
public override bool Equals(object rhs)
Parameters
| Type |
Name |
Description |
| Object |
rhs |
|
Returns
Overrides
Finalize()
Declaration
protected void Finalize()
Declaration
public UsdMetadataValueMap GetAllAuthoredMetadata()
Returns
Declaration
public UsdMetadataValueMap GetAllMetadata()
Returns
GetAssetInfo()
Declaration
public VtDictionary GetAssetInfo()
Returns
GetAssetInfoByKey(TfToken)
Declaration
public VtValue GetAssetInfoByKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
GetCustomData()
Declaration
public VtDictionary GetCustomData()
Returns
GetCustomDataByKey(TfToken)
Declaration
public VtValue GetCustomDataByKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
GetDescription()
Declaration
public string GetDescription()
Returns
GetDocumentation()
Declaration
public string GetDocumentation()
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
Declaration
public VtValue GetMetadata(TfToken key)
Parameters
Returns
Declaration
public VtValue GetMetadataByDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
GetName()
Declaration
Returns
GetNamespaceDelimiter()
Declaration
public static char GetNamespaceDelimiter()
Returns
GetPath()
Declaration
Returns
GetPrim()
Declaration
Returns
GetPrimPath()
Declaration
public SdfPath GetPrimPath()
Returns
GetStage()
Declaration
public UsdStageWeakPtr GetStage()
Returns
HasAssetInfo()
Declaration
public bool HasAssetInfo()
Returns
HasAssetInfoKey(TfToken)
Declaration
public bool HasAssetInfoKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
HasAuthoredAssetInfo()
Declaration
public bool HasAuthoredAssetInfo()
Returns
HasAuthoredAssetInfoKey(TfToken)
Declaration
public bool HasAuthoredAssetInfoKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
HasAuthoredCustomData()
Declaration
public bool HasAuthoredCustomData()
Returns
HasAuthoredCustomDataKey(TfToken)
Declaration
public bool HasAuthoredCustomDataKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
HasAuthoredDocumentation()
Declaration
public bool HasAuthoredDocumentation()
Returns
HasAuthoredHidden()
Declaration
public bool HasAuthoredHidden()
Returns
Declaration
public bool HasAuthoredMetadata(TfToken key)
Parameters
Returns
Declaration
public bool HasAuthoredMetadataDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
HasCustomData()
Declaration
public bool HasCustomData()
Returns
HasCustomDataKey(TfToken)
Declaration
public bool HasCustomDataKey(TfToken keyPath)
Parameters
| Type |
Name |
Description |
| TfToken |
keyPath |
|
Returns
Declaration
public bool HasMetadata(TfToken key)
Parameters
Returns
Declaration
public bool HasMetadataDictKey(TfToken key, TfToken keyPath)
Parameters
Returns
IsHidden()
Declaration
Returns
IsValid()
Declaration
Returns
SetAssetInfo(VtDictionary)
Declaration
public void SetAssetInfo(VtDictionary customData)
Parameters
SetAssetInfoByKey(TfToken, VtValue)
Declaration
public void SetAssetInfoByKey(TfToken keyPath, VtValue value)
Parameters
SetCustomData(VtDictionary)
Declaration
public void SetCustomData(VtDictionary customData)
Parameters
SetCustomDataByKey(TfToken, VtValue)
Declaration
public void SetCustomDataByKey(TfToken keyPath, VtValue value)
Parameters
SetDocumentation(String)
Declaration
public bool SetDocumentation(string doc)
Parameters
| Type |
Name |
Description |
| String |
doc |
|
Returns
SetHidden(Boolean)
Declaration
public bool SetHidden(bool hidden)
Parameters
| Type |
Name |
Description |
| Boolean |
hidden |
|
Returns
Declaration
public bool SetMetadata(TfToken key, VtValue value)
Parameters
Returns
Declaration
public bool SetMetadataByDictKey(TfToken key, TfToken keyPath, VtValue value)
Parameters
Returns
Operators
Equality(UsdObject, UsdObject)
Declaration
public static bool operator ==(UsdObject lhs, UsdObject rhs)
Parameters
Returns
Implicit(UsdObject to Boolean)
Declaration
public static implicit operator bool (UsdObject obj)
Parameters
Returns
Inequality(UsdObject, UsdObject)
Declaration
public static bool operator !=(UsdObject lhs, UsdObject rhs)
Parameters
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.