Class Connectable<T>
A USD attribute which can have a value or be connected to another attribute of matching type.
Conceptually, the targeted attribute value will flow into this attribute. The default value
is the value which will be specified when the attribute is not connected or the connection is
broken. The default value is only stored when the Connectable object is serialized and may be
time varying or uniform.
Inheritance
Connectable<T>
Syntax
public class Connectable<T> : Connectable
Type Parameters
Name |
Description |
T |
The underlying type held by the attribute.
|
Constructors
Connectable()
Declaration
Connectable(T)
Declaration
public Connectable(T defaultValue)
Parameters
Type |
Name |
Description |
T |
defaultValue |
|
Fields
defaultValue
Declaration
Field Value
Properties
connectedPath
Declaration
public string connectedPath { get; }
Property Value
Methods
GetConnectedPath()
Gets the connection path, which may or may not be a valid connection.
Declaration
public string GetConnectedPath()
Returns
Implements
GetValue()
Gets the local value of the attribute, for use when no connection is established.
Declaration
Returns
Implements
GetValueType()
Returns the C# type of this connectable object.
Declaration
public Type GetValueType()
Returns
Implements
IsConnected()
Returns true when a path has been specified, but does not check is this is a valid path in
the scene.
Declaration
public bool IsConnected()
Returns
SetConnectedPath(String)
Connects this attribute to the targeted path.
Declaration
public void SetConnectedPath(string path)
Parameters
Type |
Name |
Description |
String |
path |
|
Implements
SetConnectedPath(String, String)
Connects this attribute to the targeted attribute. Note that the path and attribute must
form a valid SdfPath.
Declaration
public void SetConnectedPath(string path, string attribute)
Parameters
SetValue(Object)
Sets the local value of the attribute, for use when no connection is established.
Declaration
public void SetValue(object value)
Parameters
Type |
Name |
Description |
Object |
value |
|
Implements