Class SdfRelationshipSpecHandle

Inheritance
Object
SdfRelationshipSpecHandle
Inherited Members
Object.ToString()
Object.Equals(Object)
Object.Equals(Object, Object)
Object.ReferenceEquals(Object, Object)
Object.GetHashCode()
Namespace: pxr
Syntax
public class SdfRelationshipSpecHandle : IDisposable

Constructors

SdfRelationshipSpecHandle()

Declaration
public SdfRelationshipSpecHandle()

SdfRelationshipSpecHandle(SdfRelationshipSpec)

Declaration
public SdfRelationshipSpecHandle(SdfRelationshipSpec spec)
Parameters
Type Name Description
SdfRelationshipSpec spec

SdfRelationshipSpecHandle(SdfRelationshipSpecHandle)

Declaration
public SdfRelationshipSpecHandle(SdfRelationshipSpecHandle handle)
Parameters
Type Name Description
SdfRelationshipSpecHandle handle

Fields

swigCMemOwn

Declaration
protected bool swigCMemOwn
Field Value
Type Description
Boolean

Methods

__deref__()

Declaration
public SdfRelationshipSpec __deref__()
Returns
Type Description
SdfRelationshipSpec

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

ClearDefaultValue()

Declaration
public void ClearDefaultValue()

ClearField(TfToken)

Declaration
public bool ClearField(TfToken name)
Parameters
Type Name Description
TfToken name
Returns
Type Description
Boolean

ClearInfo(TfToken)

Declaration
public void ClearInfo(TfToken key)
Parameters
Type Name Description
TfToken key

ClearTargetPathList()

Declaration
public void ClearTargetPathList()

Dispose()

Declaration
public virtual void Dispose()
Implements

Finalize()

Declaration
protected void Finalize()

GetAssetInfo()

Declaration
public SWIGTYPE_p_SdfDictionaryProxy GetAssetInfo()
Returns
Type Description
SWIGTYPE_p_SdfDictionaryProxy

GetComment()

Declaration
public string GetComment()
Returns
Type Description
String

GetCustomData()

Declaration
public SWIGTYPE_p_SdfDictionaryProxy GetCustomData()
Returns
Type Description
SWIGTYPE_p_SdfDictionaryProxy

GetDefaultValue()

Declaration
public VtValue GetDefaultValue()
Returns
Type Description
VtValue

GetDisplayGroup()

Declaration
public string GetDisplayGroup()
Returns
Type Description
String

GetDisplayName()

Declaration
public string GetDisplayName()
Returns
Type Description
String

GetDocumentation()

Declaration
public string GetDocumentation()
Returns
Type Description
String

GetFallbackForInfo(TfToken)

Declaration
public VtValue GetFallbackForInfo(TfToken key)
Parameters
Type Name Description
TfToken key
Returns
Type Description
VtValue

GetField(TfToken)

Declaration
public VtValue GetField(TfToken name)
Parameters
Type Name Description
TfToken name
Returns
Type Description
VtValue

GetHidden()

Declaration
public bool GetHidden()
Returns
Type Description
Boolean

GetInfo(TfToken)

Declaration
public VtValue GetInfo(TfToken key)
Parameters
Type Name Description
TfToken key
Returns
Type Description
VtValue

GetLayer()

Declaration
public SdfLayerHandle GetLayer()
Returns
Type Description
SdfLayerHandle

GetMetaDataDisplayGroup(TfToken)

Declaration
public TfToken GetMetaDataDisplayGroup(TfToken key)
Parameters
Type Name Description
TfToken key
Returns
Type Description
TfToken

GetMetaDataInfoKeys()

Declaration
public TfTokenVector GetMetaDataInfoKeys()
Returns
Type Description
TfTokenVector

GetName()

Declaration
public string GetName()
Returns
Type Description
String

GetNameToken()

Declaration
public TfToken GetNameToken()
Returns
Type Description
TfToken

GetNoLoadHint()

Declaration
public bool GetNoLoadHint()
Returns
Type Description
Boolean

GetOwner()

Declaration
public SdfSpecHandle GetOwner()
Returns
Type Description
SdfSpecHandle

GetPath()

Declaration
public SdfPath GetPath()
Returns
Type Description
SdfPath

GetPermission()

Declaration
public SdfPermission GetPermission()
Returns
Type Description
SdfPermission

GetPrefix()

Declaration
public string GetPrefix()
Returns
Type Description
String

GetSchema()

Declaration
public SWIGTYPE_p_SdfSchemaBase GetSchema()
Returns
Type Description
SWIGTYPE_p_SdfSchemaBase

GetSpecType()

Declaration
public SdfSpecType GetSpecType()
Returns
Type Description
SdfSpecType

GetSuffix()

Declaration
public string GetSuffix()
Returns
Type Description
String

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

GetTargetPathList()

Declaration
public SWIGTYPE_p_SdfTargetsProxy GetTargetPathList()
Returns
Type Description
SWIGTYPE_p_SdfTargetsProxy

GetTimeSampleMap()

Declaration
public SWIGTYPE_p_std__mapT_double_VtValue_std__lessT_double_t_t GetTimeSampleMap()
Returns
Type Description
SWIGTYPE_p_std__mapT_double_VtValue_std__lessT_double_t_t

GetTypeForInfo(TfToken)

Declaration
public TfType GetTypeForInfo(TfToken key)
Parameters
Type Name Description
TfToken key
Returns
Type Description
TfType

GetTypeName()

Declaration
public SdfValueTypeName GetTypeName()
Returns
Type Description
SdfValueTypeName

GetValueType()

Declaration
public TfType GetValueType()
Returns
Type Description
TfType

GetVariability()

Declaration
public SdfVariability GetVariability()
Returns
Type Description
SdfVariability

