Group¶

This class describes a group of nodes. In SAMSON, the user may group selected nodes. Groups added to a document appear in the document view, and the user may perform various operations using groups, e.g. select the nodes in the group, intersect the current selection with the nodes in the group, etc.

Let’s for example create a group which contains references to all currently selected nodes.

# get the active document
activeDocument = SAMSON.getActiveDocument()

# get a node indexer of all currently selected nodes
selectedNodesIndexer = activeDocument.getSelectedNodes()

# construct a group based on the node indexer
group = sam.DataModel.DataGraph.Group("My selection", selectedNodesIndexer)

# turn the undo system on
SAMSON.beginHolding("Group selection")

# hold the group
SAMSON.hold(group)

# create the group (it node should be created before adding it to another node of the data graph)
group.create()

# add the group to the active document
activeDocument.addChild(group)

# turn the undo system off
SAMSON.endHolding()

You can get the node indexer of nodes in the group using the samson.DataModel.DataGraph.Group.getGroupNodes() function:

groupNodesIndexer = group.getGroupNodes()
groupNodesIndexer.size

You can also clone a group to, for example, create another modified group:

clonedGroup = group.clone()
clonedGroup.name = "My selection 2"

SAMSON.beginHolding("Group selection")
SAMSON.hold(clonedGroup)

clonedGroup.create()
activeDocument.addChild(clonedGroup)

SAMSON.endHolding()