c4d.modules.graphview.GvNode

Cannot be instantiated. Use GvNodeMaster.CreateNode() to create nodes. The GvNode is a double BaseList2D node.

Note

Please use GvNode.GetOperatorContainer() to access most parameters.

A GvNode is a node which is stored in a GvNodeMaster. A node contains ports represented by GvPort.

Definition

class c4d.modules.graphview.GvNode

• GvNode.Redraw()

• GvNode.GetNodeMaster()
• GvNode.GetOperatorID()
• GvNode.GetOwnerID()
• GvNode.IsGroupNode()
• GvNode.Redraw()

• GvNode.GetOperatorContainer()
• GvNode.SetOperatorContainer()

• GvNode.AddPort()
• GvNode.AddPortIsOK()

• GvNode.SetPortType()
• GvNode.ResetPortType()

• GvNode.RemovePort()
• GvNode.RemovePortIsOK()
• GvNode.RemoveUnusedPorts()
• GvNode.RemoveConnections()

• GvNode.GetInPortCount()
• GvNode.GetOutPortCount()

• GvNode.GetInPorts()
• GvNode.GetOutPorts()
• GvNode.GetInPort()
• GvNode.GetOutPort()

• GvNode.GetPortIndex()
• GvNode.GetPort()

Inheritance

• c4d.BaseList2D
  • c4d.modules.graphview.GvNode

Members

GvNode.Redraw()

Redraws the node.

GvNode.GetOperatorID()

Returns the operator ID.

Return type: int Returns: The id.

GvNode.GetOwnerID()

Returns the owner ID of the node.

Return type: int Returns: The id.

ID_GV_SYSTEM_OWNER	System.
ID_GV_GENERAL_OWNER	General.
ID_GV_IGNORE_OWNER	Ignore owner.

GvNode.GetNodeMaster()

Returns the GvNodeMaster where the node is attached to.

Return type: GvNodeMaster Parameters: mask – The GvNodeMaster or None if there is no nodemaster.

GvNode.IsGroupNode()

Checks if the node is a group node.

Return type: bool Parameters: mask – True if the node is a group node, otherwise False.

GvNode.SetPortType(port, id)

Changes the type of a port of this node.

Parameters:

• port (GvPort) – A port of this node.
• id (int) – The new port ID.

GvNode.ResetPortType(id)

Changes the type of the port. Used to manage dynamic data ports.

Parameters: id (int) – The type.

GvNode.RemoveUnusedPorts([message=True])

Removes all unused ports - Sends a message to the node.

Parameters: message (bool) – If this is True, the operator receives a message when the ports are removed.

GvNode.RemoveConnections()

Removes all connections of the node.

GvNode.RemovePort(port[, message=False])

Removes a port from this node.

Parameters:

• port (GvPort) – A port of this node to remove.
• message (bool) – If this is True the operator receives a message when the port is removed.

GvNode.RemovePortIsOK(port)

hecks if it’s OK to remove a port from this node. Used to check if a call to GvNode.RemovePort() would succeed.

Parameters:

• port (GvPort) – A port of this node to remove.
• message (bool) – True if this port can be remove.

GvNode.GetPort(sub_id)

Retrieves a port by sub ID.

Parameters: sub_id (int) – Port sub ID. Return type: GvPort Returns: The retrieved port, or None.

GvNode.GetPortIndex(id)

Gets the index of a port by sub ID.

Parameters: id (int) – Port sub ID. Return type: int Returns: Port index.

GvNode.GetOutPorts(type=-1)

Retrieves all outports of a node.

Parameters: type (int) – If type is set, just the ports with the given type will be returned. Each port has its own type ID’s for the ports so check the C-header files of the node. Return type: list of GvPort Returns: The GvPorts or None if no port was found.

GvNode.GetInPorts(type=-1)

Retrieves all inports of a node.

Parameters: type (int) – If type is set, just the ports with the given type will be returned. Each port has its own type ID’s for the ports so check the C-header files of the node. Return type: list of GvPort Returns: The GvPorts or None if no port was found.

GvNode.GetInPort(id)

Retrieves an inport by index.

Parameters: id (int) – the index Return type: GvPort Returns: The GvPort or None if no port was found.

GvNode.GetOutPort(id)

Retrieves an outport by index.

Parameters: id (int) – the index Return type: GvPort Returns: The GvPort or None if no port was found.

GvNode.GetInPortCount()

Returns the count of the inports.

Return type: int Returns: The count

GvNode.GetOutPortCount()

Returns the count of the outports.

Parameters: num (int) – The count

GvNode.SetOperatorContainer(bc)

Set the settings container.

Parameters: str – The container

GvNode.GetOperatorContainer()

Returns the settings container.

Return type: BaseContainer Returns: The container

GvNode.AddPort(io, id)

Adds a port to the node.

Parameters:

• io (int) –

  The port mode

  GV_PORT_INPUT	Input
  GV_PORT_OUTPUT	Output
  GV_PORT_INVALID	Invalid

• id (int) – The type id of the port.

Return type:

GvPort

Returns:

The created port or None if creation failed.

GvNode.AddPortIsOK(io, id)

Checks if AddPort() would be successfull.

Parameters:

• io (int) –

  The port mode:

  GV_PORT_INPUT	Input
  GV_PORT_OUTPUT	Output
  GV_PORT_INVALID	Invalid

• id (int) – The type id of the port.

Return type:

bool

Returns:

Returns True if adding the port would succeed, otherwise False.