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, arg0: int) → NoneΒΆ Bases:
pybind11_builtins.pybind11_object
Members:
Undefined
StructuralModel
StructuralModelNode
StructuralModelConformation
Conformation
StructuralModelPath
Path
StructuralModelNodeGroup
StructuralGroup
StructuralModelNodeRoot
Root
StructuralModelNodeParticle
StructuralParticle
StructuralModelNodeAtom
Atom
StructuralModelNodePseudoAtom
PseudoAtom
StructuralModelNodeBond
Bond
StructuralModelNodeResidue
Residue
StructuralModelNodeSegment
Segment
StructuralModelNodeProtein
Protein
StructuralModelNodeChain
Chain
StructuralModelNodeMolecule
Molecule
StructuralModelNodeBackbone
Backbone
StructuralModelNodeSideChain
SideChain
VisualModel
VisualModelMesh
Mesh
DynamicalModel
DynamicalModelParticleSystem
ParticleSystem
DynamicalModelRigidBodySystem
RigidBodySystem
DynamicalModelArticulatedBodySystem
ArticulatedBodySystem
DynamicalModelNode
DynamicalNode
DynamicalModelNodeGroup
DynamicalGroup
DynamicalModelNodeRoot
DynamicalRoot
DynamicalModelNodeParticle
DynamicalParticle
DynamicalModelNodeRigidBody
RigidBody
DynamicalModelNodeArticulatedBody
ArticulatedBody
InteractionModel
InteractionModelParticleSystem
InteractionModelRigidBodySystem
InteractionModelArticulatedBodySystem
PropertyModel
PropertyModelFunction
Simulator
SimulatorParticleSystem
SimulatorRigidBodySystem
SimulatorArticulatedBodySystem
StateUpdater
StateUpdaterParticleSystem
StateUpdaterRigidBodySystem
StateUpdaterArticulatedBodySystem
DocumentManager
Document
Folder
Camera
Label
DataGraphNodeGroup
NodeGroup
Controller
ControllerNode
Asset
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBodyΒΆ
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystemΒΆ
-
Asset
= NodeType.AssetΒΆ
-
Atom
= NodeType.StructuralModelNodeAtomΒΆ
-
Backbone
= NodeType.StructuralModelNodeBackboneΒΆ
-
Bond
= NodeType.StructuralModelNodeBondΒΆ
-
Camera
= NodeType.CameraΒΆ
-
Chain
= NodeType.StructuralModelNodeChainΒΆ
-
Conformation
= NodeType.StructuralModelConformationΒΆ
-
Controller
= NodeType.ControllerΒΆ
-
ControllerNode
= NodeType.ControllerNodeΒΆ
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroupΒΆ
-
Document
= NodeType.DocumentΒΆ
-
DocumentManager
= NodeType.DocumentManagerΒΆ
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroupΒΆ
-
DynamicalModel
= NodeType.DynamicalModelΒΆ
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystemΒΆ
-
DynamicalModelNode
= NodeType.DynamicalModelNodeΒΆ
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBodyΒΆ
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroupΒΆ
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticleΒΆ
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBodyΒΆ
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRootΒΆ
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystemΒΆ
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystemΒΆ
-
DynamicalNode
= NodeType.DynamicalModelNodeΒΆ
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticleΒΆ
-
DynamicalRoot
= NodeType.DynamicalModelNodeRootΒΆ
-
Folder
= NodeType.FolderΒΆ
-
InteractionModel
= NodeType.InteractionModelΒΆ
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystemΒΆ
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystemΒΆ
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystemΒΆ
-
Label
= NodeType.LabelΒΆ
-
Mesh
= NodeType.VisualModelMeshΒΆ
-
Molecule
= NodeType.StructuralModelNodeMoleculeΒΆ
-
NodeGroup
= NodeType.DataGraphNodeGroupΒΆ
-
ParticleSystem
= NodeType.DynamicalModelParticleSystemΒΆ
-
Path
= NodeType.StructuralModelPathΒΆ
-
PropertyModel
= NodeType.PropertyModelΒΆ
-
PropertyModelFunction
= NodeType.PropertyModelFunctionΒΆ
-
Protein
= NodeType.StructuralModelNodeProteinΒΆ
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtomΒΆ
-
Residue
= NodeType.StructuralModelNodeResidueΒΆ
-
RigidBody
= NodeType.DynamicalModelNodeRigidBodyΒΆ
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystemΒΆ
-
Root
= NodeType.StructuralModelNodeRootΒΆ
-
Segment
= NodeType.StructuralModelNodeSegmentΒΆ
-
SideChain
= NodeType.StructuralModelNodeSideChainΒΆ
-
Simulator
= NodeType.SimulatorΒΆ
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystemΒΆ
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystemΒΆ
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystemΒΆ
-
StateUpdater
= NodeType.StateUpdaterΒΆ
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystemΒΆ
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystemΒΆ
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystemΒΆ
-
StructuralGroup
= NodeType.StructuralModelNodeGroupΒΆ
-
StructuralModel
= NodeType.StructuralModelΒΆ
-
StructuralModelConformation
= NodeType.StructuralModelConformationΒΆ
-
StructuralModelNode
= NodeType.StructuralModelNodeΒΆ
-
StructuralModelNodeAtom
= NodeType.StructuralModelNodeAtomΒΆ
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackboneΒΆ
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBondΒΆ
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChainΒΆ
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroupΒΆ
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMoleculeΒΆ
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticleΒΆ
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProteinΒΆ
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtomΒΆ
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidueΒΆ
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRootΒΆ
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegmentΒΆ
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChainΒΆ
-
StructuralModelPath
= NodeType.StructuralModelPathΒΆ
-
StructuralParticle
= NodeType.StructuralModelNodeParticleΒΆ
-
Undefined
= NodeType.UndefinedΒΆ
-
VisualModel
= NodeType.VisualModelΒΆ
-
VisualModelMesh
= NodeType.VisualModelMeshΒΆ
-
name
ΒΆ (self β handle) -> str
-
-
addChild
(self: samson.DataModel.Document.Folder, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node = None) → boolΒΆ Adds a child to the Folder
-
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.Document.Folder, 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.Document.Folder, nodeType: samson.DataModel.DataGraph.Node.NodeType) → boolΒΆ Returns whether this node can add a node with type nodeType as a child
-
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
-
clearSelection
(self: samson.DataModel.Document.Document) → NoneΒΆ Clears the selection
-
clone
(self: samson.DataModel.Document.Document) → samson.DataModel.Document.DocumentΒΆ Returns a copy of the node and its descendants
-
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: pagenodespecificationlanguage
-
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: pagenodespecificationlanguage
-
erase
(self: samson.DataModel.DataGraph.Node) → NoneΒΆ Erases the node
-
getActiveCamera
(self: samson.DataModel.Document.Document) → SBDDocumentCameraΒΆ Returns the active camera
-
getActiveStructuralModel
(self: samson.DataModel.Document.Document) → SBMStructuralModelΒΆ Returns the active structural model
-
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
-
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
(self: samson.DataModel.Document.Folder, selectionString: str = '*', visitString: str = '*', includeDependencies: bool = False) → samson.DataModel.DataGraph.NodeIndexerΒΆ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use the Node Specification Language (SAMSON API: pagenodespecificationlanguage
-
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
-
getPreviousDocument
(self: samson.DataModel.Document.Document) → samson.DataModel.Document.DocumentΒΆ Returns the previous document
-
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
-
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
- 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
-
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.Document.Folder, offset: int = 0) → NoneΒΆ Prints some debugging information in stdout
-
removeChild
(self: samson.DataModel.Document.Folder, node: samson.DataModel.DataGraph.Node) → boolΒΆ Removes a child from the Folder
-
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
-
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
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBodyΒΆ
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystemΒΆ
-
Asset
= NodeType.AssetΒΆ
-
Atom
= NodeType.StructuralModelNodeAtomΒΆ
-
Backbone
= NodeType.StructuralModelNodeBackboneΒΆ
-
Bond
= NodeType.StructuralModelNodeBondΒΆ
-
Camera
= NodeType.CameraΒΆ
-
Chain
= NodeType.StructuralModelNodeChainΒΆ
-
Conformation
= NodeType.StructuralModelConformationΒΆ
-
Controller
= NodeType.ControllerΒΆ
-
ControllerNode
= NodeType.ControllerNodeΒΆ
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroupΒΆ
-
Document
= NodeType.DocumentΒΆ
-
DocumentManager
= NodeType.DocumentManagerΒΆ
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroupΒΆ
-
DynamicalModel
= NodeType.DynamicalModelΒΆ
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystemΒΆ
-
DynamicalModelNode
= NodeType.DynamicalModelNodeΒΆ
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBodyΒΆ
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroupΒΆ
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticleΒΆ
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBodyΒΆ
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRootΒΆ
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystemΒΆ
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystemΒΆ
-
DynamicalNode
= NodeType.DynamicalModelNodeΒΆ
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticleΒΆ
-
DynamicalRoot
= NodeType.DynamicalModelNodeRootΒΆ
-
Folder
= NodeType.FolderΒΆ
-
InteractionModel
= NodeType.InteractionModelΒΆ
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystemΒΆ
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystemΒΆ
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystemΒΆ
-
Label
= NodeType.LabelΒΆ
-
Mesh
= NodeType.VisualModelMeshΒΆ
-
Molecule
= NodeType.StructuralModelNodeMoleculeΒΆ
-
NodeGroup
= NodeType.DataGraphNodeGroupΒΆ
-
ParticleSystem
= NodeType.DynamicalModelParticleSystemΒΆ
-
Path
= NodeType.StructuralModelPathΒΆ
-
PropertyModel
= NodeType.PropertyModelΒΆ
-
PropertyModelFunction
= NodeType.PropertyModelFunctionΒΆ
-
Protein
= NodeType.StructuralModelNodeProteinΒΆ
-
PseudoAtom
= NodeType.StructuralModelNodePseudoAtomΒΆ
-
Residue
= NodeType.StructuralModelNodeResidueΒΆ
-
RigidBody
= NodeType.DynamicalModelNodeRigidBodyΒΆ
-
RigidBodySystem
= NodeType.DynamicalModelRigidBodySystemΒΆ
-
Root
= NodeType.StructuralModelNodeRootΒΆ
-
Segment
= NodeType.StructuralModelNodeSegmentΒΆ
-
SideChain
= NodeType.StructuralModelNodeSideChainΒΆ
-
Simulator
= NodeType.SimulatorΒΆ
-
SimulatorArticulatedBodySystem
= NodeType.SimulatorArticulatedBodySystemΒΆ
-
SimulatorParticleSystem
= NodeType.SimulatorParticleSystemΒΆ
-
SimulatorRigidBodySystem
= NodeType.SimulatorRigidBodySystemΒΆ
-
StateUpdater
= NodeType.StateUpdaterΒΆ
-
StateUpdaterArticulatedBodySystem
= NodeType.StateUpdaterArticulatedBodySystemΒΆ
-
StateUpdaterParticleSystem
= NodeType.StateUpdaterParticleSystemΒΆ
-
StateUpdaterRigidBodySystem
= NodeType.StateUpdaterRigidBodySystemΒΆ
-
StructuralGroup
= NodeType.StructuralModelNodeGroupΒΆ
-
StructuralModel
= NodeType.StructuralModelΒΆ
-
StructuralModelConformation
= NodeType.StructuralModelConformationΒΆ
-
StructuralModelNode
= NodeType.StructuralModelNodeΒΆ
-
StructuralModelNodeAtom
= NodeType.StructuralModelNodeAtomΒΆ
-
StructuralModelNodeBackbone
= NodeType.StructuralModelNodeBackboneΒΆ
-
StructuralModelNodeBond
= NodeType.StructuralModelNodeBondΒΆ
-
StructuralModelNodeChain
= NodeType.StructuralModelNodeChainΒΆ
-
StructuralModelNodeGroup
= NodeType.StructuralModelNodeGroupΒΆ
-
StructuralModelNodeMolecule
= NodeType.StructuralModelNodeMoleculeΒΆ
-
StructuralModelNodeParticle
= NodeType.StructuralModelNodeParticleΒΆ
-
StructuralModelNodeProtein
= NodeType.StructuralModelNodeProteinΒΆ
-
StructuralModelNodePseudoAtom
= NodeType.StructuralModelNodePseudoAtomΒΆ
-
StructuralModelNodeResidue
= NodeType.StructuralModelNodeResidueΒΆ
-
StructuralModelNodeRoot
= NodeType.StructuralModelNodeRootΒΆ
-
StructuralModelNodeSegment
= NodeType.StructuralModelNodeSegmentΒΆ
-
StructuralModelNodeSideChain
= NodeType.StructuralModelNodeSideChainΒΆ
-
StructuralModelPath
= NodeType.StructuralModelPathΒΆ
-
StructuralParticle
= NodeType.StructuralModelNodeParticleΒΆ
-
UUID
ΒΆ The folder UUID
-
Undefined
= NodeType.UndefinedΒΆ
-
VisualModel
= NodeType.VisualModelΒΆ
-
VisualModelMesh
= NodeType.VisualModelMeshΒΆ
-
fileName
ΒΆ name of the file associated to the document
-
highlightingFlag
ΒΆ
-
isCreated
ΒΆ Returns true if and only if the node is created
-
isErased
ΒΆ Returns true if and only if the node is erased
-
isHighlighted
ΒΆ Returns whether the node is highlighted
-
isSelected
ΒΆ Returns whether the node is selected
-
isSerializable
ΒΆ Returns true when the class is serializable
-
isVisible
ΒΆ Returns whether the node is visible
-
name
ΒΆ The folder name
-
nodeIndex
ΒΆ Returns the node index (unique in the whole data graph, but non-persistent)
-
selectionFlag
ΒΆ
-
type
ΒΆ Returns the type of the data graph node
-
typeString
ΒΆ Returns a string describing the type of this data graph node
-
visibilityFlag
ΒΆ