Class UsdPrim

Inheritance

Object

UsdObject

UsdPrim

Inherited Members

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 UsdPrim : UsdObject, IDisposable

Constructors

UsdPrim()

Declaration

public UsdPrim()

Methods

AddAppliedSchema(TfToken)

Declaration

public bool AddAppliedSchema(TfToken appliedSchemaName)

Parameters

Type	Name	Description
TfToken	appliedSchemaName

Returns

Type	Description
Boolean

ApplyAPI(TfType)

Declaration

public bool ApplyAPI(TfType schemaType)

Parameters

Type	Name	Description
TfType	schemaType

Returns

Type	Description
Boolean

ApplyAPI(TfType, TfToken)

Declaration

public bool ApplyAPI(TfType schemaType, TfToken instanceName)

Parameters

Type	Name	Description
TfType	schemaType
TfToken	instanceName

Returns

Type	Description
Boolean

ClearActive()

Declaration

public bool ClearActive()

Returns

Type	Description
Boolean

ClearInstanceable()

Declaration

public bool ClearInstanceable()

Returns

Type	Description
Boolean

ClearPayload()

Declaration

public bool ClearPayload()

Returns

Type	Description
Boolean

ClearTypeName()

Declaration

public bool ClearTypeName()

Returns

Type	Description
Boolean

ComputeExpandedPrimIndex()

Declaration

public PcpPrimIndex ComputeExpandedPrimIndex()

Returns

Type	Description
PcpPrimIndex

CreateAttribute(StdStringVector, SdfValueTypeName)

Declaration

public UsdAttribute CreateAttribute(StdStringVector nameElts, SdfValueTypeName typeName)

Parameters

Type	Name	Description
StdStringVector	nameElts
SdfValueTypeName	typeName

Returns

Type	Description
UsdAttribute

CreateAttribute(StdStringVector, SdfValueTypeName, SdfVariability)

Declaration

public UsdAttribute CreateAttribute(StdStringVector nameElts, SdfValueTypeName typeName, SdfVariability variability)

Parameters

Type	Name	Description
StdStringVector	nameElts
SdfValueTypeName	typeName
SdfVariability	variability

Returns

Type	Description
UsdAttribute

CreateAttribute(StdStringVector, SdfValueTypeName, Boolean)

Declaration

public UsdAttribute CreateAttribute(StdStringVector nameElts, SdfValueTypeName typeName, bool custom)

Parameters

Type	Name	Description
StdStringVector	nameElts
SdfValueTypeName	typeName
Boolean	custom

Returns

Type	Description
UsdAttribute

CreateAttribute(StdStringVector, SdfValueTypeName, Boolean, SdfVariability)

Declaration

public UsdAttribute CreateAttribute(StdStringVector nameElts, SdfValueTypeName typeName, bool custom, SdfVariability variability)

Parameters

Type	Name	Description
StdStringVector	nameElts
SdfValueTypeName	typeName
Boolean	custom
SdfVariability	variability

Returns

Type	Description
UsdAttribute

CreateAttribute(TfToken, SdfValueTypeName)

Declaration

public UsdAttribute CreateAttribute(TfToken name, SdfValueTypeName typeName)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName

Returns

Type	Description
UsdAttribute

CreateAttribute(TfToken, SdfValueTypeName, SdfVariability)

Declaration

public UsdAttribute CreateAttribute(TfToken name, SdfValueTypeName typeName, SdfVariability variability)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName
SdfVariability	variability

Returns

Type	Description
UsdAttribute

CreateAttribute(TfToken, SdfValueTypeName, Boolean)

Declaration

public UsdAttribute CreateAttribute(TfToken name, SdfValueTypeName typeName, bool custom)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName
Boolean	custom

Returns

Type	Description
UsdAttribute

CreateAttribute(TfToken, SdfValueTypeName, Boolean, SdfVariability)

Declaration

public UsdAttribute CreateAttribute(TfToken name, SdfValueTypeName typeName, bool custom, SdfVariability variability)

Parameters

Type	Name	Description
TfToken	name
SdfValueTypeName	typeName
Boolean	custom
SdfVariability	variability

Returns

Type	Description
UsdAttribute

CreateRelationship(StdStringVector)

Declaration

public UsdRelationship CreateRelationship(StdStringVector nameElts)

Parameters

Type	Name	Description
StdStringVector	nameElts

Returns

Type	Description
UsdRelationship

CreateRelationship(StdStringVector, Boolean)

Declaration

public UsdRelationship CreateRelationship(StdStringVector nameElts, bool custom)

Parameters

Type	Name	Description
StdStringVector	nameElts
Boolean	custom

Returns

Type	Description
UsdRelationship

CreateRelationship(TfToken)

Declaration

public UsdRelationship CreateRelationship(TfToken relName)

Parameters

Type	Name	Description
TfToken	relName

Returns

Type	Description
UsdRelationship

CreateRelationship(TfToken, Boolean)

Declaration

public UsdRelationship CreateRelationship(TfToken relName, bool custom)

Parameters

Type	Name	Description
TfToken	relName
Boolean	custom

Returns

Type	Description
UsdRelationship

Dispose()

Declaration

public override void Dispose()

Overrides

UsdObject.Dispose()

Finalize()

Declaration

protected void Finalize()

GetAllChildren()

Declaration

public UsdPrimSiblingRange GetAllChildren()

Returns

Type	Description
UsdPrimSiblingRange

GetAllDescendants()

Declaration

public UsdPrimSubtreeRange GetAllDescendants()

Returns

Type	Description
UsdPrimSubtreeRange

GetAppliedSchemas()

Declaration

public TfTokenVector GetAppliedSchemas()

Returns

Type	Description
TfTokenVector

GetAttribute(TfToken)

Declaration

public UsdAttribute GetAttribute(TfToken attrName)

Parameters

Type	Name	Description
TfToken	attrName

Returns

Type	Description
UsdAttribute

GetAttributeAtPath(SdfPath)

Declaration

public UsdAttribute GetAttributeAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
UsdAttribute

GetAttributes()

Declaration

public UsdAttributeVector GetAttributes()

Returns

Type	Description
UsdAttributeVector

GetAttributeValue(TfToken, VtValue, UsdTimeCode)

Declaration

public bool GetAttributeValue(TfToken attrName, VtValue valueOut, UsdTimeCode time)

Parameters

Type	Name	Description
TfToken	attrName
VtValue	valueOut
UsdTimeCode	time

Returns

Type	Description
Boolean

GetAuthoredAttributes()

Declaration

public UsdAttributeVector GetAuthoredAttributes()

Returns

Type	Description
UsdAttributeVector

GetAuthoredProperties()

Declaration

public UsdPropertyVector GetAuthoredProperties()

Returns

Type	Description
UsdPropertyVector

GetAuthoredProperties(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t)

Declaration

public UsdPropertyVector GetAuthoredProperties(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t predicate)

Parameters

Type	Name	Description
SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t	predicate

Returns

Type	Description
UsdPropertyVector

GetAuthoredPropertiesInNamespace(StdStringVector)

Declaration

public UsdPropertyVector GetAuthoredPropertiesInNamespace(StdStringVector namespaces)

Parameters

Type	Name	Description
StdStringVector	namespaces

Returns

Type	Description
UsdPropertyVector

GetAuthoredPropertiesInNamespace(String)

Declaration

public UsdPropertyVector GetAuthoredPropertiesInNamespace(string namespaces)

Parameters

Type	Name	Description
String	namespaces

Returns

Type	Description
UsdPropertyVector

GetAuthoredPropertyNames()

Declaration

public TfTokenVector GetAuthoredPropertyNames()

Returns

Type	Description
TfTokenVector

GetAuthoredPropertyNames(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t)

Declaration

public TfTokenVector GetAuthoredPropertyNames(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t predicate)

Parameters

Type	Name	Description
SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t	predicate

Returns

Type	Description
TfTokenVector

GetAuthoredRelationships()

Declaration

public UsdRelationshipVector GetAuthoredRelationships()

Returns

Type	Description
UsdRelationshipVector

GetChild(TfToken)

Declaration

public UsdPrim GetChild(TfToken name)

