Class SdfPath

Inheritance

Object

SdfPath

Inherited Members

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: pxr

Syntax

public class SdfPath : IDisposable

Constructors

SdfPath()

Declaration

public SdfPath()

SdfPath(String)

Declaration

public SdfPath(string path)

Parameters

Type	Name	Description
String	path

Fields

swigCMemOwn

Declaration

protected bool swigCMemOwn

Field Value

Type	Description
Boolean

Methods

AbsoluteRootPath()

Declaration

public static SdfPath AbsoluteRootPath()

Returns

Type	Description
SdfPath

AppendChild(TfToken)

Declaration

public SdfPath AppendChild(TfToken childName)

Parameters

Type	Name	Description
TfToken	childName

Returns

Type	Description
SdfPath

AppendElementString(String)

Declaration

public SdfPath AppendElementString(string element)

Parameters

Type	Name	Description
String	element

Returns

Type	Description
SdfPath

AppendElementToken(TfToken)

Declaration

public SdfPath AppendElementToken(TfToken elementTok)

Parameters

Type	Name	Description
TfToken	elementTok

Returns

Type	Description
SdfPath

AppendExpression()

Declaration

public SdfPath AppendExpression()

Returns

Type	Description
SdfPath

AppendMapper(SdfPath)

Declaration

public SdfPath AppendMapper(SdfPath targetPath)

Parameters

Type	Name	Description
SdfPath	targetPath

Returns

Type	Description
SdfPath

AppendMapperArg(TfToken)

Declaration

public SdfPath AppendMapperArg(TfToken argName)

Parameters

Type	Name	Description
TfToken	argName

Returns

Type	Description
SdfPath

AppendPath(SdfPath)

Declaration

public SdfPath AppendPath(SdfPath newSuffix)

Parameters

Type	Name	Description
SdfPath	newSuffix

Returns

Type	Description
SdfPath

AppendProperty(TfToken)

Declaration

public SdfPath AppendProperty(TfToken propName)

Parameters

Type	Name	Description
TfToken	propName

Returns

Type	Description
SdfPath

AppendRelationalAttribute(TfToken)

Declaration

public SdfPath AppendRelationalAttribute(TfToken attrName)

Parameters

Type	Name	Description
TfToken	attrName

Returns

Type	Description
SdfPath

AppendTarget(SdfPath)

Declaration

public SdfPath AppendTarget(SdfPath targetPath)

Parameters

Type	Name	Description
SdfPath	targetPath

Returns

Type	Description
SdfPath

AppendVariantSelection(String, String)

Declaration

public SdfPath AppendVariantSelection(string variantSet, string variant)

Parameters

Type	Name	Description
String	variantSet
String	variant

Returns

Type	Description
SdfPath

ContainsPrimVariantSelection()

Declaration

public bool ContainsPrimVariantSelection()

Returns

Type	Description
Boolean

ContainsPropertyElements()

Declaration

public bool ContainsPropertyElements()

Returns

Type	Description
Boolean

ContainsTargetPath()

Declaration

public bool ContainsTargetPath()

Returns

Type	Description
Boolean

Dispose()

Declaration

public virtual void Dispose()

Implements

IDisposable.Dispose()

EmptyPath()

Declaration

public static SdfPath EmptyPath()

Returns

Type	Description
SdfPath

Equals(SdfPath, SdfPath)

Declaration

public static bool Equals(SdfPath lhs, SdfPath rhs)

Parameters

Type	Name	Description
SdfPath	lhs
SdfPath	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()

GetAbsoluteRootOrPrimPath()

Declaration

public SdfPath GetAbsoluteRootOrPrimPath()

Returns

Type	Description
SdfPath

GetAllTargetPathsRecursively(SdfPathVector)

Declaration

public void GetAllTargetPathsRecursively(SdfPathVector result)

Parameters

Type	Name	Description
SdfPathVector	result

GetAncestorsRange()

Declaration

public SdfPathAncestorsRange GetAncestorsRange()

Returns

Type	Description
SdfPathAncestorsRange

GetCommonPrefix(SdfPath)

Declaration

public SdfPath GetCommonPrefix(SdfPath path)

Parameters

Type	Name	Description
SdfPath	path

Returns

Type	Description
SdfPath

GetConciseRelativePaths(SdfPathVector)

Declaration

public static SdfPathVector GetConciseRelativePaths(SdfPathVector paths)

Parameters

Type	Name	Description
SdfPathVector	paths

Returns

Type	Description
SdfPathVector

GetElementString()

Declaration

public string GetElementString()

Returns

Type	Description
String

GetElementToken()

Declaration

public TfToken GetElementToken()

Returns

Type	Description
TfToken

GetHash()

Declaration

public uint GetHash()

Returns

