Class SdfPrimSpec

Inheritance

Object

SdfSpec

SdfPrimSpec

Inherited Members

SdfSpec.swigCMemOwn

SdfSpec.GetSchema()

SdfSpec.GetSpecType()

SdfSpec.IsDormant()

SdfSpec.GetLayer()

SdfSpec.GetPath()

SdfSpec.PermissionToEdit()

SdfSpec.ListInfoKeys()

SdfSpec.GetMetaDataInfoKeys()

SdfSpec.GetMetaDataDisplayGroup(TfToken)

SdfSpec.GetInfo(TfToken)

SdfSpec.SetInfo(TfToken, VtValue)

SdfSpec.SetInfoDictionaryValue(TfToken, TfToken, VtValue)

SdfSpec.HasInfo(TfToken)

SdfSpec.ClearInfo(TfToken)

SdfSpec.GetTypeForInfo(TfToken)

SdfSpec.GetFallbackForInfo(TfToken)

SdfSpec.WriteToStream(SWIGTYPE_p_std__ostream, UInt32)

SdfSpec.WriteToStream(SWIGTYPE_p_std__ostream)

SdfSpec.IsInert(Boolean)

SdfSpec.IsInert()

SdfSpec.ListFields()

SdfSpec.HasField(TfToken)

SdfSpec.GetField(TfToken)

SdfSpec.SetField(TfToken, VtValue)

SdfSpec.ClearField(TfToken)

Object.ToString()

Object.Equals(Object)

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class SdfPrimSpec : SdfSpec, IDisposable

Methods

ApplyNameChildrenOrder(TfTokenVector)

Declaration

public void ApplyNameChildrenOrder(TfTokenVector vec)

Parameters

Type	Name	Description
TfTokenVector	vec

ApplyPropertyOrder(TfTokenVector)

Declaration

public void ApplyPropertyOrder(TfTokenVector vec)

Parameters

Type	Name	Description
TfTokenVector	vec

CanSetName(String, SWIGTYPE_p_std__string)

Declaration

public bool CanSetName(string newName, SWIGTYPE_p_std__string whyNot)

Parameters

Type	Name	Description
String	newName
SWIGTYPE_p_std__string	whyNot

Returns

Type	Description
Boolean

ClearActive()

Declaration

public void ClearActive()

ClearInheritPathList()

Declaration

public void ClearInheritPathList()

ClearInstanceable()

Declaration

public void ClearInstanceable()

ClearKind()

Declaration

public void ClearKind()

ClearPayloadList()

Declaration

public void ClearPayloadList()

ClearReferenceList()

Declaration

public void ClearReferenceList()

ClearRelocates()

Declaration

public void ClearRelocates()

ClearSpecializesList()

Declaration

public void ClearSpecializesList()

Dispose()

Declaration

public override void Dispose()

Overrides

SdfSpec.Dispose()

Finalize()

Declaration

protected void Finalize()

GetActive()

Declaration

public bool GetActive()

Returns

Type	Description
Boolean

GetAssetInfo()

Declaration

public SWIGTYPE_p_SdfDictionaryProxy GetAssetInfo()

Returns

Type	Description
SWIGTYPE_p_SdfDictionaryProxy

GetAttributeAtPath(SdfPath)

Declaration

public SdfAttributeSpecHandle GetAttributeAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfAttributeSpecHandle

GetComment()

Declaration

public string GetComment()

Returns

Type	Description
String

GetCustomData()

Declaration

public SWIGTYPE_p_SdfDictionaryProxy GetCustomData()

Returns

Type	Description
SWIGTYPE_p_SdfDictionaryProxy

GetDocumentation()

Declaration

public string GetDocumentation()

Returns

Type	Description
String

GetHidden()

Declaration

public bool GetHidden()

Returns

Type	Description
Boolean

GetInheritPathList()

Declaration

public SWIGTYPE_p_SdfInheritsProxy GetInheritPathList()

Returns

Type	Description
SWIGTYPE_p_SdfInheritsProxy

GetInstanceable()

Declaration

public bool GetInstanceable()

Returns

Type	Description
Boolean

GetKind()

Declaration

public TfToken GetKind()

Returns

Type	Description
TfToken

GetName()

Declaration

public string GetName()

Returns

Type	Description
String

GetNameChildren()

Declaration

public SWIGTYPE_p_SdfPrimSpecView GetNameChildren()

Returns

Type	Description
SWIGTYPE_p_SdfPrimSpecView

GetNameParent()

Declaration

public SdfPrimSpecHandle GetNameParent()

Returns

Type	Description
SdfPrimSpecHandle

GetNameRoot()

Declaration

public SdfPrimSpecHandle GetNameRoot()