Parameters

Type	Name	Description
TfToken	name

Returns

Type	Description
UsdPrim

GetChildren()

Declaration

public UsdPrimSiblingRange GetChildren()

Returns

Type	Description
UsdPrimSiblingRange

GetDescendants()

Declaration

public UsdPrimSubtreeRange GetDescendants()

Returns

Type	Description
UsdPrimSubtreeRange

GetFilteredChildren(Usd_PrimFlagsPredicate)

Declaration

public UsdPrimSiblingRange GetFilteredChildren(Usd_PrimFlagsPredicate predicate)

Parameters

Type	Name	Description
Usd_PrimFlagsPredicate	predicate

Returns

Type	Description
UsdPrimSiblingRange

GetFilteredDescendants(Usd_PrimFlagsPredicate)

Declaration

public UsdPrimSubtreeRange GetFilteredDescendants(Usd_PrimFlagsPredicate predicate)

Parameters

Type	Name	Description
Usd_PrimFlagsPredicate	predicate

Returns

Type	Description
UsdPrimSubtreeRange

GetFilteredNextSibling(Usd_PrimFlagsPredicate)

Declaration

public UsdPrim GetFilteredNextSibling(Usd_PrimFlagsPredicate predicate)

Parameters

Type	Name	Description
Usd_PrimFlagsPredicate	predicate

Returns

Type	Description
UsdPrim

GetInherits()

Declaration

public UsdInherits GetInherits()

Returns

Type	Description
UsdInherits

GetInstances()

Declaration

public UsdPrimVector GetInstances()

Returns

Type	Description
UsdPrimVector

GetMaster()

Declaration

public UsdPrim GetMaster()

Returns

Type	Description
UsdPrim

GetNextSibling()

Declaration

public UsdPrim GetNextSibling()

Returns

Type	Description
UsdPrim

GetObjectAtPath(SdfPath)

Declaration

public UsdObject GetObjectAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
UsdObject

GetParent()

Declaration

public UsdPrim GetParent()

Returns

Type	Description
UsdPrim

GetPayloads()

Declaration

public UsdPayloads GetPayloads()

Returns

Type	Description
UsdPayloads

GetPrimAtPath(SdfPath)

Declaration

public UsdPrim GetPrimAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
UsdPrim

GetPrimDefinition()

Declaration

public SWIGTYPE_p_UsdPrimDefinition GetPrimDefinition()

Returns

Type	Description
SWIGTYPE_p_UsdPrimDefinition

GetPrimIndex()

Declaration

public PcpPrimIndex GetPrimIndex()

Returns

Type	Description
PcpPrimIndex

GetPrimInMaster()

Declaration

public UsdPrim GetPrimInMaster()

Returns

Type	Description
UsdPrim

GetPrimStack()

Declaration

public SdfPrimSpecHandleVector GetPrimStack()

Returns

Type	Description
SdfPrimSpecHandleVector

GetPrimTypeInfo()

Declaration

public SWIGTYPE_p_UsdPrimTypeInfo GetPrimTypeInfo()

Returns

Type	Description
SWIGTYPE_p_UsdPrimTypeInfo

GetProperties()

Declaration

public UsdPropertyVector GetProperties()

Returns

Type	Description
UsdPropertyVector

GetProperties(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t)

Declaration

public UsdPropertyVector GetProperties(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t predicate)

Parameters

Type	Name	Description
SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t	predicate

Returns

Type	Description
UsdPropertyVector

GetPropertiesInNamespace(StdStringVector)

Declaration

public UsdPropertyVector GetPropertiesInNamespace(StdStringVector namespaces)

Parameters

Type	Name	Description
StdStringVector	namespaces

Returns

Type	Description
UsdPropertyVector

GetPropertiesInNamespace(String)

Declaration

public UsdPropertyVector GetPropertiesInNamespace(string namespaces)

Parameters

Type	Name	Description
String	namespaces

Returns

Type	Description
UsdPropertyVector

GetProperty(TfToken)

Declaration

public UsdProperty GetProperty(TfToken propName)

Parameters

Type	Name	Description
TfToken	propName

