c4d.modules.graphview.GvNodeMaster

A GvNodeMaster stores a collection of GvNode

Definition

class c4d.modules.graphview.GvNodeMaster

• GvNodeMaster.__init__()

• GvNodeMaster.AllocNode()
• GvNodeMaster.CreateNode()

• GvNodeMaster.GetRoot()
• GvNodeMaster.GetOwner()
• GvNodeMaster.InsertFirst()
• GvNodeMaster.InsertLast()
• GvNodeMaster.SetHierarchy()

• GvNodeMaster.IsEnabled()

• GvNodeMaster.GetPrefs()
• GvNodeMaster.SetPrefs()
• GvNodeMaster.AddUndo()

• GvNodeMaster.Execute()

Inheritance

• c4d.BaseList2D

  • c4d.modules.graphview.GvNodeMaster

Methods

GvNodeMaster.__init__(host)

Parameters:host (BaseList2D) – Attaches a GvNodeMaster to a BaseList2D object. Return type:GvNodeMaster Returns:The new nodemaster.

GvNodeMaster.AllocNode(id)

Allocates a node without inserting it.

Parameters:id (int) – The id. See Graph View Node Types. Return type:GvNode Returns:The new node.

GvNodeMaster.CreateNode(parent, id[, insert=None][, x=-1][, y=-1])

Creates a node and inserts it.

Parameters:

• parent (GvNode) – Parent node, can be GetRoot().
• id (int) – The id. See Graph View Node Types.
• insert (GvNode) – The insertion point.
• x (int) – X position
• y (int) – Y position.

Return type:

GvNode

Returns:

The created node.

GvNodeMaster.GetRoot()

Retrieves the root node.

Return type:GvNode Returns:The root node or None.

GvNodeMaster.GetOwner()

Retrieves the owner.

Return type:BaseList2D Returns:The owner of the GvNodeMaster

GvNodeMaster.InsertFirst(parent, node)

Inserts a node first in the node list of an Xgroup. (Equivalent to GeListNode.InsertUnder(), but with additional checks that parent is a group node, and that node is removed.)

Parameters:

• parent (GvNode) – Parent node. Must be in the same node master.
• node (GvNode) – Node to insert.

Return type:

bool

Returns:

True if the node was inserted, otherwise False.

GvNodeMaster.InsertLast(parent, node)

Inserts a node last in the node list of an Xgroup. (Equivalent to GeListNode.InsertUnderLast(), but with additional checks that parent is a group node, and that node is removed.)

Parameters:

• parent (GvNode) – Parent node. Must be in the same node master.
• node (GvNode) – Node to insert.

Return type:

bool

Returns:

True if the node was inserted, otherwise False.

GvNodeMaster.SetHierarchy(insert, node[, mode=GV_INSERT_AFTER])

Perform a hierarchy operation. Pass the arguments as a dictionary.

Parameters:

• insert (GvNode) – Insertion point.
• node (GvNode) – The node to perform the operation on.
• mode (int) –

  The insertion mode:

  GV_INSERT_UNDER	Input port.
  GV_INSERT_UNDER_LAST	Insert under as last item.
  GV_INSERT_BEFORE	Insert before.
  GV_INSERT_AFTER	Insert after.
  GV_INSERT_NONE	Not used.

Return type:

bool

Returns:

True if the hierarchy was set, otherwise False.

GvNodeMaster.IsEnabled()

Checks if the node master is enabled.

Return type:GvNodeMaster Returns:True if the node master is enabled.

GvNodeMaster.GetPrefs()

Returns the settings container.

Return type:BaseContainer Returns:A copy of the settings container.

GvNodeMaster.SetPrefs(bc)

Set the settings container.

Parameters:bc (BaseContainer) – The settings container.

GvNodeMaster.AddUndo()

Call this function if you manipulated something with a node master, and you want it to be undoable.

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

GvNodeMaster.Execute()

Calculates the GvNodeMaster.