Class Relationship
A UsdRelationship allows a prim to target another object in the scenegraph.
The semantic meaning of the relationship is defined by the schema, for example UsdShade
uses a "material:binding" relationship to indicate the material which should be bound to
the prim declaring the attribute.
Syntax
public class Relationship
Constructors
Relationship()
Declaration
Relationship(String)
Declaration
public Relationship(string targetPath)
Parameters
| Type |
Name |
Description |
| String |
targetPath |
|
Relationship(String[])
Declaration
public Relationship(string[] targetPaths)
Parameters
| Type |
Name |
Description |
| String[] |
targetPaths |
|
Fields
targetPaths
Declaration
public string[] targetPaths
Field Value
Methods
GetOnlyTarget()
Returns the first target path. If there is not exactly one target path, an exception is
thrown.
Declaration
public string GetOnlyTarget()
Returns
GetTarget(Int32)
Returns the i_th target or null if fewer than i+1 targets are specified.
Declaration
public string GetTarget(int index)
Parameters
| Type |
Name |
Description |
| Int32 |
index |
|
Returns
Operators
Implicit(String to Relationship)
Declaration
public static implicit operator Relationship(string path)
Parameters
| Type |
Name |
Description |
| String |
path |
|
Returns
Implicit(String[] to Relationship)
Declaration
public static implicit operator Relationship(string[] paths)
Parameters
| Type |
Name |
Description |
| String[] |
paths |
|
Returns
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.