Path¶
-
class
samson.Modeling.StructuralModel.
Path
(*args, **kwargs)¶ Bases:
samson.DataModel.DataGraph.Node
This class describes a structural path
SAMSON API: SBMStructuralModelPath
Overloaded function.
- __init__(self: samson.Modeling.StructuralModel.Path) -> None
Constructs a structural model path
- __init__(self: samson.Modeling.StructuralModel.Path, name: str, nodeIndexer: samson.DataModel.DataGraph.NodeIndexer) -> None
Constructs a structural model path with name from the nodes in nodeIndexer
-
class
AnimationType
(self: samson.Modeling.StructuralModel.Path.AnimationType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
Bounce
= AnimationType.Bounce¶
-
Loop
= AnimationType.Loop¶
-
Once
= AnimationType.Once¶
-
-
class
NodeType
(self: samson.DataModel.DataGraph.Node.NodeType, arg0: int) → None¶ Bases:
pybind11_builtins.pybind11_object
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Camera
= NodeType.Camera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
Folder
= NodeType.Folder¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.Label¶
-
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¶
-
-
add
(*args, **kwargs)¶ Overloaded function.
- add(self: samson.Modeling.StructuralModel.Path, conformation: samson.Modeling.StructuralModel.Conformation) -> bool
Adds a frame to the path
- add(self: samson.Modeling.StructuralModel.Path, path: samson.Modeling.StructuralModel.Path) -> bool
Adds frames to the path
- add(self: samson.Modeling.StructuralModel.Path, positionData: List[samson.DataModel.Type.vector3], energy: samson.DataModel.Quantity.unitsSI=0.000000 (dimensionless), time: samson.DataModel.Quantity.unitsSI=0.000000 (dimensionless), velocityData: List[samson.DataModel.Type.vector3]=[], forceData: List[samson.DataModel.Type.vector3]=[]) -> bool
Adds a frame to the path
- add(self: samson.Modeling.StructuralModel.Path, positionData: List[List[samson.DataModel.Type.vector3]], energyData: List[samson.DataModel.Quantity.unitsSI]=[], timeData: List[samson.DataModel.Quantity.unitsSI]=[], velocityData: List[List[samson.DataModel.Type.vector3]]=[], forceData: List[List[samson.DataModel.Type.vector3]]=[]) -> bool
Adds frames to the path
-
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
-
addStructuralParticle
(self: samson.Modeling.StructuralModel.Path, structuralParticle: samson.Modeling.StructuralModel.Particle, structuralParticlePositionVector: List[samson.DataModel.Type.vector3]=[], structuralParticleVelocityVector: List[samson.DataModel.Type.vector3]=[], structuralParticleForceVector: List[samson.DataModel.Type.vector3]=[]) → bool¶ Adds a structuralParticle to the path
-
canAddChild
(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool¶ Returns whether this node can add node as a child
-
canAddChildType
(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) → bool¶ Returns whether this node can add a node with type nodeType as a child
-
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.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns a copy of the node and its descendants
-
copy
(self: samson.Modeling.StructuralModel.Path, firstStep: int, lastStep: int) → samson.Modeling.StructuralModel.Path¶ Copies frames from the path to create a new path
-
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
-
createConformation
(self: samson.Modeling.StructuralModel.Path, step: int) → samson.DataModel.DataGraph.NodeIndexer¶ Create a conformation corresponding to a specific step
-
createConformations
(self: samson.Modeling.StructuralModel.Path) → samson.DataModel.DataGraph.NodeIndexer¶ Create conformations corresponding to all steps
-
createStructuralModels
(*args, **kwargs)¶ Overloaded function.
- createStructuralModels(self: samson.Modeling.StructuralModel.Path, step: int) -> samson.DataModel.DataGraph.NodeIndexer
Create structural models corresponding to a specific step
- createStructuralModels(self: samson.Modeling.StructuralModel.Path) -> samson.DataModel.DataGraph.NodeIndexer
Create structural models corresponding to all steps
-
erase
(self: samson.DataModel.DataGraph.Node) → None¶ Erases the node
-
getDocument
(self: samson.DataModel.DataGraph.Node) → SBDDocument¶ Returns the document the node belongs to
-
getEnergy
(self: samson.Modeling.StructuralModel.Path, step: int) → samson.DataModel.Quantity.unitsSI¶ Returnes the energy for a specific step
-
getEnergyData
(self: samson.Modeling.StructuralModel.Path) → List[samson.DataModel.Quantity.unitsSI]¶ Returnes the energy data
-
getFlags
(self: samson.DataModel.DataGraph.Node) → int¶ Returns the flags
-
getForce
(*args, **kwargs)¶ Overloaded function.
- getForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the force of structural particle structuralParticleIndex for a specific step
- getForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle) -> samson.DataModel.Type.vector3
Returnes the force of structural particle structuralParticle for a specific step
-
getForceData
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the force array: 2D array, (number of timesteps) x (number of structural nodes)
-
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.ReferenceTarget) → int¶ Returns the memory footprint
-
getNextNode
(*args, **kwargs)¶ Overloaded function.
- getNextNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node
Returns the pointer to the next node in the children of the node’s parent
- getNextNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node
Returns the pointer to the next node with type nodeType in the children of the node’s parent
-
getNextPath
(self: samson.Modeling.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns the next path in the document
-
getNode
(self: int) → samson.DataModel.DataGraph.Node¶ Returns the unique node corresponding to the node index nodeIndex
-
getNodes
(self: samson.Modeling.StructuralModel.Path, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → samson.DataModel.DataGraph.NodeIndexer¶ - Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
- For selectionString and visitString use the Node Specification Language (SAMSON API: Node Specification Language
-
getParent
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the parent of the node
-
getPosition
(*args, **kwargs)¶ Overloaded function.
- getPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the position of structural particle structuralParticleIndex for a specific step
- getPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle) -> samson.DataModel.Type.vector3
Returnes the position of structural particle structuralParticle for a specific step
-
getPositionData
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the position array: 2D array, (number of timesteps) x (number of structural nodes)
-
getPreviousNode
(*args, **kwargs)¶ Overloaded function.
- getPreviousNode(self: samson.DataModel.DataGraph.Node) -> samson.DataModel.DataGraph.Node
Returns the pointer to the previous node in the children of the node’s parent
- getPreviousNode(self: samson.DataModel.DataGraph.Node, nodeType: SBDDataGraphNode::Type) -> samson.DataModel.DataGraph.Node
Returns the pointer to the previous node with type nodeType in the children of the node’s parent
-
getPreviousPath
(self: samson.Modeling.StructuralModel.Path) → samson.Modeling.StructuralModel.Path¶ Returns the previous path in the document
-
getRoot
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the root of the hierarchy the node belongs to
-
getStructuralParticleIndexer
(self: samson.Modeling.StructuralModel.Path) → samson.DataModel.DataGraph.NodeIndexer¶ Returns the indexer of structural particles for which a position is saved
-
getThisNode
(self: samson.DataModel.DataGraph.Node) → samson.DataModel.DataGraph.Node¶ Returns the pointer to this node
-
getTime
(self: samson.Modeling.StructuralModel.Path, step: int) → samson.DataModel.Quantity.unitsSI¶ Returnes the time for a specific step
-
getTimeData
(self: samson.Modeling.StructuralModel.Path) → List[samson.DataModel.Quantity.unitsSI]¶ Returnes the time data
-
getTypeString
(type: SBDDataGraphNode::Type) → str¶ Returns a string describing the type of the data graph node
-
getVelocity
(*args, **kwargs)¶ Overloaded function.
- getVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int) -> samson.DataModel.Type.vector3
Returnes the velocity of structural particle structuralParticleIndex for a specific step
- getVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle) -> samson.DataModel.Type.vector3
Returnes the velocity of structural particle structuralParticle for a specific step
-
getVelocityData
(self: samson.Modeling.StructuralModel.Path) → List[List[samson.DataModel.Type.vector3]]¶ Returns the velocity array: 2D array, (number of timesteps) x (number of structural nodes)
-
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
-
insert
(*args, **kwargs)¶ Overloaded function.
- insert(self: samson.Modeling.StructuralModel.Path, step: int, conformation: samson.Modeling.StructuralModel.Conformation) -> bool
Inserts a frame to the path at the step
- insert(self: samson.Modeling.StructuralModel.Path, step: int, path: samson.Modeling.StructuralModel.Path) -> bool
Inserts frames to the path starting from the step
- insert(self: samson.Modeling.StructuralModel.Path, step: int, positionData: List[samson.DataModel.Type.vector3], energy: samson.DataModel.Quantity.unitsSI=0.000000 (dimensionless), time: samson.DataModel.Quantity.unitsSI=0.000000 (dimensionless), velocityData: List[samson.DataModel.Type.vector3]=[], forceData: List[samson.DataModel.Type.vector3]=[]) -> bool
Inserts a frame in the path at position step
- insert(self: samson.Modeling.StructuralModel.Path, step: int, positionData: List[List[samson.DataModel.Type.vector3]], energyData: List[samson.DataModel.Quantity.unitsSI]=[], timeData: List[samson.DataModel.Quantity.unitsSI]=[], velocityData: List[List[samson.DataModel.Type.vector3]]=[], forceData: List[List[samson.DataModel.Type.vector3]]=[]) -> bool
Inserts frames in the path at position step
-
insertStructuralParticle
(self: samson.Modeling.StructuralModel.Path, structuralParticleIndex: int, structuralParticle: samson.Modeling.StructuralModel.Particle, structuralParticlePositionVector: List[samson.DataModel.Type.vector3]=[], structuralParticleVelocityVector: List[samson.DataModel.Type.vector3]=[], structuralParticleForceVector: List[samson.DataModel.Type.vector3]=[]) → bool¶ Inserts a structuralParticle at index structuralParticleIndex to the path
-
isDynamicalModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a dynamical model
-
isIn
(*args, **kwargs)¶ Overloaded function.
- isIn(self: samson.DataModel.DataGraph.Node, node: samson.DataModel.DataGraph.Node) -> bool
Returns true if and only if this node is node, or descends from it
- isIn(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) -> bool
Returns true if and only if this node is one of the nodes of the nodeIndexer, or descends from one of them
-
isInteractionModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a interaction model
-
isModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a model
-
isOneOf
(self: samson.DataModel.DataGraph.Node, nodeIndexer: SBDDataGraphNodeIndexer) → bool¶ Returns true if and only if this node is one of the nodes of the nodeIndexer
-
isPropertyModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a property model
-
isSimulator
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a simulator
-
isStructuralModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a structural model
-
isStructuralParticle
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a structural particle (an atom or a pseudo-atom)
-
isType
(self: samson.DataModel.DataGraph.Node, type: SBDDataGraphNode::Type) → bool¶ Returns true when the type of the node corresponds to type
-
isVisualModel
(self: samson.DataModel.DataGraph.Node) → bool¶ Returns true when the node is a visual model
-
remove
(*args, **kwargs)¶ Overloaded function.
- remove(self: samson.Modeling.StructuralModel.Path, step: int) -> samson.Modeling.StructuralModel.Conformation
Remove a frame from the path to create a conformation
- remove(self: samson.Modeling.StructuralModel.Path, firstStep: int, lastStep: int) -> samson.Modeling.StructuralModel.Path
Removes frames from the path to create a new path
-
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
-
removeStructuralParticle
(self: samson.Modeling.StructuralModel.Path, structuralParticle: samson.Modeling.StructuralModel.Particle) → bool¶ Removes a structural particle from the path
-
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)
-
setEnergy
(self: samson.Modeling.StructuralModel.Path, step: int, energy: samson.DataModel.Quantity.unitsSI) → None¶ Sets the energy for a specific step
-
setEnergyData
(self: samson.Modeling.StructuralModel.Path, energyData: List[samson.DataModel.Quantity.unitsSI]) → None¶ Sets the energy data
-
setForce
(*args, **kwargs)¶ Overloaded function.
- setForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, force: samson.DataModel.Type.vector3) -> None
Sets the force of structural particle structuralParticleIndex to position for a specific step
- setForce(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle, force: samson.DataModel.Type.vector3) -> None
Sets the force of structural particle structuralParticle to position for a specific step
-
setForceData
(self: samson.Modeling.StructuralModel.Path, forceData: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the force array: 2D array, (number of timesteps) x (number of structural nodes)
-
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)
-
setPosition
(*args, **kwargs)¶ Overloaded function.
- setPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, position: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticleIndex to position for a specific step
- setPosition(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle, position: samson.DataModel.Type.vector3) -> None
Sets the position of structural particle structuralParticle to position for a specific step
-
setPositionData
(self: samson.Modeling.StructuralModel.Path, positionData: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the position array: 2D array, (number of timesteps) x (number of structural nodes)
-
setTime
(self: samson.Modeling.StructuralModel.Path, step: int, time: samson.DataModel.Quantity.unitsSI) → None¶ Sets the time for a specific step
-
setTimeData
(self: samson.Modeling.StructuralModel.Path, timeData: List[samson.DataModel.Quantity.unitsSI]) → None¶ Sets the time data
-
setVelocity
(*args, **kwargs)¶ Overloaded function.
- setVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticleIndex: int, velocity: samson.DataModel.Type.vector3) -> None
Sets the velocity of structural particle structuralParticleIndex to position for a specific step
- setVelocity(self: samson.Modeling.StructuralModel.Path, step: int, structuralParticle: samson.Modeling.StructuralModel.Particle, velocity: samson.DataModel.Type.vector3) -> None
Sets the velocity of structural particle structuralParticle to position for a specific step
-
setVelocityData
(self: samson.Modeling.StructuralModel.Path, velocityData: List[List[samson.DataModel.Type.vector3]]) → None¶ Sets the velocity array: 2D array, (number of timesteps) x (number of structural nodes)
-
sprint
(self: samson.DataModel.DataGraph.Node, offset: int=0) → None¶ Prints some debugging information
-
toString
(self: samson.Modeling.StructuralModel.Path) → str¶ Converts to a string
-
updateState
(self: samson.Modeling.StructuralModel.Path) → None¶ Updates the state along the path according to the animation parameters
-
ArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
ArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
Atom
= NodeType.Atom¶
-
Backbone
= NodeType.StructuralModelNodeBackbone¶
-
Bond
= NodeType.StructuralModelNodeBond¶
-
Bounce
= AnimationType.Bounce¶
-
Camera
= NodeType.Camera¶
-
Chain
= NodeType.StructuralModelNodeChain¶
-
Conformation
= NodeType.StructuralModelConformation¶
-
Controller
= NodeType.Controller¶
-
ControllerNode
= NodeType.ControllerNode¶
-
DataGraphNodeGroup
= NodeType.DataGraphNodeGroup¶
-
Document
= NodeType.Document¶
-
DocumentManager
= NodeType.DocumentManager¶
-
DynamicalGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModel
= NodeType.DynamicalModel¶
-
DynamicalModelArticulatedBodySystem
= NodeType.DynamicalModelArticulatedBodySystem¶
-
DynamicalModelNode
= NodeType.DynamicalModelNode¶
-
DynamicalModelNodeArticulatedBody
= NodeType.DynamicalModelNodeArticulatedBody¶
-
DynamicalModelNodeGroup
= NodeType.DynamicalModelNodeGroup¶
-
DynamicalModelNodeParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalModelNodeRigidBody
= NodeType.DynamicalModelNodeRigidBody¶
-
DynamicalModelNodeRoot
= NodeType.DynamicalModelNodeRoot¶
-
DynamicalModelParticleSystem
= NodeType.DynamicalModelParticleSystem¶
-
DynamicalModelRigidBodySystem
= NodeType.DynamicalModelRigidBodySystem¶
-
DynamicalNode
= NodeType.DynamicalModelNode¶
-
DynamicalParticle
= NodeType.DynamicalModelNodeParticle¶
-
DynamicalRoot
= NodeType.DynamicalModelNodeRoot¶
-
Folder
= NodeType.Folder¶
-
InteractionModel
= NodeType.InteractionModel¶
-
InteractionModelArticulatedBodySystem
= NodeType.InteractionModelArticulatedBodySystem¶
-
InteractionModelParticleSystem
= NodeType.InteractionModelParticleSystem¶
-
InteractionModelRigidBodySystem
= NodeType.InteractionModelRigidBodySystem¶
-
Label
= NodeType.Label¶
-
Loop
= AnimationType.Loop¶
-
Molecule
= NodeType.StructuralModelNodeMolecule¶
-
NodeGroup
= NodeType.DataGraphNodeGroup¶
-
Once
= AnimationType.Once¶
-
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¶
-
animationFlag
¶ The animation flag
-
animationType
¶ The animation type
-
currentEnergy
¶ The current energy
-
currentStep
¶ The current step along the path
-
currentTime
¶ The current time
-
forwardFlag
¶ The forward flag, which indicates when the animation is moving forward
-
highlightingFlag
¶
-
isCreated
¶ Returns true if and only if the node is created
-
isErased
¶ Returns true if and only if the node is erased
-
isHighlighted
¶ Returns whether the node is highlighted
-
isSelected
¶ Returns whether the node is selected
-
isSerializable
¶ Returns true when the class is serializable
-
isVisible
¶ Returns whether the node is visible
-
name
¶ the name of the path
-
nodeIndex
¶ Returns the node index (unique in the whole data graph, but non-persistent)
-
numberOfSteps
¶ The number of steps in the path
-
numberOfStructuralParticles
¶ The number of structural particles for which a position is saved
-
selectionFlag
¶
-
smoothingWindowSize
¶ The size of the smoothing window
-
stepDuration
¶ The step duration
-
stride
¶ The animation stride
-
type
¶ the data graph node type
-
typeString
¶ Returns a string describing the type of this data graph node
-
visibilityFlag
¶