Returns

Type	Description
SdfPrimSpecHandle

GetNameToken()

Declaration

public TfToken GetNameToken()

Returns

Type	Description
TfToken

GetObjectAtPath(SdfPath)

Declaration

public SdfSpecHandle GetObjectAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfSpecHandle

GetPayloadList()

Declaration

public SWIGTYPE_p_SdfPayloadsProxy GetPayloadList()

Returns

Type	Description
SWIGTYPE_p_SdfPayloadsProxy

GetPermission()

Declaration

public SdfPermission GetPermission()

Returns

Type	Description
SdfPermission

GetPrefix()

Declaration

public string GetPrefix()

Returns

Type	Description
String

GetPrefixSubstitutions()

Declaration

public VtDictionary GetPrefixSubstitutions()

Returns

Type	Description
VtDictionary

GetPrimAtPath(SdfPath)

Declaration

public SdfPrimSpecHandle GetPrimAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfPrimSpecHandle

GetProperties()

Declaration

public SWIGTYPE_p_SdfPropertySpecView GetProperties()

Returns

Type	Description
SWIGTYPE_p_SdfPropertySpecView

GetPropertyAtPath(SdfPath)

Declaration

public SdfPropertySpecHandle GetPropertyAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfPropertySpecHandle

GetRealNameParent()

Declaration

public SdfPrimSpecHandle GetRealNameParent()

Returns

Type	Description
SdfPrimSpecHandle

GetReferenceList()

Declaration

public SWIGTYPE_p_SdfReferencesProxy GetReferenceList()

Returns

Type	Description
SWIGTYPE_p_SdfReferencesProxy

GetRelationshipAtPath(SdfPath)

Declaration