Type	Description
UInt32

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
Int32

Overrides

Object.GetHashCode()

GetName()

Declaration

public string GetName()

Returns

Type	Description
String

GetNameToken()

Declaration

public TfToken GetNameToken()

Returns

Type	Description
TfToken

GetParentPath()

Declaration

public SdfPath GetParentPath()

Returns

Type	Description
SdfPath

GetPathElementCount()

Declaration

public uint GetPathElementCount()

Returns

Type	Description
UInt32

GetPrefixes()

Declaration

public SdfPathVector GetPrefixes()

Returns

Type	Description
SdfPathVector

GetPrefixes(SdfPathVector)

Declaration

public void GetPrefixes(SdfPathVector prefixes)

Parameters

Type	Name	Description
SdfPathVector	prefixes

GetPrimOrPrimVariantSelectionPath()

Declaration

public SdfPath GetPrimOrPrimVariantSelectionPath()

Returns

Type	Description
SdfPath

GetPrimPath()

Declaration

public SdfPath GetPrimPath()

Returns

Type	Description
SdfPath

GetString()

Declaration

public string GetString()

Returns

Type	Description
String

GetTargetPath()

Declaration

public SdfPath GetTargetPath()

Returns

Type	Description
SdfPath

GetText()

Declaration

public string GetText()

Returns

Type	Description
String

GetToken()

Declaration

public TfToken GetToken()

Returns

Type	Description
TfToken

GetVariantSelection()

Declaration

public SdfPathStringPair GetVariantSelection()

Returns

Type	Description
SdfPathStringPair

HasPrefix(SdfPath)

Declaration

public bool HasPrefix(SdfPath prefix)

Parameters

Type	Name	Description
SdfPath	prefix

Returns

Type	Description
Boolean

IsAbsolutePath()

Declaration

public bool IsAbsolutePath()

Returns

Type	Description
Boolean

IsAbsoluteRootOrPrimPath()

Declaration

public bool IsAbsoluteRootOrPrimPath()

Returns

Type	Description
Boolean

IsAbsoluteRootPath()

Declaration

public bool IsAbsoluteRootPath()

Returns

Type	Description
Boolean

IsEmpty()

Declaration

public bool IsEmpty()

Returns

Type	Description
Boolean

IsExpressionPath()

Declaration

public bool IsExpressionPath()

Returns

Type	Description
Boolean

IsMapperArgPath()

Declaration

public bool IsMapperArgPath()

Returns

Type	Description
Boolean

IsMapperPath()

Declaration

public bool IsMapperPath()

Returns

Type	Description
Boolean

IsNamespacedPropertyPath()

Declaration

public bool IsNamespacedPropertyPath()

Returns

Type	Description
Boolean

IsPrimOrPrimVariantSelectionPath()

Declaration

public bool IsPrimOrPrimVariantSelectionPath()

Returns

Type	Description
Boolean

IsPrimPath()

Declaration

public bool IsPrimPath()

Returns

Type	Description
Boolean

IsPrimPropertyPath()

Declaration

public bool IsPrimPropertyPath()

Returns

Type	Description
Boolean

IsPrimVariantSelectionPath()

Declaration

public bool IsPrimVariantSelectionPath()

Returns

Type	Description
Boolean

IsPropertyPath()

Declaration

public bool IsPropertyPath()

Returns

Type	Description
Boolean

IsRelationalAttributePath()

Declaration

public bool IsRelationalAttributePath()

Returns

Type	Description
Boolean

IsRootPrimPath()

Declaration

public bool IsRootPrimPath()

Returns

Type	Description
Boolean

IsTargetPath()

Declaration

public bool IsTargetPath()

Returns

Type	Description
Boolean

IsValidIdentifier(String)

Declaration

