|
HDK
|
#include <UNI_Port.h>
Inheritance diagram for UNI_Port:Public Member Functions | |
| void | setName (const UT_StringHolder &name) |
| Set the name of a port, if allowed. More... | |
| UNI_WireID | addSrc (UNI_PortID src) |
| Connect a new source to this port (which is the destination). More... | |
| void | updateDownstreamPortTypes (bool update_port) const |
Public Member Functions inherited from UNI_Item< UNI_PortID, UNI_SessionPortID, UNI_ConstPort > | |
| UNI_Item ()=default | |
| Constructor. More... | |
| UNI_Item (const UNI_GraphHandle &graph_handle, UNI_PortIDid) | |
| UNI_Item (UNI_GraphHandle &&graph_handle, UNI_PortIDid) | |
| Constructor with r-value for the intrusive graph pointer. More... | |
| UNI_Graph * | graph () const |
| Returns the graph inside which the node lives. More... | |
| UNI_Item (UNI_SessionPortIDsession_id) | |
| Other convenience constructors. More... | |
| UNI_Item (UNI_GraphID graph_id, UNI_PortIDid) | |
| Other convenience constructors. More... | |
Public Member Functions inherited from UNI_ConstPort | |
| UNI_NodeID | node () const |
| Returns the UNI_Node that owns this port. More... | |
| UNI_PortKind | portKind () const |
| Returns what kind of a port this is: input or output. More... | |
| UT_StringHolder | label () const |
| Returns the label for the port. More... | |
| UT_StringHolder | name () const |
| Returns the name of the port. More... | |
| bool | canSetName () const |
| Return true if the port name can be changed. More... | |
| UT_StringHolder | typeName () const |
| Returns the name of the data type for the given port. More... | |
| UT_StringHolder | colorName () const |
| UNI_PortShape | shape () const |
| Returns the UI shape of the port socket. More... | |
| UNI_WireIDList | srcWires () const |
| UNI_WireIDList | dstWires () const |
Public Member Functions inherited from UNI_ConstItem< UNI_PortID > | |
| UNI_ConstItem ()=default | |
| Constructor. More... | |
| UNI_ConstItem (const UNI_ConstGraphHandle &graph_handle, UNI_PortIDid) | |
| UNI_ConstItem (UNI_ConstGraphHandle &&graph_handle, UNI_PortIDid) | |
| Constructor with r-value for the intrusive graph pointer. More... | |
| const UNI_Graph * | graph () const |
| Returns the graph inside which the node lives. More... | |
| UNI_PortID | id () const |
| Returns the ID of the node in the graph. More... | |
| bool | isValid () const |
| operator bool () const | |
Additional Inherited Members | |
Public Types inherited from UNI_Item< UNI_PortID, UNI_SessionPortID, UNI_ConstPort > | |
| using | ChangeBlock = UNI_Graph::ChangeBlock |
| Alias the change block for use in this class, for brevity. More... | |
| using | ChangeType = UNI_GraphChangeType |
Protected Member Functions inherited from UNI_ConstItem< UNI_PortID > | |
| const UNI_ConstGraphHandle & | graphHandle () const |
| Returns the underlying graph handle. More... | |
Definition at line 91 of file UNI_Port.h.
| UNI_WireID UNI_Port::addSrc | ( | UNI_PortID | src | ) |
Connect a new source to this port (which is the destination).
| void UNI_Port::setName | ( | const UT_StringHolder & | name | ) |
Set the name of a port, if allowed.
| void UNI_Port::updateDownstreamPortTypes | ( | bool | update_port | ) | const |
Ensures the node signatures and port types are up-to-date for all the nodes downstream of the given port. If update_port is true, the given port is updated too.