Returns

Type	Description
UsdProperty

GetPropertyAtPath(SdfPath)

Declaration

public UsdProperty GetPropertyAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
UsdProperty

GetPropertyNames()

Declaration

public TfTokenVector GetPropertyNames()

Returns

Type	Description
TfTokenVector

GetPropertyNames(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t)

Declaration

public TfTokenVector GetPropertyNames(SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t predicate)

Parameters

Type	Name	Description
SWIGTYPE_p_std__functionT_bool_fTfToken_const_RF_t	predicate

Returns

Type	Description
TfTokenVector

GetPropertyOrder()

Declaration

public TfTokenVector GetPropertyOrder()

Returns

Type	Description
TfTokenVector

GetReferences()

Declaration

public UsdReferences GetReferences()

Returns

Type	Description
UsdReferences

GetRelationship(TfToken)

Declaration

public UsdRelationship GetRelationship(TfToken relName)

Parameters

Type	Name	Description
TfToken	relName

Returns

Type	Description
UsdRelationship

GetRelationshipAtPath(SdfPath)

Declaration

public UsdRelationship GetRelationshipAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
UsdRelationship

GetRelationships()

Declaration

public UsdRelationshipVector GetRelationships()

Returns

Type	Description
UsdRelationshipVector

GetSpecializes()

Declaration

public UsdSpecializes GetSpecializes()

Returns

Type	Description
UsdSpecializes

GetSpecifier()

Declaration

public SdfSpecifier GetSpecifier()

Returns

Type	Description
SdfSpecifier

GetTypeName()

Declaration

public TfToken GetTypeName()

Returns

Type	Description
TfToken

GetVariantSet(String)

Declaration

public UsdVariantSet GetVariantSet(string variantSetName)

Parameters

Type	Name	Description
String	variantSetName

Returns

Type	Description
UsdVariantSet

GetVariantSets()

Declaration

public UsdVariantSets GetVariantSets()

Returns

Type	Description
UsdVariantSets

HasAPI(TfType)

Declaration

public bool HasAPI(TfType schemaType)

Parameters

Type	Name	Description
TfType	schemaType

Returns

Type	Description
Boolean

HasAPI(TfType, TfToken)

Declaration

public bool HasAPI(TfType schemaType, TfToken instanceName)

Parameters

Type	Name	Description
TfType	schemaType
TfToken	instanceName

Returns

Type	Description
Boolean

HasAttribute(TfToken)

Declaration

public bool HasAttribute(TfToken attrName)

Parameters

Type	Name	Description
TfToken	attrName

Returns

Type	Description
Boolean

HasAuthoredActive()

Declaration

public bool HasAuthoredActive()

Returns

Type	Description
Boolean

HasAuthoredInherits()

Declaration

public bool HasAuthoredInherits()

Returns

Type	Description
Boolean

HasAuthoredInstanceable()

Declaration

public bool HasAuthoredInstanceable()

Returns

Type	Description
Boolean

HasAuthoredPayloads()

Declaration

public bool HasAuthoredPayloads()

Returns

Type	Description
Boolean

HasAuthoredReferences()

Declaration

public bool HasAuthoredReferences()

Returns

Type	Description
Boolean

HasAuthoredSpecializes()

Declaration

public bool HasAuthoredSpecializes()

Returns

Type	Description
Boolean

HasAuthoredTypeName()

Declaration

public bool HasAuthoredTypeName()

Returns

Type	Description
Boolean

HasDefiningSpecifier()

Declaration

public bool HasDefiningSpecifier()

Returns

Type	Description
Boolean

HasPayload()

Declaration

public bool HasPayload()

Returns

Type	Description
Boolean

HasProperty(TfToken)

Declaration

public bool HasProperty(TfToken propName)

Parameters

Type	Name	Description
TfToken	propName

Returns

Type	Description
Boolean

HasRelationship(TfToken)

Declaration

public bool HasRelationship(TfToken relName)

Parameters

Type	Name	Description
TfToken	relName

Returns

Type	Description
Boolean

HasVariantSets()

Declaration

public bool HasVariantSets()

Returns

Type	Description
Boolean