public static bool IsValidIdentifier(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

IsValidNamespacedIdentifier(String)

Declaration

public static bool IsValidNamespacedIdentifier(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

IsValidPathString(String)

Declaration

public static bool IsValidPathString(string pathString)

Parameters

Type	Name	Description
String	pathString

Returns

Type	Description
Boolean

IsValidPathString(String, SWIGTYPE_p_std__string)

Declaration

public static bool IsValidPathString(string pathString, SWIGTYPE_p_std__string errMsg)

Parameters

Type	Name	Description
String	pathString
SWIGTYPE_p_std__string	errMsg

Returns

Type	Description
Boolean

JoinIdentifier(StdStringVector)

Declaration

public static string JoinIdentifier(StdStringVector names)

Parameters

Type	Name	Description
StdStringVector	names

Returns

Type	Description
String

JoinIdentifier(TfToken, TfToken)

Declaration

public static string JoinIdentifier(TfToken lhs, TfToken rhs)

Parameters

Type	Name	Description
TfToken	lhs
TfToken	rhs

Returns

Type	Description
String

JoinIdentifier(TfTokenVector)

Declaration

public static string JoinIdentifier(TfTokenVector names)

Parameters

Type	Name	Description
TfTokenVector	names

Returns

Type	Description
String

JoinIdentifier(String, String)

Declaration

public static string JoinIdentifier(string lhs, string rhs)

Parameters

Type	Name	Description
String	lhs
String	rhs

Returns

Type	Description
String

MakeAbsolutePath(SdfPath)

Declaration

public SdfPath MakeAbsolutePath(SdfPath anchor)

Parameters

Type	Name	Description
SdfPath	anchor

Returns

Type	Description
SdfPath

MakeRelativePath(SdfPath)

Declaration

public SdfPath MakeRelativePath(SdfPath anchor)

Parameters

Type	Name	Description
SdfPath	anchor

Returns

Type	Description
SdfPath

ReflexiveRelativePath()

Declaration

public static SdfPath ReflexiveRelativePath()

Returns

Type	Description
SdfPath

RemoveAncestorPaths(SdfPathVector)

Declaration

public static void RemoveAncestorPaths(SdfPathVector paths)

Parameters

Type	Name	Description
SdfPathVector	paths

RemoveCommonSuffix(SdfPath)

Declaration

public SdfPathPair RemoveCommonSuffix(SdfPath otherPath)

Parameters

Type	Name	Description
SdfPath	otherPath

Returns

Type	Description
SdfPathPair

RemoveCommonSuffix(SdfPath, Boolean)

Declaration

public SdfPathPair RemoveCommonSuffix(SdfPath otherPath, bool stopAtRootPrim)

Parameters

Type	Name	Description
SdfPath	otherPath
Boolean	stopAtRootPrim

Returns

Type	Description
SdfPathPair

RemoveDescendentPaths(SdfPathVector)

Declaration

public static void RemoveDescendentPaths(SdfPathVector paths)

Parameters

Type	Name	Description
SdfPathVector	paths

ReplaceName(TfToken)

Declaration

public SdfPath ReplaceName(TfToken newName)

Parameters

Type	Name	Description
TfToken	newName

Returns

Type	Description
SdfPath

ReplacePrefix(SdfPath, SdfPath)

Declaration

public SdfPath ReplacePrefix(SdfPath oldPrefix, SdfPath newPrefix)

Parameters

Type	Name	Description
SdfPath	oldPrefix
SdfPath	newPrefix

Returns

Type	Description
SdfPath

ReplacePrefix(SdfPath, SdfPath, Boolean)

Declaration

public SdfPath ReplacePrefix(SdfPath oldPrefix, SdfPath newPrefix, bool fixTargetPaths)

Parameters

Type	Name	Description
SdfPath	oldPrefix
SdfPath	newPrefix
Boolean	fixTargetPaths

Returns

Type	Description
SdfPath

ReplaceTargetPath(SdfPath)

Declaration

public SdfPath ReplaceTargetPath(SdfPath newTargetPath)

Parameters

Type	Name	Description
SdfPath	newTargetPath

Returns

Type	Description
SdfPath

StripAllVariantSelections()

Declaration

public SdfPath StripAllVariantSelections()

Returns

Type	Description
SdfPath

StripNamespace(TfToken)

Declaration

public static TfToken StripNamespace(TfToken name)

Parameters

Type	Name	Description
TfToken	name

Returns

Type	Description
TfToken

StripNamespace(String)

Declaration

public static string StripNamespace(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
String

StripPrefixNamespace(String, String)

Declaration

public static SWIGTYPE_p_std__pairT_std__string_bool_t StripPrefixNamespace(string name, string matchNamespace)

Parameters

Type	Name	Description
String	name
String	matchNamespace

Returns

Type	Description
SWIGTYPE_p_std__pairT_std__string_bool_t

TokenizeIdentifier(String)

Declaration

public static StdStringVector TokenizeIdentifier(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
StdStringVector

TokenizeIdentifierAsTokens(String)

Declaration

public static TfTokenVector TokenizeIdentifierAsTokens(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
TfTokenVector

ToString()

Declaration

public override string ToString()

Returns

Type	Description
String

Overrides

Object.ToString()

Operators

Equality(SdfPath, SdfPath)

Declaration

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

Parameters

Type	Name	Description
SdfPath	lhs
SdfPath	rhs

Returns

Type	Description
Boolean

Implicit(SdfPath to String)

Declaration

public static implicit operator string (SdfPath value)

Parameters

Type	Name	Description
SdfPath	value

Returns

Type	Description
String

Inequality(SdfPath, SdfPath)

Declaration

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

Parameters

Type	Name	Description
SdfPath	lhs
SdfPath	rhs

Returns

Type	Description
Boolean