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
See also
SAMSON API: SBDDocument
- class samson.DataModel.Document.Document(*args, **kwargs)¶
Bases:
samson.DataModel.Document.Folder
This class describes a document.
Overloaded function.
__init__(self: samson.DataModel.Document.Document) -> None
Constructs a document
__init__(self: samson.DataModel.Document.Document, name: str) -> None
Constructs a document with name
- class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, value: int) None ¶
Bases:
pybind11_builtins.pybind11_object
Members:
Undefined
StructuralModel
StructuralModelNode
Conformation
StructuralModelConformation
Path
StructuralModelPath
StructuralGroup
StructuralModelNodeGroup
Root
StructuralModelNodeRoot
StructuralParticle
StructuralModelNodeParticle
Atom
StructuralModelNodeAtom
PseudoAtom
StructuralModelNodePseudoAtom
Bond
StructuralModelNodeBond
PseudoBond
StructuralModelNodePseudoBond
HydrogenBond
StructuralModelNodeHydrogenBond
HydrogenBondGroup
StructuralModelNodeHydrogenBondGroup
Residue
StructuralModelNodeResidue
Segment
StructuralModelNodeSegment
Protein
StructuralModelNodeProtein
Chain
StructuralModelNodeChain
Molecule
StructuralModelNodeMolecule
Backbone
StructuralModelNodeBackbone
SideChain
StructuralModelNodeSideChain
VisualModel
Mesh
VisualModelMesh
DynamicalModel
ParticleSystem
DynamicalModelParticleSystem
RigidBodySystem
DynamicalModelRigidBodySystem
ArticulatedBodySystem
DynamicalModelArticulatedBodySystem
DynamicalNode
DynamicalModelNode
DynamicalGroup
DynamicalModelNodeGroup
DynamicalRoot
DynamicalModelNodeRoot
DynamicalParticle
DynamicalModelNodeParticle
RigidBody
DynamicalModelNodeRigidBody
ArticulatedBody
DynamicalModelNodeArticulatedBody
InteractionModel
InteractionModelParticleSystem
InteractionModelRigidBodySystem
InteractionModelArticulatedBodySystem
PropertyModel
PropertyModelFunction
Simulator
SimulatorParticleSystem
SimulatorRigidBodySystem
SimulatorArticulatedBodySystem
StateUpdater
StateUpdaterParticleSystem
StateUpdaterRigidBodySystem
StateUpdaterArticulatedBodySystem
DocumentManager
Document
Folder
Camera
Label
Note
Animation
Presentation
DataGraphNodeGroup
NodeGroup
Controller
ControllerNode
Asset
- Animation = <NodeType.Animation: 26>¶
- ArticulatedBody = <NodeType.ArticulatedBody: 603>¶
- ArticulatedBodySystem = <NodeType.ArticulatedBodySystem: 502>¶
- Asset = <NodeType.Asset: 50>¶
- Atom = <NodeType.Atom: 20100>¶
- Backbone = <NodeType.Backbone: 209>¶
- Bond = <NodeType.Bond: 202>¶
- Camera = <NodeType.Camera: 23>¶
- Chain = <NodeType.Chain: 207>¶
- Conformation = <NodeType.Conformation: 28>¶
- Controller = <NodeType.Controller: 40>¶
- ControllerNode = <NodeType.ControllerNode: 41>¶
- DataGraphNodeGroup = <NodeType.DataGraphNodeGroup: 30>¶
- Document = <NodeType.Document: 21>¶
- DocumentManager = <NodeType.DocumentManager: 20>¶
- DynamicalGroup = <NodeType.DynamicalGroup: 600>¶
- DynamicalModel = <NodeType.DynamicalModel: 5>¶
- DynamicalModelArticulatedBodySystem = <NodeType.ArticulatedBodySystem: 502>¶
- DynamicalModelNode = <NodeType.DynamicalNode: 6>¶
- DynamicalModelNodeArticulatedBody = <NodeType.ArticulatedBody: 603>¶
- DynamicalModelNodeGroup = <NodeType.DynamicalGroup: 600>¶
- DynamicalModelNodeParticle = <NodeType.DynamicalParticle: 601>¶
- DynamicalModelNodeRigidBody = <NodeType.RigidBody: 602>¶
- DynamicalModelNodeRoot = <NodeType.DynamicalRoot: 60000>¶
- DynamicalModelParticleSystem = <NodeType.ParticleSystem: 500>¶
- DynamicalModelRigidBodySystem = <NodeType.RigidBodySystem: 501>¶
- DynamicalNode = <NodeType.DynamicalNode: 6>¶
- DynamicalParticle = <NodeType.DynamicalParticle: 601>¶
- DynamicalRoot = <NodeType.DynamicalRoot: 60000>¶
- Folder = <NodeType.Folder: 22>¶
- HydrogenBond = <NodeType.HydrogenBond: 20202>¶
- HydrogenBondGroup = <NodeType.HydrogenBondGroup: 20203>¶
- InteractionModel = <NodeType.InteractionModel: 7>¶
- InteractionModelArticulatedBodySystem = <NodeType.InteractionModelArticulatedBodySystem: 702>¶
- InteractionModelParticleSystem = <NodeType.InteractionModelParticleSystem: 700>¶
- InteractionModelRigidBodySystem = <NodeType.InteractionModelRigidBodySystem: 701>¶
- Label = <NodeType.Label: 24>¶
- Mesh = <NodeType.Mesh: 300>¶
- Molecule = <NodeType.Molecule: 208>¶
- NodeGroup = <NodeType.DataGraphNodeGroup: 30>¶
- Note = <NodeType.Note: 25>¶
- ParticleSystem = <NodeType.ParticleSystem: 500>¶
- Path = <NodeType.Path: 29>¶
- Presentation = <NodeType.Presentation: 27>¶
- PropertyModel = <NodeType.PropertyModel: 9>¶
- PropertyModelFunction = <NodeType.PropertyModelFunction: 900>¶
- Protein = <NodeType.Protein: 206>¶
- PseudoAtom = <NodeType.PseudoAtom: 20101>¶
- PseudoBond = <NodeType.PseudoBond: 20201>¶
- Residue = <NodeType.Residue: 204>¶
- RigidBody = <NodeType.RigidBody: 602>¶
- RigidBodySystem = <NodeType.RigidBodySystem: 501>¶
- Root = <NodeType.Root: 20000>¶
- Segment = <NodeType.Segment: 205>¶
- SideChain = <NodeType.SideChain: 210>¶
- Simulator = <NodeType.Simulator: 11>¶
- SimulatorArticulatedBodySystem = <NodeType.SimulatorArticulatedBodySystem: 1102>¶
- SimulatorParticleSystem = <NodeType.SimulatorParticleSystem: 1100>¶
- SimulatorRigidBodySystem = <NodeType.SimulatorRigidBodySystem: 1101>¶
- StateUpdater = <NodeType.StateUpdater: 15>¶
- StateUpdaterArticulatedBodySystem = <NodeType.StateUpdaterArticulatedBodySystem: 1503>¶
- StateUpdaterParticleSystem = <NodeType.StateUpdaterParticleSystem: 1501>¶
- StateUpdaterRigidBodySystem = <NodeType.StateUpdaterRigidBodySystem: 1502>¶
- StructuralGroup = <NodeType.StructuralGroup: 200>¶
- StructuralModel = <NodeType.StructuralModel: 1>¶
- StructuralModelConformation = <NodeType.Conformation: 28>¶
- StructuralModelNode = <NodeType.StructuralModelNode: 2>¶
- StructuralModelNodeAtom = <NodeType.Atom: 20100>¶
- StructuralModelNodeBackbone = <NodeType.Backbone: 209>¶
- StructuralModelNodeBond = <NodeType.Bond: 202>¶
- StructuralModelNodeChain = <NodeType.Chain: 207>¶
- StructuralModelNodeGroup = <NodeType.StructuralGroup: 200>¶
- StructuralModelNodeHydrogenBond = <NodeType.HydrogenBond: 20202>¶
- StructuralModelNodeHydrogenBondGroup = <NodeType.HydrogenBondGroup: 20203>¶
- StructuralModelNodeMolecule = <NodeType.Molecule: 208>¶
- StructuralModelNodeParticle = <NodeType.StructuralParticle: 201>¶
- StructuralModelNodeProtein = <NodeType.Protein: 206>¶
- StructuralModelNodePseudoAtom = <NodeType.PseudoAtom: 20101>¶
- StructuralModelNodePseudoBond = <NodeType.PseudoBond: 20201>¶
- StructuralModelNodeResidue = <NodeType.Residue: 204>¶
- StructuralModelNodeRoot = <NodeType.Root: 20000>¶
- StructuralModelNodeSegment = <NodeType.Segment: 205>¶
- StructuralModelNodeSideChain = <NodeType.SideChain: 210>¶
- StructuralModelPath = <NodeType.Path: 29>¶
- StructuralParticle = <NodeType.StructuralParticle: 201>¶
- Undefined = <NodeType.Undefined: 0>¶
- VisualModel = <NodeType.VisualModel: 3>¶
- VisualModelMesh = <NodeType.Mesh: 300>¶
- property name¶
- property value¶
- addChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node = None) bool ¶
Adds a child to the node
- addGroupNodesToSelection(self: samson.DataModel.Document.Document, group: samson.DataModel.DataGraph.Group) None ¶
Adds the group nodes to the document selection
- addNodeToSelection(self: samson.DataModel.Document.Document, node: samson.DataModel.DataGraph.Node) None ¶
Adds a node to the selection
- canAddChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node = None) bool ¶
Returns whether this node can add node as a child
- canAddChildType(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) bool ¶
Returns whether this node can add a node with type nodeType as a child
- canHaveDescendantType(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) bool ¶
Returns whether this node can have a node with type nodeType as a descendant
- castToInteractionModelParticleSystem(self: samson.DataModel.DataGraph.Node) SBMInteractionModelParticleSystem ¶
Casts (if possible) from SBDDataGraphNode to SBMInteractionModelParticleSystem
- castToLabel(self: samson.DataModel.DataGraph.Node) SBDDocumentLabel ¶
Casts (if possible) from SBDDataGraphNode to SBDDocumentLabel
- castToMesh(self: samson.DataModel.DataGraph.Node) SBMVisualModelMesh ¶
Casts (if possible) from SBDDataGraphNode to SBMVisualModelMesh
- castToVisualModel(self: samson.DataModel.DataGraph.Node) SBMVisualModel ¶
Casts (if possible) from SBDDataGraphNode to SBMVisualModel
- clearHighlighting(self: samson.DataModel.Document.Document) None ¶
Clears the highlighting
- clearSelection(self: samson.DataModel.Document.Document) None ¶
Clears the selection
- clone(self: samson.DataModel.DataGraph.Node) samson.DataModel.DataGraph.Node ¶
Returns a copy of the node and its descendants
- countNodes(*args, **kwargs)¶
Overloaded function.
countNodes(self: samson.DataModel.DataGraph.Node, selectionString: str = ‘*’, visitString: str = ‘*’, includeDependencies: bool = False) -> int
- Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
countNodes(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type, selectedNodesOnly: bool = False, visitString: str = ‘*’, includeDependencies: bool = False) -> int
- Count nodes into nodeIndexer, based on a nodeType, a selection status and a visitPredicate, with our without dependencies).
For visitString use Node Specification Language (SAMSON API: Node Specification Language
- create(self: samson.DataModel.DataGraph.Node) None ¶
Creates the node
- createGroup(self: samson.DataModel.Document.Document, name: str, selectionString: str = '*', visitString: str = '*') samson.DataModel.DataGraph.Group ¶
- Create a group with name based on a selectionString and a visitString).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
- descendsFrom(*args, **kwargs)¶
Overloaded function.
descendsFrom(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
descendsFrom(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
- erase(self: samson.DataModel.DataGraph.Node) None ¶
Erases the node
- getActiveCamera(self: samson.DataModel.Document.Document) SBDDocumentCamera ¶
Returns the active camera
- getActivePresentation(self: samson.DataModel.Document.Document) SBDDocumentPresentation ¶
Returns the active presentation
- getActiveStructuralModel(self: samson.DataModel.Document.Document) SBMStructuralModel ¶
Returns the active structural model
- getAnimationList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of animations
- getAssetList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of assets
- getCameraList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of cameras
- getChildren(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the children of the folder
- getConformationList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of conformations
- getControllerList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of controllers
- getDocument(self: samson.DataModel.DataGraph.Node) SBDDocument ¶
Returns the document the node belongs to
- getDynamicalModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of dynamical models
- getFlags(self: samson.DataModel.DataGraph.Node) int ¶
Returns the flags
- getFolderList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of folders
- getHierarchyString(self: samson.DataModel.DataGraph.Node, separator: str = ' / ', includeNodeType: bool = False) str ¶
Returns a string with hierarchical information on the node and its parents names
- getInheritedFlags(self: samson.DataModel.DataGraph.Node) int ¶
Returns the inherited flags
- getInteractionModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of interaction models
- getLabelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of labels
- getMaterial(self: samson.DataModel.DataGraph.Node) SBDDataGraphNodeMaterial ¶
Returns the material of the node
- getMaterialOwner(self: samson.DataModel.DataGraph.Node) samson.DataModel.DataGraph.Node ¶
Returns the node whose material is inherited
- getMemoryFootprint(self: samson.Core.Reference.ReferenceTarget) int ¶
Returns the memory footprint
- getModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of models
- getNextDocument(self: samson.DataModel.Document.Document) samson.DataModel.Document.Document ¶
Returns the next document
- getNextFolder(self: samson.DataModel.Document.Folder) samson.DataModel.Document.Folder ¶
Returns the next folder
- getNextNode(*args, **kwargs)¶
Overloaded function.
getNextNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node
Returns the pointer to the next node in the children of the node’s parent
getNextNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node
Returns the pointer to the next node with type nodeType in the children of the node’s parent
- getNode(self: int) samson.DataModel.DataGraph.Node ¶
Returns the unique node corresponding to the node index nodeIndex
- getNodeGroupList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of node groups
- getNodes(*args, **kwargs)¶
Overloaded function.
getNodes(self: samson.DataModel.DataGraph.Node, selectionString: str = ‘*’, visitString: str = ‘*’, includeDependencies: bool = False) -> SBDDataGraphNodeIndexer
- Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
getNodes(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type, selectedNodesOnly: bool = False, visitString: str = ‘*’, includeDependencies: bool = False) -> SBDDataGraphNodeIndexer
- Returns nodes (in a node indexer), based on a nodeType, a selection status and a visitString, with our without dependencies).
For visitString use Node Specification Language (SAMSON API: Node Specification Language
- getNoteList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of notes
- getParent(self: samson.DataModel.DataGraph.Node) samson.DataModel.DataGraph.Node ¶
Returns the parent of the node
- getPathList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of paths
- getPresentationList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of presentations
- getPreviousDocument(self: samson.DataModel.Document.Document) samson.DataModel.Document.Document ¶
Returns the previous document
- getPreviousFolder(self: samson.DataModel.Document.Folder) samson.DataModel.Document.Folder ¶
Returns the previous folder
- getPreviousNode(*args, **kwargs)¶
Overloaded function.
getPreviousNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node
Returns the pointer to the previous node in the children of the node’s parent
getPreviousNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node
Returns the pointer to the previous node with type nodeType in the children of the node’s parent
- getPropertyModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of property models
- getRoot(self: samson.DataModel.DataGraph.Node) samson.DataModel.DataGraph.Node ¶
Returns the root of the hierarchy the node belongs to
- getSelectedNodes(self: samson.DataModel.Document.Document) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the index of selected nodes
- getSimulatorList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of simulators
- getStructuralModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of structural models
- getThisNode(self: samson.DataModel.DataGraph.Node) samson.DataModel.DataGraph.Node ¶
Returns the pointer to this node
- static getTypeString(type: SBDDataGraphNode::Type) str ¶
Returns a string describing the type of the data graph node
- getVisualModelList(self: samson.DataModel.Document.Folder) samson.DataModel.DataGraph.NodeIndexer ¶
Returns the list of visual models
- groupSelection(self: samson.DataModel.Document.Document, name: str) samson.DataModel.DataGraph.Group ¶
Stores the selected nodes into a group with name
- hasOneOf(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) bool ¶
Returns true if and only if this node is one of the nodes of the nodeIndexer, or is the ancestor of one of them
- initialize(self: samson.DataModel.Document.Folder) bool ¶
Initializes the folder
- intersectGroupNodesWithSelection(self: samson.DataModel.Document.Document, group: samson.DataModel.DataGraph.Group) None ¶
Keeps in the document selection only the nodes stored in this group
- isDynamicalModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a dynamical model
- isIn(*args, **kwargs)¶
Overloaded function.
isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it, or belongs to a group stored in node
isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them, or belongs to a group stored in one of the nodes of the nodeIndexer
- isInteractionModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a interaction model
- isMesh(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a mesh
- isModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a model
- isOneOf(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) bool ¶
Returns true if and only if this node is one of the nodes of the nodeIndexer
- isPropertyModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a property model
- isSimulator(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a simulator
- isStructuralModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a structural model
- isStructuralParticle(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a structural particle (an atom or a pseudo-atom)
- isType(self: samson.DataModel.DataGraph.Node, type: SBDDataGraphNode::Type) bool ¶
Returns true when the type of the node corresponds to type
- isVisualModel(self: samson.DataModel.DataGraph.Node) bool ¶
Returns true when the node is a visual model
- printDebugInfo(self: samson.DataModel.DataGraph.Node, offset: int = 0) None ¶
Prints some debugging information in stdout
- removeChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) bool ¶
Removes a child from the node
- removeGroupNodesFromSelection(self: samson.DataModel.Document.Document, group: samson.DataModel.DataGraph.Group) None ¶
Removes the group nodes from the document selection
- removeMaterial(self: samson.DataModel.DataGraph.Node) bool ¶
Removes material from the node
- removeNodeFromSelection(self: samson.DataModel.Document.Document, node: samson.DataModel.DataGraph.Node) None ¶
Adds a node to the selection
- selectGroupNodes(self: samson.DataModel.Document.Document, group: samson.DataModel.DataGraph.Group) None ¶
Clears the document selection and select the group nodes
- setActiveCamera(self: samson.DataModel.Document.Document, arg0: SBDDocumentCamera) None ¶
Sets the active camera
- setActivePresentation(self: samson.DataModel.Document.Document, arg0: SBDDocumentPresentation) None ¶
Sets the active presentation
- setActiveStructuralModel(self: samson.DataModel.Document.Document, arg0: SBMStructuralModel) None ¶
Sets the active structural model
- setColor(self: samson.DataModel.DataGraph.Node, color: SBDTypeColor) bool ¶
Sets the color for the node (modifies an existing material of the node or adds a material with a given color)
- Args:
color (Color): color to set
- setColorScheme(self: samson.DataModel.DataGraph.Node, colorScheme: SBDDataGraphNodeColorScheme) bool ¶
Sets the color scheme for the node (modifies an existing material of the node or adds a material with a given color scheme)
Args: colorScheme (ColorScheme): color scheme to set
- setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) bool ¶
Sets the material for the node.
- Args:
material (Material): material to set
- toString(self: samson.DataModel.Document.Folder) str ¶
A string representation
- Animation = <NodeType.Animation: 26>¶
- ArticulatedBody = <NodeType.ArticulatedBody: 603>¶
- ArticulatedBodySystem = <NodeType.ArticulatedBodySystem: 502>¶
- Asset = <NodeType.Asset: 50>¶
- Atom = <NodeType.Atom: 20100>¶
- Backbone = <NodeType.Backbone: 209>¶
- Bond = <NodeType.Bond: 202>¶
- Camera = <NodeType.Camera: 23>¶
- Chain = <NodeType.Chain: 207>¶
- Conformation = <NodeType.Conformation: 28>¶
- Controller = <NodeType.Controller: 40>¶
- ControllerNode = <NodeType.ControllerNode: 41>¶
- DataGraphNodeGroup = <NodeType.DataGraphNodeGroup: 30>¶
- Document = <NodeType.Document: 21>¶
- DocumentManager = <NodeType.DocumentManager: 20>¶
- DynamicalGroup = <NodeType.DynamicalGroup: 600>¶
- DynamicalModel = <NodeType.DynamicalModel: 5>¶
- DynamicalModelArticulatedBodySystem = <NodeType.ArticulatedBodySystem: 502>¶
- DynamicalModelNode = <NodeType.DynamicalNode: 6>¶
- DynamicalModelNodeArticulatedBody = <NodeType.ArticulatedBody: 603>¶
- DynamicalModelNodeGroup = <NodeType.DynamicalGroup: 600>¶
- DynamicalModelNodeParticle = <NodeType.DynamicalParticle: 601>¶
- DynamicalModelNodeRigidBody = <NodeType.RigidBody: 602>¶
- DynamicalModelNodeRoot = <NodeType.DynamicalRoot: 60000>¶
- DynamicalModelParticleSystem = <NodeType.ParticleSystem: 500>¶
- DynamicalModelRigidBodySystem = <NodeType.RigidBodySystem: 501>¶
- DynamicalNode = <NodeType.DynamicalNode: 6>¶
- DynamicalParticle = <NodeType.DynamicalParticle: 601>¶
- DynamicalRoot = <NodeType.DynamicalRoot: 60000>¶
- Folder = <NodeType.Folder: 22>¶
- HydrogenBond = <NodeType.HydrogenBond: 20202>¶
- HydrogenBondGroup = <NodeType.HydrogenBondGroup: 20203>¶
- InteractionModel = <NodeType.InteractionModel: 7>¶
- InteractionModelArticulatedBodySystem = <NodeType.InteractionModelArticulatedBodySystem: 702>¶
- InteractionModelParticleSystem = <NodeType.InteractionModelParticleSystem: 700>¶
- InteractionModelRigidBodySystem = <NodeType.InteractionModelRigidBodySystem: 701>¶
- Label = <NodeType.Label: 24>¶
- Mesh = <NodeType.Mesh: 300>¶
- Molecule = <NodeType.Molecule: 208>¶
- NodeGroup = <NodeType.DataGraphNodeGroup: 30>¶
- Note = <NodeType.Note: 25>¶
- ParticleSystem = <NodeType.ParticleSystem: 500>¶
- Path = <NodeType.Path: 29>¶
- Presentation = <NodeType.Presentation: 27>¶
- PropertyModel = <NodeType.PropertyModel: 9>¶
- PropertyModelFunction = <NodeType.PropertyModelFunction: 900>¶
- Protein = <NodeType.Protein: 206>¶
- PseudoAtom = <NodeType.PseudoAtom: 20101>¶
- PseudoBond = <NodeType.PseudoBond: 20201>¶
- Residue = <NodeType.Residue: 204>¶
- RigidBody = <NodeType.RigidBody: 602>¶
- RigidBodySystem = <NodeType.RigidBodySystem: 501>¶
- Root = <NodeType.Root: 20000>¶
- Segment = <NodeType.Segment: 205>¶
- SideChain = <NodeType.SideChain: 210>¶
- Simulator = <NodeType.Simulator: 11>¶
- SimulatorArticulatedBodySystem = <NodeType.SimulatorArticulatedBodySystem: 1102>¶
- SimulatorParticleSystem = <NodeType.SimulatorParticleSystem: 1100>¶
- SimulatorRigidBodySystem = <NodeType.SimulatorRigidBodySystem: 1101>¶
- StateUpdater = <NodeType.StateUpdater: 15>¶
- StateUpdaterArticulatedBodySystem = <NodeType.StateUpdaterArticulatedBodySystem: 1503>¶
- StateUpdaterParticleSystem = <NodeType.StateUpdaterParticleSystem: 1501>¶
- StateUpdaterRigidBodySystem = <NodeType.StateUpdaterRigidBodySystem: 1502>¶
- StructuralGroup = <NodeType.StructuralGroup: 200>¶
- StructuralModel = <NodeType.StructuralModel: 1>¶
- StructuralModelConformation = <NodeType.Conformation: 28>¶
- StructuralModelNode = <NodeType.StructuralModelNode: 2>¶
- StructuralModelNodeAtom = <NodeType.Atom: 20100>¶
- StructuralModelNodeBackbone = <NodeType.Backbone: 209>¶
- StructuralModelNodeBond = <NodeType.Bond: 202>¶
- StructuralModelNodeChain = <NodeType.Chain: 207>¶
- StructuralModelNodeGroup = <NodeType.StructuralGroup: 200>¶
- StructuralModelNodeHydrogenBond = <NodeType.HydrogenBond: 20202>¶
- StructuralModelNodeHydrogenBondGroup = <NodeType.HydrogenBondGroup: 20203>¶
- StructuralModelNodeMolecule = <NodeType.Molecule: 208>¶
- StructuralModelNodeParticle = <NodeType.StructuralParticle: 201>¶
- StructuralModelNodeProtein = <NodeType.Protein: 206>¶
- StructuralModelNodePseudoAtom = <NodeType.PseudoAtom: 20101>¶
- StructuralModelNodePseudoBond = <NodeType.PseudoBond: 20201>¶
- StructuralModelNodeResidue = <NodeType.Residue: 204>¶
- StructuralModelNodeRoot = <NodeType.Root: 20000>¶
- StructuralModelNodeSegment = <NodeType.Segment: 205>¶
- StructuralModelNodeSideChain = <NodeType.SideChain: 210>¶
- StructuralModelPath = <NodeType.Path: 29>¶
- StructuralParticle = <NodeType.StructuralParticle: 201>¶
- property UUID¶
The folder UUID
- Undefined = <NodeType.Undefined: 0>¶
- VisualModel = <NodeType.VisualModel: 3>¶
- VisualModelMesh = <NodeType.Mesh: 300>¶
- property defaultOpacity¶
Returns the default opacity
- property defaultTransparency¶
Returns the default transparency
- property fileName¶
name of the file associated to the document
- property hasMaterial¶
Returns whether the node has a material (by itself, or inherited)
- property hasOpacityRange¶
Returns whether the node has opacity range
- property hasTransparencyRange¶
Returns whether the node has transparency range
- property highlightingFlag¶
Highlighting flag
- property isCreated¶
Returns true if and only if the node is created
- property isErased¶
Returns true if and only if the node is erased
- property isHighlighted¶
Returns whether the node is highlighted
- property isLocked¶
Returns whether the node is locked
- property isSelected¶
Returns whether the node is selected
- property isSerializable¶
Returns true when the class is serializable
- property isVisible¶
Returns whether the node is visible
- property lockedFlag¶
Locked flag
- property maximumOpacity¶
Returns the maximum opacity
- property maximumTransparency¶
Returns the maximum transparency
- property minimumOpacity¶
Returns the minimum opacity
- property minimumTransparency¶
Returns the minimum transparency
- property molecularWeight¶
Returns the molecular weight
- property name¶
The name of the node
- property nodeIndex¶
Returns the node index (unique in the whole data graph, but non-persistent)
- property numberOfAtoms¶
Returns the number of atoms
- property numberOfCarbons¶
Returns the number of carbons
- property numberOfChains¶
Returns the number of chains
- property numberOfHydrogens¶
Returns the number of hydrogens
- property numberOfMolecules¶
Returns the number of molecules
- property numberOfNitrogens¶
Returns the number of nitrogens
- property numberOfOtherAtoms¶
Returns the number of other atoms
- property numberOfOxygens¶
Returns the number of oxygens
- property numberOfResidues¶
Returns the number of residues
- property numberOfSegments¶
Returns the number of segments
- property numberOfStructuralGroups¶
Returns the number of structural groups
- property numberOfStructuralModels¶
Returns the number of structural models
- property numberOfSulfurs¶
Returns the number of sulfurs
- property opacity¶
Opacity
- property ownsMaterial¶
Returns whether the node owns a material
- property selectionFlag¶
Selection flag
- property sumOfFormalCharges¶
Returns the sum of formal charges
- property sumOfPartialCharges¶
Returns the sum of partial charges
- property transparency¶
Transparency
- property type¶
Returns the type of the data graph node
- property typeString¶
Returns a string describing the type of this data graph node
- property visibilityFlag¶
Visibility flag