IsA(TfType)

Declaration

public bool IsA(TfType schemaType)

Parameters

Type	Name	Description
TfType	schemaType

Returns

Type	Description
Boolean

IsAbstract()

Declaration

public bool IsAbstract()

Returns

Type	Description
Boolean

IsActive()

Declaration

public bool IsActive()

Returns

Type	Description
Boolean

IsDefined()

Declaration

public bool IsDefined()

Returns

Type	Description
Boolean

IsGroup()

Declaration

public bool IsGroup()

Returns

Type	Description
Boolean

IsInMaster()

Declaration

public bool IsInMaster()

Returns

Type	Description
Boolean

IsInstance()

Declaration

public bool IsInstance()

Returns

Type	Description
Boolean

IsInstanceable()

Declaration

public bool IsInstanceable()

Returns

Type	Description
Boolean

IsInstanceProxy()

Declaration

public bool IsInstanceProxy()

Returns

Type	Description
Boolean

IsLoaded()

Declaration

public bool IsLoaded()

Returns

Type	Description
Boolean

IsMaster()

Declaration

public bool IsMaster()

Returns

Type	Description
Boolean

IsModel()

Declaration

public bool IsModel()

Returns

Type	Description
Boolean

IsPseudoRoot()

Declaration

public bool IsPseudoRoot()

Returns

Type	Description
Boolean

Load()

Declaration

public void Load()

Load(UsdLoadPolicy)

Declaration

public void Load(UsdLoadPolicy policy)

Parameters

Type	Name	Description
UsdLoadPolicy	policy

RemoveAPI(TfType)

Declaration

public bool RemoveAPI(TfType schemaType)

Parameters

Type	Name	Description
TfType	schemaType

Returns

Type	Description
Boolean

RemoveAPI(TfType, TfToken)

Declaration

public bool RemoveAPI(TfType schemaType, TfToken instanceName)

Parameters

Type	Name	Description
TfType	schemaType
TfToken	instanceName

Returns

Type	Description
Boolean

RemoveAppliedSchema(TfToken)

Declaration

public bool RemoveAppliedSchema(TfToken appliedSchemaName)

Parameters

Type	Name	Description
TfToken	appliedSchemaName

Returns

Type	Description
Boolean

RemoveProperty(TfToken)

Declaration

public bool RemoveProperty(TfToken propName)

Parameters

Type	Name	Description
TfToken	propName

Returns

Type	Description
Boolean

SetActive(Boolean)

Declaration

public bool SetActive(bool active)

Parameters

Type	Name	Description
Boolean	active

Returns

Type	Description
Boolean

SetInstanceable(Boolean)

Declaration

public bool SetInstanceable(bool instanceable)

Parameters

Type	Name	Description
Boolean	instanceable

Returns

Type	Description
Boolean

SetPayload(SdfLayerHandle, SdfPath)

Declaration

public bool SetPayload(SdfLayerHandle layer, SdfPath primPath)

Parameters

Type	Name	Description
SdfLayerHandle	layer
SdfPath	primPath

Returns

Type	Description
Boolean

SetPayload(SdfPayload)

Declaration

public bool SetPayload(SdfPayload payload)

Parameters

Type	Name	Description
SdfPayload	payload

Returns

Type	Description
Boolean

SetPayload(String, SdfPath)

Declaration

public bool SetPayload(string assetPath, SdfPath primPath)

Parameters

Type	Name	Description
String	assetPath
SdfPath	primPath

Returns

Type	Description
Boolean

SetPropertyOrder(TfTokenVector)

Declaration

public void SetPropertyOrder(TfTokenVector order)

Parameters

Type	Name	Description
TfTokenVector	order

SetSpecifier(SdfSpecifier)

Declaration

public bool SetSpecifier(SdfSpecifier specifier)

Parameters

Type	Name	Description
SdfSpecifier	specifier

Returns

Type	Description
Boolean

SetTypeName(TfToken)

Declaration

public bool SetTypeName(TfToken typeName)

Parameters

Type	Name	Description
TfToken	typeName

Returns

Type	Description
Boolean

Unload()

Declaration

public void Unload()