Class SdfPath
Namespace: pxr
Syntax
public class SdfPath : IDisposable
Constructors
SdfPath()
Declaration
SdfPath(String)
Declaration
public SdfPath(string path)
Parameters
| Type |
Name |
Description |
| String |
path |
|
Fields
swigCMemOwn
Declaration
protected bool swigCMemOwn
Field Value
Methods
AbsoluteRootPath()
Declaration
public static SdfPath AbsoluteRootPath()
Returns
AppendChild(TfToken)
Declaration
public SdfPath AppendChild(TfToken childName)
Parameters
| Type |
Name |
Description |
| TfToken |
childName |
|
Returns
AppendElementString(String)
Declaration
public SdfPath AppendElementString(string element)
Parameters
| Type |
Name |
Description |
| String |
element |
|
Returns
AppendElementToken(TfToken)
Declaration
public SdfPath AppendElementToken(TfToken elementTok)
Parameters
| Type |
Name |
Description |
| TfToken |
elementTok |
|
Returns
AppendExpression()
Declaration
public SdfPath AppendExpression()
Returns
AppendMapper(SdfPath)
Declaration
public SdfPath AppendMapper(SdfPath targetPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
targetPath |
|
Returns
AppendMapperArg(TfToken)
Declaration
public SdfPath AppendMapperArg(TfToken argName)
Parameters
| Type |
Name |
Description |
| TfToken |
argName |
|
Returns
AppendPath(SdfPath)
Declaration
public SdfPath AppendPath(SdfPath newSuffix)
Parameters
| Type |
Name |
Description |
| SdfPath |
newSuffix |
|
Returns
AppendProperty(TfToken)
Declaration
public SdfPath AppendProperty(TfToken propName)
Parameters
| Type |
Name |
Description |
| TfToken |
propName |
|
Returns
AppendRelationalAttribute(TfToken)
Declaration
public SdfPath AppendRelationalAttribute(TfToken attrName)
Parameters
| Type |
Name |
Description |
| TfToken |
attrName |
|
Returns
AppendTarget(SdfPath)
Declaration
public SdfPath AppendTarget(SdfPath targetPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
targetPath |
|
Returns
AppendVariantSelection(String, String)
Declaration
public SdfPath AppendVariantSelection(string variantSet, string variant)
Parameters
Returns
ContainsPrimVariantSelection()
Declaration
public bool ContainsPrimVariantSelection()
Returns
ContainsPropertyElements()
Declaration
public bool ContainsPropertyElements()
Returns
ContainsTargetPath()
Declaration
public bool ContainsTargetPath()
Returns
Dispose()
Declaration
public virtual void Dispose()
Implements
EmptyPath()
Declaration
public static SdfPath EmptyPath()
Returns
Equals(SdfPath, SdfPath)
Declaration
public static bool Equals(SdfPath lhs, SdfPath 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()
GetAbsoluteRootOrPrimPath()
Declaration
public SdfPath GetAbsoluteRootOrPrimPath()
Returns
GetAllTargetPathsRecursively(SdfPathVector)
Declaration
public void GetAllTargetPathsRecursively(SdfPathVector result)
Parameters
GetAncestorsRange()
Declaration
public SdfPathAncestorsRange GetAncestorsRange()
Returns
GetCommonPrefix(SdfPath)
Declaration
public SdfPath GetCommonPrefix(SdfPath path)
Parameters
Returns
GetConciseRelativePaths(SdfPathVector)
Declaration
public static SdfPathVector GetConciseRelativePaths(SdfPathVector paths)
Parameters
Returns
GetElementString()
Declaration
public string GetElementString()
Returns
GetElementToken()
Declaration
public TfToken GetElementToken()
Returns
GetHash()
Declaration
Returns
GetHashCode()
Declaration
public override int GetHashCode()
Returns
Overrides
GetName()
Declaration
Returns
GetNameToken()
Declaration
public TfToken GetNameToken()
Returns
GetParentPath()
Declaration
public SdfPath GetParentPath()
Returns
GetPathElementCount()
Declaration
public uint GetPathElementCount()
Returns
GetPrefixes()
Declaration
public SdfPathVector GetPrefixes()
Returns
GetPrefixes(SdfPathVector)
Declaration
public void GetPrefixes(SdfPathVector prefixes)
Parameters
GetPrimOrPrimVariantSelectionPath()
Declaration
public SdfPath GetPrimOrPrimVariantSelectionPath()
Returns
GetPrimPath()
Declaration
public SdfPath GetPrimPath()
Returns
GetString()
Declaration
public string GetString()
Returns
GetTargetPath()
Declaration
public SdfPath GetTargetPath()
Returns
GetText()
Declaration
Returns
GetToken()
Declaration
public TfToken GetToken()
Returns
GetVariantSelection()
Declaration
public SdfPathStringPair GetVariantSelection()
Returns
HasPrefix(SdfPath)
Declaration
public bool HasPrefix(SdfPath prefix)
Parameters
| Type |
Name |
Description |
| SdfPath |
prefix |
|
Returns
IsAbsolutePath()
Declaration
public bool IsAbsolutePath()
Returns
IsAbsoluteRootOrPrimPath()
Declaration
public bool IsAbsoluteRootOrPrimPath()
Returns
IsAbsoluteRootPath()
Declaration
public bool IsAbsoluteRootPath()
Returns
IsEmpty()
Declaration
Returns
IsExpressionPath()
Declaration
public bool IsExpressionPath()
Returns
IsMapperArgPath()
Declaration
public bool IsMapperArgPath()
Returns
IsMapperPath()
Declaration
public bool IsMapperPath()
Returns
IsNamespacedPropertyPath()
Declaration
public bool IsNamespacedPropertyPath()
Returns
IsPrimOrPrimVariantSelectionPath()
Declaration
public bool IsPrimOrPrimVariantSelectionPath()
Returns
IsPrimPath()
Declaration
Returns
IsPrimPropertyPath()
Declaration
public bool IsPrimPropertyPath()
Returns
IsPrimVariantSelectionPath()
Declaration
public bool IsPrimVariantSelectionPath()
Returns
IsPropertyPath()
Declaration
public bool IsPropertyPath()
Returns
IsRelationalAttributePath()
Declaration
public bool IsRelationalAttributePath()
Returns
IsRootPrimPath()
Declaration
public bool IsRootPrimPath()
Returns
IsTargetPath()
Declaration
public bool IsTargetPath()
Returns
IsValidIdentifier(String)
Declaration
public static bool IsValidIdentifier(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
IsValidNamespacedIdentifier(String)
Declaration
public static bool IsValidNamespacedIdentifier(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
IsValidPathString(String)
Declaration
public static bool IsValidPathString(string pathString)
Parameters
| Type |
Name |
Description |
| String |
pathString |
|
Returns
IsValidPathString(String, SWIGTYPE_p_std__string)
Declaration
public static bool IsValidPathString(string pathString, SWIGTYPE_p_std__string errMsg)
Parameters
Returns
JoinIdentifier(StdStringVector)
Declaration
public static string JoinIdentifier(StdStringVector names)
Parameters
Returns
JoinIdentifier(TfToken, TfToken)
Declaration
public static string JoinIdentifier(TfToken lhs, TfToken rhs)
Parameters
Returns
JoinIdentifier(TfTokenVector)
Declaration
public static string JoinIdentifier(TfTokenVector names)
Parameters
Returns
JoinIdentifier(String, String)
Declaration
public static string JoinIdentifier(string lhs, string rhs)
Parameters
Returns
MakeAbsolutePath(SdfPath)
Declaration
public SdfPath MakeAbsolutePath(SdfPath anchor)
Parameters
| Type |
Name |
Description |
| SdfPath |
anchor |
|
Returns
MakeRelativePath(SdfPath)
Declaration
public SdfPath MakeRelativePath(SdfPath anchor)
Parameters
| Type |
Name |
Description |
| SdfPath |
anchor |
|
Returns
ReflexiveRelativePath()
Declaration
public static SdfPath ReflexiveRelativePath()
Returns
RemoveAncestorPaths(SdfPathVector)
Declaration
public static void RemoveAncestorPaths(SdfPathVector paths)
Parameters
RemoveCommonSuffix(SdfPath)
Declaration
public SdfPathPair RemoveCommonSuffix(SdfPath otherPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
otherPath |
|
Returns
RemoveCommonSuffix(SdfPath, Boolean)
Declaration
public SdfPathPair RemoveCommonSuffix(SdfPath otherPath, bool stopAtRootPrim)
Parameters
Returns
RemoveDescendentPaths(SdfPathVector)
Declaration
public static void RemoveDescendentPaths(SdfPathVector paths)
Parameters
ReplaceName(TfToken)
Declaration
public SdfPath ReplaceName(TfToken newName)
Parameters
| Type |
Name |
Description |
| TfToken |
newName |
|
Returns
ReplacePrefix(SdfPath, SdfPath)
Declaration
public SdfPath ReplacePrefix(SdfPath oldPrefix, SdfPath newPrefix)
Parameters
Returns
ReplacePrefix(SdfPath, SdfPath, Boolean)
Declaration
public SdfPath ReplacePrefix(SdfPath oldPrefix, SdfPath newPrefix, bool fixTargetPaths)
Parameters
Returns
ReplaceTargetPath(SdfPath)
Declaration
public SdfPath ReplaceTargetPath(SdfPath newTargetPath)
Parameters
| Type |
Name |
Description |
| SdfPath |
newTargetPath |
|
Returns
StripAllVariantSelections()
Declaration
public SdfPath StripAllVariantSelections()
Returns
StripNamespace(TfToken)
Declaration
public static TfToken StripNamespace(TfToken name)
Parameters
Returns
StripNamespace(String)
Declaration
public static string StripNamespace(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
StripPrefixNamespace(String, String)
Declaration
public static SWIGTYPE_p_std__pairT_std__string_bool_t StripPrefixNamespace(string name, string matchNamespace)
Parameters
Returns
TokenizeIdentifier(String)
Declaration
public static StdStringVector TokenizeIdentifier(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
TokenizeIdentifierAsTokens(String)
Declaration
public static TfTokenVector TokenizeIdentifierAsTokens(string name)
Parameters
| Type |
Name |
Description |
| String |
name |
|
Returns
ToString()
Declaration
public override string ToString()
Returns
Overrides
Operators
Equality(SdfPath, SdfPath)
Declaration
public static bool operator ==(SdfPath lhs, SdfPath rhs)
Parameters
Returns
Implicit(SdfPath to String)
Declaration
public static implicit operator string (SdfPath value)
Parameters
| Type |
Name |
Description |
| SdfPath |
value |
|
Returns
Inequality(SdfPath, SdfPath)
Declaration
public static bool operator !=(SdfPath lhs, SdfPath rhs)
Parameters
Returns