DynamicalModel

This library defines dynamical models.

SAMSON API: The SBMDynamicalModel Library

class samson.Modeling.DynamicalModel.ArticulatedBody

Bases: samson.Modeling.DynamicalModel.Node

This class describes an articulated body in an articulated-body system.

SAMSON API: SBMDynamicalModelNodeArticulatedBody

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=0) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Node) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

Returns children of the node

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Node) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.ArticulatedBody, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.ArticulatedBodySystem

Bases: samson.Modeling.DynamicalModel.DynamicalModel

This class describes an articulated-body dynamical model.

SAMSON API: SBMDynamicalModelArticulatedBodySystem

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<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

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.DynamicalModel) → samson.Modeling.DynamicalModel.DynamicalModel

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

enforcePeriodicBoundaryConditions(self: samson.Modeling.DynamicalModel.DynamicalModel) → bool

Enforces the periodic boundary conditions

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

flushPositionBuffer(self: samson.Modeling.DynamicalModel.DynamicalModel) → None

Flushes the position buffer

getChangedPositionIndex(self: samson.Modeling.DynamicalModel.DynamicalModel, i: int) → int

Returns the index of a changed position

getDynamicalRoot(self: samson.Modeling.DynamicalModel.DynamicalModel) → SBMDynamicalModelNodeRoot

Returns the root of the dynamical model

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

getLayer(self: samson.Modeling.Model.SBMModel) → samson.DataModel.Document.Layer

Returns the owning document layer

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the next model in the document layer

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.DynamicalModel, 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 Node Specification Language (SAMSON API: Node Specification Language

getNumberOfChangedPositions(self: samson.Modeling.DynamicalModel.DynamicalModel) → int

Returns the number of changed positions

getParent(self: samson.Modeling.Model.SBMModel) → samson.DataModel.DataGraph.Node

Returns the parent node

getPositionChanged(self: samson.Modeling.DynamicalModel.DynamicalModel, i: int) → bool

Returns whether position i has been changed since the last flush

getPreviousModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the previous model in the document layer

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.ArticulatedBodySystem, offset: int=0) → None

Prints some debugging information

updateStructuralNodes(self: samson.Modeling.DynamicalModel.DynamicalModel) → None

Updates structural nodes based on the state of the dynamical model

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

dynamicalModelType

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

modelType

name

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

periodicBoundaryConditionsFlag

periodic boundary conditions flag

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.DynamicalModel

Bases: samson.Modeling.Model.SBMModel

This class is the base class of dynamical models.

SAMSON API: SBMDynamicalModel

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<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

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.DynamicalModel) → samson.Modeling.DynamicalModel.DynamicalModel

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

enforcePeriodicBoundaryConditions(self: samson.Modeling.DynamicalModel.DynamicalModel) → bool

Enforces the periodic boundary conditions

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

flushPositionBuffer(self: samson.Modeling.DynamicalModel.DynamicalModel) → None

Flushes the position buffer

getChangedPositionIndex(self: samson.Modeling.DynamicalModel.DynamicalModel, i: int) → int

Returns the index of a changed position

getDynamicalRoot(self: samson.Modeling.DynamicalModel.DynamicalModel) → SBMDynamicalModelNodeRoot

Returns the root of the dynamical model

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

getLayer(self: samson.Modeling.Model.SBMModel) → samson.DataModel.Document.Layer

Returns the owning document layer

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the next model in the document layer

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.DynamicalModel, 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 Node Specification Language (SAMSON API: Node Specification Language

getNumberOfChangedPositions(self: samson.Modeling.DynamicalModel.DynamicalModel) → int

Returns the number of changed positions

getParent(self: samson.Modeling.Model.SBMModel) → samson.DataModel.DataGraph.Node

Returns the parent node

getPositionChanged(self: samson.Modeling.DynamicalModel.DynamicalModel, i: int) → bool

Returns whether position i has been changed since the last flush

getPreviousModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the previous model in the document layer

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.DynamicalModel, offset: int=0) → None

Prints some debugging information

updateStructuralNodes(self: samson.Modeling.DynamicalModel.DynamicalModel) → None

Updates structural nodes based on the state of the dynamical model

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

dynamicalModelType

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

modelType

name

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

periodicBoundaryConditionsFlag

periodic boundary conditions flag

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.Group(*args, **kwargs)

Bases: samson.Modeling.DynamicalModel.Node

This class describes a group of dynamical model nodes.

SAMSON API: SBMDynamicalModelNodeGroup

Overloaded function.

1. __init__(self: samson.Modeling.DynamicalModel.Group) -> None

Constructs a group of dynamical model nodes

2. __init__(self: samson.Modeling.DynamicalModel.Group, arg0: str) -> None

Constructs a group of dynamical model nodes

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Group, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=None) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Group) → samson.Modeling.DynamicalModel.Group

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Group) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Node) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Group, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.Group, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

name of the model

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.Node

Bases: samson.Modeling.Model.SBMModelNode

This class describes a dynamical model node.

SAMSON API: SBMDynamicalModelNode

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=0) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Node) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

Returns children of the node

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Node) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.Node, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.Particle

Bases: samson.Modeling.DynamicalModel.Node

This class describes a dynamical particle in a dynamical particle system.

SAMSON API: SBMDynamicalModelNodeParticle

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=0) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Node) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

Returns children of the node

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Node) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.Particle, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.ParticleSystem(*args, **kwargs)

Bases: samson.Modeling.DynamicalModel.DynamicalModel

This class describes a dynamical particle system.

SAMSON API: SBMDynamicalModelParticleSystem

Overloaded function.

1. __init__(self: samson.Modeling.DynamicalModel.ParticleSystem) -> None

Constructs a dynamical particle system

2. __init__(self: samson.Modeling.DynamicalModel.ParticleSystem, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) -> None

Constructs a dynamical particle system based in nodeIndexer

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<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

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

addParticle(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle) → int

Adds a particle to the particle system

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.DynamicalModel) → samson.Modeling.DynamicalModel.DynamicalModel

Returns a copy of the node and its descendants

correctDistanceWithPBC(self: samson.Modeling.DynamicalModel.ParticleSystem, distance: samson.DataModel.Type.vector3) → None

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

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

enforcePeriodicBoundaryConditions(self: samson.Modeling.DynamicalModel.ParticleSystem) → bool

Enforces the periodic boundary conditions

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

flushMomentumBuffer(self: samson.Modeling.DynamicalModel.ParticleSystem) → None

Flushes the momentum buffer

flushPositionBuffer(self: samson.Modeling.DynamicalModel.ParticleSystem) → None

Flushes the position buffer

getActivityFlag(*args, **kwargs)

Overloaded function.

1. getActivityFlag(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle) -> bool

returns activity flag of a particle

2. getActivityFlag(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int) -> bool

returns activity flag of a particle

getChangedMomentumIndex(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) → int

Returns the index of a changed momentum

getChangedPositionIndex(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) → int

Returns the index of a changed position

getDynamicalRoot(self: samson.Modeling.DynamicalModel.DynamicalModel) → SBMDynamicalModelNodeRoot

Returns the root of the dynamical model

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

getInverseMass(*args, **kwargs)

Overloaded function.

1. getInverseMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle) -> samson.DataModel.Quantity.unitsSI

returns inverse mass of a particle

2. getInverseMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int) -> samson.DataModel.Quantity.unitsSI

returns inverse mass of a particle

getLayer(self: samson.Modeling.Model.SBMModel) → samson.DataModel.Document.Layer

Returns the owning document layer

getMass(*args, **kwargs)

Overloaded function.

1. getMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle) -> samson.DataModel.Quantity.unitsSI

returns mass of a particle

2. getMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int) -> samson.DataModel.Quantity.unitsSI

returns mass of a particle

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.SBCReferenceTarget) → int

Returns the memory footprint

getMomentum(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) → samson.DataModel.Type.vector3

Returns the momentum of a particle

getNextModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the next model in the document layer

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.DynamicalModel, 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 Node Specification Language (SAMSON API: Node Specification Language

getNumberOfChangedPositions(self: samson.Modeling.DynamicalModel.DynamicalModel) → int

Returns the number of changed positions

getParent(self: samson.Modeling.Model.SBMModel) → samson.DataModel.DataGraph.Node

Returns the parent node

getPosition(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) → samson.DataModel.Type.vector3

Returns the position of a particle

getPositionChanged(*args, **kwargs)

Overloaded function.

1. getPositionChanged(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) -> bool

Returns whether position i has been changed since the last flush

2. getPositionChanged(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int) -> bool

Returns whether momentum i has been changed since the last flush

getPreviousModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the previous model in the document layer

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

getStructuralParticleIndexer(self: samson.Modeling.DynamicalModel.ParticleSystem) → SBCReferencePointerIndexer<SBMStructuralModelNodeParticle, SBCReferenceToTarget>

Returns the particle index of the particle system

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

removeParticle(*args, **kwargs)

Overloaded function.

1. removeParticle(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle) -> None

Removes a particle from the particle system

2. removeParticle(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int) -> None

Removes a particle from the particle system

roundForPBC(self: samson.Modeling.DynamicalModel.ParticleSystem, position: samson.DataModel.Quantity.unitsSI) → int

setActivityFlag(*args, **kwargs)

Overloaded function.

1. setActivityFlag(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle, flag: bool) -> None

sets activity flag of a particle

2. setActivityFlag(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int, flag: bool) -> None

sets activity flag of a particle

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMass(*args, **kwargs)

Overloaded function.

1. setMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particle: samson.Modeling.StructuralModel.NodeParticle, flag: samson.DataModel.Quantity.unitsSI) -> None

sets mass of a particle

2. setMass(self: samson.Modeling.DynamicalModel.ParticleSystem, particleIndex: int, flag: samson.DataModel.Quantity.unitsSI) -> None

sets mass of a particle

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMomentum(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int, newMomentum: samson.DataModel.Type.vector3) → None

Updates the momentum of a particle

setPosition(self: samson.Modeling.DynamicalModel.ParticleSystem, i: int, newPosition: samson.DataModel.Type.vector3) → None

Updates the position of a particle

sprint(self: samson.Modeling.DynamicalModel.ParticleSystem, offset: int=0) → None

Prints some debugging information

updateStructuralNodes(self: samson.Modeling.DynamicalModel.ParticleSystem) → None

Updates the structural nodes based on the state of the particle system

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

dynamicalModelType

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

modelType

name

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

numberOfChangedMomentums

Returns the number of changed momentum

numberOfChangedPositions

Returns the number of changed positions

periodicBoundaryConditionsFlag

periodic boundary conditions flag

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.RigidBody

Bases: samson.Modeling.DynamicalModel.Node

This class describes a rigid body in a rigid-body system.

SAMSON API: SBMDynamicalModelNodeRigidBody

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=0) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Node) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

Returns children of the node

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Node) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Node, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.RigidBody, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.RigidBodySystem(self: samson.Modeling.DynamicalModel.RigidBodySystem) → None

Bases: samson.Modeling.DynamicalModel.DynamicalModel

This class describes a dynamical rigid-body system.

SAMSON API: SBMDynamicalModelRigidBodySystem

Constructs a dynamical rigid-body system

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<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

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.DynamicalModel) → samson.Modeling.DynamicalModel.DynamicalModel

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

enforcePeriodicBoundaryConditions(self: samson.Modeling.DynamicalModel.DynamicalModel) → bool

Enforces the periodic boundary conditions

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

flushPositionBuffer(self: samson.Modeling.DynamicalModel.RigidBodySystem) → None

Flushes the position buffer

getChangedPositionIndex(self: samson.Modeling.DynamicalModel.RigidBodySystem, i: int) → int

Returns the index of a changed position

getDynamicalRoot(self: samson.Modeling.DynamicalModel.DynamicalModel) → SBMDynamicalModelNodeRoot

Returns the root of the dynamical model

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

getLayer(self: samson.Modeling.Model.SBMModel) → samson.DataModel.Document.Layer

Returns the owning document layer

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the next model in the document layer

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.DynamicalModel, 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 Node Specification Language (SAMSON API: Node Specification Language

getNumberOfChangedPositions(self: samson.Modeling.DynamicalModel.DynamicalModel) → int

Returns the number of changed positions

getParent(self: samson.Modeling.Model.SBMModel) → samson.DataModel.DataGraph.Node

Returns the parent node

getPositionChanged(self: samson.Modeling.DynamicalModel.RigidBodySystem, i: int) → bool

Returns whether position i has been changed since the last flush

getPreviousModel(self: samson.Modeling.Model.SBMModel) → samson.Modeling.Model.SBMModel

Returns the previous model in the document layer

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.RigidBodySystem, offset: int=0) → None

Prints some debugging information

updateStructuralNodes(self: samson.Modeling.DynamicalModel.RigidBodySystem) → None

Updates the structural nodes based on the state of the rigid-body system

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

dynamicalModelType

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

modelType

name

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

numberOfChangedPositions

Returns the number of changed positions

periodicBoundaryConditionsFlag

periodic boundary conditions flag

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag

class samson.Modeling.DynamicalModel.Root(self: samson.Modeling.DynamicalModel.Root, arg0: str) → None

Bases: samson.Modeling.DynamicalModel.Group

This class describes the root node of a dynamical model.

SAMSON API: SBMDynamicalModelNodeRoot

Constructs a root node of a dynamical model

class NodeType(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None

Bases: pybind11_builtins.pybind11_object

__eq__(*args, **kwargs)

Overloaded function.

1. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __eq__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

__ne__(*args, **kwargs)

Overloaded function.

1. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: samson.DataModel.DataGraph.Node.NodeType) -> bool
2. __ne__(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) -> bool

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

addChild(self: samson.Modeling.DynamicalModel.Group, node: samson.Modeling.DynamicalModel.Node, nextNode: samson.Modeling.DynamicalModel.Node=None) → bool

Adds a child to the node

addMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial) → bool

Adds material to the node

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

castToVisualModel(self: samson.DataModel.DataGraph.Node) → SBMVisualModel

Casts (if possible) from SBDDataGraphNode to SBMVisualModel

clone(self: samson.Modeling.DynamicalModel.Root) → samson.Modeling.DynamicalModel.Root

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: Node Specification Language

create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

erase(self: samson.DataModel.DataGraph.Node) → None

Erases the node

getChildren(self: samson.Modeling.DynamicalModel.Group) → SBCReferencePointerList<SBMDynamicalModelNode, SBCReferenceToTarget>

getFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the flags

getInheritedFlags(self: samson.DataModel.DataGraph.Node) → int

Returns the inherited flags

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.SBCReferenceTarget) → int

Returns the memory footprint

getNextDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getNode(self: int) → samson.DataModel.DataGraph.Node

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.Modeling.DynamicalModel.Node, 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 Node Specification Language (SAMSON API: Node Specification Language

getParent(self: samson.Modeling.DynamicalModel.Root) → samson.DataModel.DataGraph.Node

getPreviousDynamicalNode(self: samson.Modeling.DynamicalModel.Node) → samson.Modeling.DynamicalModel.Node

getRoot(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node

Returns the root of the hierarchy the node belongs to

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

isIn(*args, **kwargs)

Overloaded function.

1. 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

2. 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

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

removeChild(self: samson.Modeling.DynamicalModel.Group, node: samson.Modeling.DynamicalModel.Node) → bool

Removes a child from the node

removeMaterial(self: samson.DataModel.DataGraph.Node) → bool

Removes material from the node

setColor(self: samson.DataModel.DataGraph.Node, color: SBDColor, applyToChildren: bool=False) → None

Sets the color for the node (removes an existing material from the node and adds a given material based on a given color)

Args:

color (Color): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

setMaterial(self: samson.DataModel.DataGraph.Node, material: SBDDataGraphNodeMaterial, applyToChildren: bool=False) → None

Sets the material for the node (removes an existing material from the node and adds a given material)

Args:

material (Material): material to set

applyToChildren (boolean): if set to True goes through child nodes (default value: False)

sprint(self: samson.Modeling.DynamicalModel.Group, offset: int=0) → None

Prints some debugging information

ArticulatedBody = NodeType.DynamicalModelNodeArticulatedBody

ArticulatedBodySystem = NodeType.DynamicalModelArticulatedBodySystem

Atom = NodeType.Atom

Backbone = NodeType.StructuralModelNodeBackbone

Bond = NodeType.StructuralModelNodeBond

Camera = NodeType.DocumentCamera

Chain = NodeType.StructuralModelNodeChain

Conformation = NodeType.StructuralModelConformation

Controller = NodeType.Controller

ControllerNode = NodeType.ControllerNode

DataGraphNodeGroup = NodeType.DataGraphNodeGroup

Document = NodeType.Document

DocumentCamera = NodeType.DocumentCamera

DocumentLabel = NodeType.DocumentLabel

DocumentLayer = NodeType.DocumentLayer

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

InteractionModel = NodeType.InteractionModel

InteractionModelArticulatedBodySystem = NodeType.InteractionModelArticulatedBodySystem

InteractionModelParticleSystem = NodeType.InteractionModelParticleSystem

InteractionModelRigidBodySystem = NodeType.InteractionModelRigidBodySystem

Label = NodeType.DocumentLabel

Layer = NodeType.DocumentLayer

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.Atom

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

__eq__

Return self==value.

__ge__

Return self>=value.

__gt__

Return self>value.

__le__

Return self<=value.

__lt__

Return self<value.

__ne__

Return self!=value.

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

name of the model

nodeIndex

Returns the node index (unique in the whole data graph, but non-persistent)

selectionFlag

type

typeString

Returns a string describing the type of the data graph node

visibilityFlag