public SdfRelationshipSpecHandle GetRelationshipAtPath(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfRelationshipSpecHandle

GetRelocates()

Declaration

public SWIGTYPE_p_SdfRelocatesMapProxy GetRelocates()

Returns

Type	Description
SWIGTYPE_p_SdfRelocatesMapProxy

GetSpecializesList()

Declaration

public SWIGTYPE_p_SdfSpecializesProxy GetSpecializesList()

Returns

Type	Description
SWIGTYPE_p_SdfSpecializesProxy

GetSpecifier()

Declaration

public SdfSpecifier GetSpecifier()

Returns

Type	Description
SdfSpecifier

GetSuffix()

Declaration

public string GetSuffix()

Returns

Type	Description
String

GetSuffixSubstitutions()

Declaration

public VtDictionary GetSuffixSubstitutions()

Returns

Type	Description
VtDictionary

GetSymmetricPeer()

Declaration

public string GetSymmetricPeer()

Returns

Type	Description
String

GetSymmetryArguments()

Declaration

public SWIGTYPE_p_SdfDictionaryProxy GetSymmetryArguments()

Returns

Type	Description
SWIGTYPE_p_SdfDictionaryProxy

GetSymmetryFunction()

Declaration

public TfToken GetSymmetryFunction()

Returns

Type	Description
TfToken

GetTypeName()

Declaration

public TfToken GetTypeName()

Returns

Type	Description
TfToken

GetVariantNames(String)

Declaration

public StdStringVector GetVariantNames(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
StdStringVector

GetVariantSelections()

Declaration

public SWIGTYPE_p_SdfVariantSelectionProxy GetVariantSelections()

Returns

Type	Description
SWIGTYPE_p_SdfVariantSelectionProxy

GetVariantSetNameList()

Declaration

public SWIGTYPE_p_SdfVariantSetNamesProxy GetVariantSetNameList()

Returns

Type	Description
SWIGTYPE_p_SdfVariantSetNamesProxy

HasActive()

Declaration

public bool HasActive()

Returns

Type	Description
Boolean

HasInheritPaths()

Declaration

public bool HasInheritPaths()

Returns

Type	Description
Boolean

HasInstanceable()

Declaration

public bool HasInstanceable()

Returns

Type	Description
Boolean

HasKind()

Declaration

public bool HasKind()

Returns

Type	Description
Boolean

HasNameChildrenOrder()

Declaration

public bool HasNameChildrenOrder()

Returns

Type	Description
Boolean

HasPayloads()

Declaration

public bool HasPayloads()

Returns

Type	Description
Boolean

HasPropertyOrder()

Declaration

public bool HasPropertyOrder()

Returns

Type	Description
Boolean

HasReferences()

Declaration

public bool HasReferences()

Returns

Type	Description
Boolean

HasRelocates()

Declaration

public bool HasRelocates()

Returns

Type	Description
Boolean

HasSpecializes()

Declaration

public bool HasSpecializes()

Returns

Type	Description
Boolean

HasVariantSetNames()

Declaration

public bool HasVariantSetNames()

Returns

Type	Description
Boolean

InsertInNameChildrenOrder(TfToken)

Declaration

public void InsertInNameChildrenOrder(TfToken name)

Parameters

Type	Name	Description
TfToken	name

InsertInNameChildrenOrder(TfToken, Int32)

Declaration

public void InsertInNameChildrenOrder(TfToken name, int index)

Parameters

Type	Name	Description
TfToken	name
Int32	index

InsertInPropertyOrder(TfToken)

Declaration

public void InsertInPropertyOrder(TfToken name)

Parameters

Type	Name	Description
TfToken	name

InsertInPropertyOrder(TfToken, Int32)

Declaration

public void InsertInPropertyOrder(TfToken name, int index)

Parameters

Type	Name	Description
TfToken	name
Int32	index

InsertNameChild(SdfPrimSpecHandle)

Declaration

public bool InsertNameChild(SdfPrimSpecHandle child)

Parameters

Type	Name	Description
SdfPrimSpecHandle	child

Returns

Type	Description
Boolean

InsertNameChild(SdfPrimSpecHandle, Int32)

Declaration

public bool InsertNameChild(SdfPrimSpecHandle child, int index)

Parameters

Type	Name	Description
SdfPrimSpecHandle	child
Int32	index

Returns

Type	Description
Boolean

InsertProperty(SdfPropertySpecHandle)

Declaration

public bool InsertProperty(SdfPropertySpecHandle property)

Parameters

Type	Name	Description
SdfPropertySpecHandle	property

Returns

Type	Description
Boolean

InsertProperty(SdfPropertySpecHandle, Int32)

Declaration

public bool InsertProperty(SdfPropertySpecHandle property, int index)

Parameters

Type	Name	Description
SdfPropertySpecHandle	property
Int32	index

Returns

Type	Description
Boolean

IsValidName(String)

Declaration

public static bool IsValidName(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

New(SdfLayerHandle, String, SdfSpecifier)

Declaration

public static SdfPrimSpecHandle New(SdfLayerHandle parentLayer, string name, SdfSpecifier spec)

Parameters

Type	Name	Description
SdfLayerHandle	parentLayer
String	name
SdfSpecifier	spec

Returns

Type	Description
SdfPrimSpecHandle

New(SdfLayerHandle, String, SdfSpecifier, String)

Declaration

public static SdfPrimSpecHandle New(SdfLayerHandle parentLayer, string name, SdfSpecifier spec, string typeName)

Parameters

Type	Name	Description
SdfLayerHandle	parentLayer
String	name
SdfSpecifier	spec
String	typeName

Returns

Type	Description
SdfPrimSpecHandle

New(SdfPrimSpecHandle, String, SdfSpecifier)

Declaration

public static SdfPrimSpecHandle New(SdfPrimSpecHandle parentPrim, string name, SdfSpecifier spec)

Parameters

Type	Name	Description
SdfPrimSpecHandle	parentPrim
String	name
SdfSpecifier	spec

Returns

Type	Description
SdfPrimSpecHandle

New(SdfPrimSpecHandle, String, SdfSpecifier, String)

Declaration

public static SdfPrimSpecHandle New(SdfPrimSpecHandle parentPrim, string name, SdfSpecifier spec, string typeName)

Parameters

Type	Name	Description
SdfPrimSpecHandle	parentPrim
String	name
SdfSpecifier	spec
String	typeName

Returns

Type	Description
SdfPrimSpecHandle

RemoveFromNameChildrenOrder(TfToken)

Declaration

public void RemoveFromNameChildrenOrder(TfToken name)

Parameters

Type	Name	Description
TfToken	name

RemoveFromNameChildrenOrderByIndex(Int32)

Declaration

public void RemoveFromNameChildrenOrderByIndex(int index)

Parameters

Type	Name	Description
Int32	index

RemoveFromPropertyOrder(TfToken)

Declaration

public void RemoveFromPropertyOrder(TfToken name)

Parameters

Type	Name	Description
TfToken	name

RemoveFromPropertyOrderByIndex(Int32)

Declaration

public void RemoveFromPropertyOrderByIndex(int index)

Parameters

Type	Name	Description
Int32	index

RemoveNameChild(SdfPrimSpecHandle)

Declaration

public bool RemoveNameChild(SdfPrimSpecHandle child)

Parameters

Type	Name	Description
SdfPrimSpecHandle	child

Returns

Type	Description
Boolean

RemoveProperty(SdfPropertySpecHandle)

Declaration

public void RemoveProperty(SdfPropertySpecHandle property)

Parameters

Type	Name	Description
SdfPropertySpecHandle	property

RemoveVariantSet(String)

Declaration

public void RemoveVariantSet(string name)

Parameters

Type	Name	Description
String	name

SetActive(Boolean)

Declaration

public void SetActive(bool value)

Parameters

Type	Name	Description
Boolean	value

SetAssetInfo(String, VtValue)

Declaration

public void SetAssetInfo(string name, VtValue value)

Parameters

Type	Name	Description
String	name
VtValue	value

SetComment(String)

Declaration

public void SetComment(string value)

Parameters

Type	Name	Description
String	value

SetCustomData(String, VtValue)

Declaration

public void SetCustomData(string name, VtValue value)

Parameters

Type	Name	Description
String	name
VtValue	value

SetDocumentation(String)

Declaration

public void SetDocumentation(string value)

Parameters

Type	Name	Description
String	value

SetHidden(Boolean)

Declaration

public void SetHidden(bool value)

Parameters

Type	Name	Description
Boolean	value

SetInstanceable(Boolean)

Declaration

public void SetInstanceable(bool instanceable)

Parameters

Type	Name	Description
Boolean	instanceable

SetKind(TfToken)

Declaration

public void SetKind(TfToken value)

Parameters

Type	Name	Description
TfToken	value

SetName(String)

Declaration

public bool SetName(string newName)

Parameters

Type	Name	Description
String	newName

Returns

Type	Description
Boolean

SetName(String, Boolean)

Declaration

public bool SetName(string newName, bool validate)

Parameters

Type	Name	Description
String	newName
Boolean	validate

Returns

Type	Description
Boolean

SetNameChildren(SdfPrimSpecHandleVector)

Declaration

public void SetNameChildren(SdfPrimSpecHandleVector arg0)

Parameters

Type	Name	Description
SdfPrimSpecHandleVector	arg0

SetNameChildrenOrder(TfTokenVector)

Declaration

public void SetNameChildrenOrder(TfTokenVector names)

Parameters

Type	Name	Description
TfTokenVector	names

SetPermission(SdfPermission)

Declaration

public void SetPermission(SdfPermission value)

Parameters

Type	Name	Description
SdfPermission	value

SetPrefix(String)

Declaration

public void SetPrefix(string value)

Parameters

Type	Name	Description
String	value

SetPrefixSubstitutions(VtDictionary)

Declaration

public void SetPrefixSubstitutions(VtDictionary prefixSubstitutions)

Parameters

Type	Name	Description
VtDictionary	prefixSubstitutions

SetProperties(SdfPropertySpecHandleVector)

Declaration

public void SetProperties(SdfPropertySpecHandleVector arg0)

Parameters

Type	Name	Description
SdfPropertySpecHandleVector	arg0

SetPropertyOrder(TfTokenVector)

Declaration

public void SetPropertyOrder(TfTokenVector names)

Parameters

Type	Name	Description
TfTokenVector	names

SetRelocates(SWIGTYPE_p_std__mapT_SdfPath_SdfPath_std__lessT_SdfPath_t_t)

Declaration

public void SetRelocates(SWIGTYPE_p_std__mapT_SdfPath_SdfPath_std__lessT_SdfPath_t_t newMap)

Parameters

Type	Name	Description
SWIGTYPE_p_std__mapT_SdfPath_SdfPath_std__lessT_SdfPath_t_t	newMap

SetSpecifier(SdfSpecifier)

Declaration

public void SetSpecifier(SdfSpecifier value)

Parameters

Type	Name	Description
SdfSpecifier	value

SetSuffix(String)

Declaration

public void SetSuffix(string value)

Parameters

Type	Name	Description
String	value

SetSuffixSubstitutions(VtDictionary)

Declaration

public void SetSuffixSubstitutions(VtDictionary suffixSubstitutions)

Parameters

Type	Name	Description
VtDictionary	suffixSubstitutions

SetSymmetricPeer(String)

Declaration

public void SetSymmetricPeer(string peerName)

Parameters

Type	Name	Description
String	peerName

SetSymmetryArgument(String, VtValue)

Declaration

public void SetSymmetryArgument(string name, VtValue value)

Parameters

Type	Name	Description
String	name
VtValue	value

SetSymmetryFunction(TfToken)

Declaration

public void SetSymmetryFunction(TfToken functionName)

Parameters

Type	Name	Description
TfToken	functionName

SetTypeName(String)

Declaration

public void SetTypeName(string value)

Parameters

Type	Name	Description
String	value

SetVariantSelection(String, String)

Declaration

public void SetVariantSelection(string variantSetName, string variantName)

Parameters

Type	Name	Description
String	variantSetName
String	variantName