c4d.modules.graphview.GvPort ¶

A GvPort is a port of a GvNode -object. Please note, a GvPort object cannot be alive without its owner. Use GvNode.AddPort() to create a port.

class c4d.modules.graphview. GvPort ¶

• GvPort.Connect()
• GvPort.Remove()

• GvPort.GetNrOfConnections()
• GvPort.IsIncomingConnected()
• GvPort.GetDestination()
• GvPort.GetNode()

• GvPort.GetName()
• GvPort.SetName()

• GvPort.GetIO()

• GvPort.GetMainID()
• GvPort.SetMainID()

• GvPort.GetSubID()
• GvPort.GetUserID()

• GvPort.GetValueType()

• GvPort.SetVisible()
• GvPort.GetVisible()

• GvPort.SetUserData()
• GvPort.GetUserData()

Methods ¶

GvPort. Connect ( port ) ¶

Connects a port with another.

Note

Remember, the nodes of the ports have to be in the same GvNodeMaster , otherwise the connection fails.

Parameters:	port ( c4d.modules.graphview.GvPort ) – The port to connect to.
Return type:	bool
Returns:	True on succeeded connection, otherwise False .

GvPort. Remove ( ) ¶

Removes the connections of this port.

Return type:	bool
Returns:	True if the connection was removed, otherwise False .

GvPort. GetNrOfConnections ( ) ¶

Get the number of connections, including both the incoming connection and outgoing connections.

Return type:	int
Returns:	Number of connections.

GvPort. IsIncomingConnected ( ) ¶

Check if there’s an incoming connection.

Return type:	bool
Returns:	True if there’s an incoming connection to the port, otherwise False .

GvPort. GetDestination ( ) ¶

Returns the port where the port is linked with.

Return type:	list of type GvPort
Param:	A list with all destinations.

GvPort. GetNode ( ) ¶

Returns the node of this port.

Return type:	c4d.modules.graphview.GvNode
Param:	The container

GvPort. GetName ( node ) ¶

Gets the name of this port.

Parameters:	node ( c4d.modules.graphview.GvNode ) – The node the port belongs to
Return type:	str
Returns:	Port name.

GvPort. SetName ( name ) ¶

Sets the name of this port.

Parameters:	name ( str ) – Port name.

GvPort. GetIO ( ) ¶

Gets the IO mode for this port.

Return type:	int
Returns:	IO mode: GV_PORT_INPUT Input GV_PORT_OUTPUT Output GV_PORT_INVALID Invalid

GvPort. GetMainID ( ) ¶

Gets the main ID of the port.

Return type:	int
Returns:	Main ID.

GvPort. SetMainID ( ) ¶

Sets the main ID of the port.

Parameters:	id ( int ) – New main ID.

GvPort. GetSubID ( ) ¶

Gets the sub ID of the port.

Return type:	int
Returns:	Sub ID.

GvPort. GetUserID ( ) ¶

Gets the user ID of the port.

Return type:	int
Returns:	Sub ID.

GvPort. GetValueType ( ) ¶

Gets the value type of the port.

Return type:	int
Returns:	The value type.

GvPort. SetVisible ( v ) ¶

Set the visibility of the port.

Parameters:	v ( bool ) – False for an invisible port.

GvPort. GetVisible ( ) ¶

Checks if this port is hidden or visible.

Return type:	bool
Returns:	True if visible, otherwise False .

GvPort. SetUserData ( data ) ¶

New in version R17.048.

Internal.

GvPort. GetUserData ( ) ¶

New in version R17.048.

Internal.

Table Of Contents

• c4d.modules.graphview.GvPort
  • Methods