Difference between revisions of "Port"
Jump to navigation
Jump to search
(Created page with "A Port is an input or output of a Node. Ports are connected to Pipes to hook nodes together. Ports are bound to image Properties. ==== Attributes ==...") |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
A Port is an input or output of a [[Node]]. Ports are connected to [[Pipe|Pipes]] to hook nodes together. Ports are bound to image [[Property|Properties]]. | A Port is an input or output of a [[Node]]. Ports are connected to [[Pipe|Pipes]] to hook nodes together. Ports are bound to image [[Property|Properties]]. | ||
| − | + | === Attributes === | |
{| class="wikitable" | {| class="wikitable" | ||
! scope="col" | Name | ! scope="col" | Name | ||
! scope="col" class="unsortable" | Description | ! scope="col" class="unsortable" | Description | ||
| + | ! scope="col" | Added | ||
|- | |- | ||
|node | |node | ||
| Line 14: | Line 15: | ||
|property | |property | ||
|The [[Property]] this port is bound to. | |The [[Property]] this port is bound to. | ||
| + | |- | ||
| + | |connected | ||
| + | |True if the port has any connected [[Pipe|Pipes]] | ||
| + | |6.0 | ||
| + | |- | ||
| + | |name | ||
| + | |the name of the [[Property]] associated with this port | ||
| + | |6.0 | ||
| + | |- | ||
| + | |source | ||
| + | |the source port if this port is connected to an output port, or None | ||
| + | |6.0 | ||
| + | |- | ||
| + | |targets | ||
| + | |if this port is an output port, a list of input ports this is connected to, or None | ||
| + | |6.0 | ||
| + | |- | ||
| + | |hidden | ||
| + | |True if the port is hidden | ||
| + | |6.0 | ||
| + | |- | ||
| + | |is_input | ||
| + | |True if this is an input port | ||
| + | |6.0 | ||
| + | |- | ||
| + | |is_output | ||
| + | |True if this is an output port | ||
| + | |6.0 | ||
| + | |- | ||
| + | |is_aux | ||
| + | |True if this is an auxillary port | ||
| + | |6.0 | ||
| + | |- | ||
| + | |is_matte | ||
| + | |True if this is a [[Node|Node's]] "obey matte" input | ||
| + | |6.0 | ||
| + | |} | ||
| + | |||
| + | === Methods === | ||
| + | {| class="wikitable" | ||
| + | ! scope="col" | Name | ||
| + | ! scope="col" class="unsortable" | Description | ||
| + | ! scope="col" | Added | ||
| + | |- | ||
| + | |canConnect(target) | ||
| + | |returns True if this Port can be connected to the target Port | ||
| + | |6.0 | ||
| + | |- | ||
| + | |connect(target) | ||
| + | |connects the Port to <tt>target</tt> and returns a new [[Pipe]] | ||
| + | |6.0 | ||
| + | |- | ||
| + | |disconnect(pipe) | ||
| + | |disconnects the [[Pipe]] (also disconnects from the port at the other end) | ||
| + | |6.0 | ||
|} | |} | ||
Latest revision as of 21:47, 25 July 2018
A Port is an input or output of a Node. Ports are connected to Pipes to hook nodes together. Ports are bound to image Properties.
Attributes
| Name | Description | Added |
|---|---|---|
| node | The port's Node | |
| pipes | The List of Pipes connected to this port. | |
| property | The Property this port is bound to. | |
| connected | True if the port has any connected Pipes | 6.0 |
| name | the name of the Property associated with this port | 6.0 |
| source | the source port if this port is connected to an output port, or None | 6.0 |
| targets | if this port is an output port, a list of input ports this is connected to, or None | 6.0 |
| hidden | True if the port is hidden | 6.0 |
| is_input | True if this is an input port | 6.0 |
| is_output | True if this is an output port | 6.0 |
| is_aux | True if this is an auxillary port | 6.0 |
| is_matte | True if this is a Node's "obey matte" input | 6.0 |
Methods
| Name | Description | Added |
|---|---|---|
| canConnect(target) | returns True if this Port can be connected to the target Port | 6.0 |
| connect(target) | connects the Port to target and returns a new Pipe | 6.0 |
| disconnect(pipe) | disconnects the Pipe (also disconnects from the port at the other end) | 6.0 |
