Document¶

This class describes a document. A document may contain objects of following classes: samson.DataModel.Document.Folder, samson.DataModel.Document.Camera, samson.DataModel.DataGraph.Group, samson.Modeling.StructuralModel.Conformation, and samson.Modeling.StructuralModel.Path.

There is always one active document - the one visible in the Document view.

You can access the active document through samson.Facade.SAMSON:

activeDocument = SAMSON.getActiveDocument()

The set of selected nodes is accessible from the document:

selectedNodesIndexer = activeDocument.getSelectedNodes()

This node indexer is a copy of an internal node indexer of the selected nodes and any you can modify this node - it does not affect the selection. Note, that if the selection has been modified this node indexer is not updated and you need to call the samson.DataModel.Document.Document.getSelectedNodes() function again.

You can access nodes in the node indexer to perform some actions e.g. remove them from the selection:

for node in selectedNodesIndexer:
  node.selectionFlag = False

You can also add nodes to selection and remove them from the selection yourself by modifying the selection flag of a node:

activeDocument.selectionFlag = True           # the node is selected
activeDocument.selectionFlag = False          # the node is deselected

or by modyfing the document selection itself:

activeDocument.addNodeToSelection(node)       # the node is selected
activeDocument.removeNodeFromSelection(node)  # the node is deselected

Note that you should always turn the “Undo system” on when modifying the selection:

SAMSON.beginHolding("Modify selection")       # turn the undo system on
SAMSON.getActiveDocument().clearSelection()   # clear the selection
SAMSON.endHolding()                           # turn the undo system off

This allows for undoing:

SAMSON.undo()                                 # go back to before clearing