HasDefaultValue()

Declaration
public bool HasDefaultValue()
Returns
Type Description
Boolean

HasField(TfToken)

Declaration
public bool HasField(TfToken name)
Parameters
Type Name Description
TfToken name
Returns
Type Description
Boolean

HasInfo(TfToken)

Declaration
public bool HasInfo(TfToken key)
Parameters
Type Name Description
TfToken key
Returns
Type Description
Boolean

HasOnlyRequiredFields()

Declaration
public bool HasOnlyRequiredFields()
Returns
Type Description
Boolean

HasTargetPathList()

Declaration
public bool HasTargetPathList()
Returns
Type Description
Boolean

IsCustom()

Declaration
public bool IsCustom()
Returns
Type Description
Boolean

IsDormant()

Declaration
public bool IsDormant()
Returns
Type Description
Boolean

IsInert()

Declaration
public bool IsInert()
Returns
Type Description
Boolean

IsInert(Boolean)

Declaration
public bool IsInert(bool ignoreChildren)
Parameters
Type Name Description
Boolean ignoreChildren
Returns
Type Description
Boolean

IsValidName(String)

Declaration
public bool IsValidName(string name)
Parameters
Type Name Description
String name
Returns
Type Description
Boolean

ListFields()

Declaration
public TfTokenVector ListFields()
Returns
Type Description
TfTokenVector

ListInfoKeys()

Declaration
public TfTokenVector ListInfoKeys()
Returns
Type Description
TfTokenVector

New(SdfPrimSpecHandle, String)

Declaration
public SdfRelationshipSpecHandle New(SdfPrimSpecHandle owner, string name)
Parameters
Type Name Description
SdfPrimSpecHandle owner
String name
Returns
Type Description
SdfRelationshipSpecHandle

New(SdfPrimSpecHandle, String, Boolean)

Declaration
public SdfRelationshipSpecHandle New(SdfPrimSpecHandle owner, string name, bool custom)
Parameters
Type Name Description
SdfPrimSpecHandle owner
String name
Boolean custom
Returns
Type Description
SdfRelationshipSpecHandle

New(SdfPrimSpecHandle, String, Boolean, SdfVariability)

Declaration
public SdfRelationshipSpecHandle New(SdfPrimSpecHandle owner, string name, bool custom, SdfVariability variability)
Parameters
Type Name Description
SdfPrimSpecHandle owner
String name
Boolean custom
SdfVariability variability
Returns
Type Description
SdfRelationshipSpecHandle

PermissionToEdit()

Declaration
public bool PermissionToEdit()
Returns
Type Description
Boolean

RemoveTargetPath(SdfPath)

Declaration
public void RemoveTargetPath(SdfPath path)
Parameters
Type Name Description
SdfPath path

RemoveTargetPath(SdfPath, Boolean)

Declaration
public void RemoveTargetPath(SdfPath path, bool preserveTargetOrder)
Parameters
Type Name Description
SdfPath path
Boolean preserveTargetOrder

ReplaceTargetPath(SdfPath, SdfPath)

Declaration
public void ReplaceTargetPath(SdfPath oldPath, SdfPath newPath)
Parameters
Type Name Description
SdfPath oldPath
SdfPath newPath

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

SetCustom(Boolean)

Declaration
public void SetCustom(bool custom)
Parameters
Type Name Description
Boolean custom

SetCustomData(String, VtValue)

Declaration
public void SetCustomData(string name, VtValue value)
Parameters
Type Name Description
String name
VtValue value

SetDefaultValue(VtValue)

Declaration
public bool SetDefaultValue(VtValue defaultValue)
Parameters
Type Name Description
VtValue defaultValue
Returns
Type Description
Boolean

SetDisplayGroup(String)

Declaration
public void SetDisplayGroup(string value)
Parameters
Type Name Description
String value

SetDisplayName(String)

Declaration
public void SetDisplayName(string value)
Parameters
Type Name Description
String value

SetDocumentation(String)

Declaration
public void SetDocumentation(string value)
Parameters
Type Name Description
String value

SetField(TfToken, VtValue)

Declaration
public bool SetField(TfToken name, VtValue value)
Parameters
Type Name Description
TfToken name
VtValue value
Returns
Type Description
Boolean

SetHidden(Boolean)

Declaration
public void SetHidden(bool value)
Parameters
Type Name Description
Boolean value

SetInfo(TfToken, VtValue)

Declaration
public void SetInfo(TfToken key, VtValue value)
Parameters
Type Name Description
TfToken key
VtValue value

SetInfoDictionaryValue(TfToken, TfToken, VtValue)

Declaration
public void SetInfoDictionaryValue(TfToken dictionaryKey, TfToken entryKey, VtValue value)
Parameters
Type Name Description
TfToken dictionaryKey
TfToken entryKey
VtValue 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

SetNoLoadHint(Boolean)

Declaration
public void SetNoLoadHint(bool noload)
Parameters
Type Name Description
Boolean noload

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

SetSuffix(String)

Declaration
public void SetSuffix(string value)
Parameters
Type Name Description
String value

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

WriteToStream(SWIGTYPE_p_std__ostream)

Declaration
public bool WriteToStream(SWIGTYPE_p_std__ostream arg0)
Parameters
Type Name Description
SWIGTYPE_p_std__ostream arg0
Returns
Type Description
Boolean

WriteToStream(SWIGTYPE_p_std__ostream, UInt32)

Declaration
public bool WriteToStream(SWIGTYPE_p_std__ostream arg0, uint indent)
Parameters
Type Name Description
SWIGTYPE_p_std__ostream arg0
UInt32 indent
Returns
Type Description
Boolean

Did you find this page useful? Please give it a rating: