Document

This library contains classes related to SAMSON documents.

SAMSON API: The SBDDocument Library

class samson.DataModel.Document.Camera(*args, **kwargs)

Bases: samson.DataModel.DataGraph.Node

This class describes a camera.

SAMSON API: SBDDocumentCamera

Overloaded function.

  1. __init__(self: samson.DataModel.Document.Camera) -> None

Constructs a camera

  1. __init__(self: samson.DataModel.Document.Camera, name: str) -> None

Constructs a camera with name

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

backView(self: samson.DataModel.Document.Camera) → None

Goes to the back view

bottomView(self: samson.DataModel.Document.Camera) → None

Goes to the bottom view

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

center(self: samson.DataModel.Document.Camera) → None

Centers the camera

clone(self: samson.DataModel.Document.Camera) → samson.DataModel.Document.Camera

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

defaultView(self: samson.DataModel.Document.Camera) → None

Sets the view to default parameters

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

Erases the node

fitToScreen(self: samson.DataModel.Document.Camera) → None

Fits the camera

frontView(self: samson.DataModel.Document.Camera) → None

Goes to the front view

getDocument(self: samson.DataModel.Document.Camera) → samson.DataModel.Document.Document

Returns the document

getEyeDestination(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns destination of the eye

getEyePosition(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns position of the eye

getEyeVelocity(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns velocity of the eye

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

Returns the flags

getFrustumPositionFromWorldPosition(self: samson.DataModel.Document.Camera, worldPosition: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns the projection in the frustum of a given world position

getHeadPosition(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns position of the head

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

getNextCamera(self: samson.DataModel.Document.Camera) → samson.DataModel.Document.Camera

Returns the next Camera

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

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer
Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
getParent(self: samson.DataModel.Document.Camera) → samson.DataModel.DataGraph.Node

Returns the parent node

getPreviousCamera(self: samson.DataModel.Document.Camera) → samson.DataModel.Document.Camera

Returns the previous Camera

getProjectionMatrix(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the projection matrix

getProjectionMatrixTranspose(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the transpose of the projection matrix

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

Returns the root of the hierarchy the node belongs to

getRotationVelocity(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns rotation velocity

getTargetDestination(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns destination of the target

getTargetPosition(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns position of the target

getTargetVelocity(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns velocity of the target

getUpVector(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns up vector

getUpVectorDestination(self: samson.DataModel.Document.Camera) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns destination of the up vector

getViewMatrix(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the view matrix

getViewMatrixTranspose(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the transpose of the view matrix

getViewProjectionMatrix(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the view projection matrix

getViewProjectionMatrixTranspose(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the transpose of the view projection matrix

getViewProjectionMatrixTransposeInverse(self: samson.DataModel.Document.Camera) → List[List[float]]

Returns the inverse of the transpose of the view projection matrix

getWorldPositionFromFrustumPosition(self: samson.DataModel.Document.Camera, frustumPosition: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns the world position that corresponds to a frustum position

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

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

leftView(self: samson.DataModel.Document.Camera) → None

Goes to the left view

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

rightView(self: samson.DataModel.Document.Camera) → None

Goes to the right view

rotate(self: samson.DataModel.Document.Camera, velocity: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >, center: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Rotates the camera

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)

setEyeDestination(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets destination of the eye

setEyePosition(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets position of the eye

setEyeVelocity(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets velocity of the eye

setHeadPosition(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets position of the head

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)

setRotationVelocity(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets rotation velocity

setTargetDestination(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets destination of the target

setTargetPosition(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets position of the target

setTargetVelocity(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets velocity of the target

setUpVector(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets up vector

setUpVectorDestination(self: samson.DataModel.Document.Camera, arg0: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Sets destination of the up vector

sprint(self: samson.DataModel.Document.Camera, offset: int=0) → None

Prints some debugging information

stop(self: samson.DataModel.Document.Camera) → None

Stops the camera

topView(self: samson.DataModel.Document.Camera) → None

Goes to the top view

translate(self: samson.DataModel.Document.Camera, velocity: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Translates the camera

updateState(self: samson.DataModel.Document.Camera) → bool

Updates the state of the camera and returns true if the camera moved

zoomIn(self: samson.DataModel.Document.Camera, velocity: SBDQuantityWrapper<SBDQuantityUnitSystemSI>, center: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Zooms in

zoomOut(self: samson.DataModel.Document.Camera, velocity: SBDQuantityWrapper<SBDQuantityUnitSystemSI>, center: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Zooms out

zoomTo(self: samson.DataModel.Document.Camera, cameraTargetDestination: SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >) → None

Zooms to a specific destination

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.

aspectRatio

aspect ratio

basisX

the x vector of the camera basis

basisY

the y vector of the camera basis

basisZ

the z vector of the camera basis

clippingPlane

clipping plane

farPlane

far plane

fieldOfViewAngleY

field of view angle

highlightingFlag
inertiaFlag
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 camera

nearPlane

near plane

nodeIndex

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

orthographicProjectionFlag

the orthographic projection flag

selectionFlag
type

Returns the type of the data graph node

typeString

Returns a string describing the type of the data graph node

visibilityFlag
class samson.DataModel.Document.Document(*args, **kwargs)

Bases: samson.DataModel.DataGraph.Node

This class describes a document.

SAMSON API: SBDDocument

Overloaded function.

  1. __init__(self: samson.DataModel.Document.Document) -> None

Constructs a document

  1. __init__(self: samson.DataModel.Document.Document, name: str) -> None

Constructs a document with name

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

Bases: pybind11_builtins.pybind11_object

__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.Document.Document, 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

addNodeToSelection(self: samson.DataModel.Document.Document, node: samson.DataModel.DataGraph.Node) → None

Adds a node to the selection

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

clearSelection(self: samson.DataModel.Document.Document) → None

Clears the selection

clone(self: samson.DataModel.Document.Document) → samson.DataModel.Document.Document

Returns a copy of the node and its descendants

countNodes(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → int
Count nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
create(self: samson.DataModel.DataGraph.Node) → None

Creates the node

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

Erases the node

getActiveLayer(self: samson.DataModel.Document.Document) → SBDDocumentLayer

Returns the active document layer

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

getNextDocument(self: samson.DataModel.Document.Document) → samson.DataModel.Document.Document

Returns the next document

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

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer
Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
getParent(self: samson.DataModel.Document.Document) → samson.DataModel.DataGraph.Node

Returns the parent node

getPreviousDocument(self: samson.DataModel.Document.Document) → samson.DataModel.Document.Document

Returns the previous document

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

Returns the root of the hierarchy the node belongs to

getSelectedNodes(self: samson.DataModel.Document.Document) → SBCReferencePointerIndexer<SBDDataGraphNode, SBCReferenceToTarget>

Returns the index of selected 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

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

  1. 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.Document.Document, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the node

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

Removes material from the node

removeNodeFromSelection(self: samson.DataModel.Document.Document, node: samson.DataModel.DataGraph.Node) → None

Adds a node to the selection

setActiveLayer(self: samson.DataModel.Document.Document, arg0: SBDDocumentLayer) → None

Sets the active document layer

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.DataModel.DataGraph.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.

fileName

name of the file associated to the document

highlightingFlag
isCreated

Returns true if and only if the node is created

isErased

Returns true if and only if the node is erased

isHighlighted

Returns whether the node is highlighted

isSelected

Returns whether the node is selected

isSerializable

Returns true when the class is serializable

isVisible

Returns whether the node is visible

nodeIndex

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

selectionFlag
type

Returns the type of the data graph node

typeString

Returns a string describing the type of the data graph node

visibilityFlag
class samson.DataModel.Document.Label(*args, **kwargs)

Bases: samson.DataModel.DataGraph.Node

This class describes a label.

SAMSON API: SBDDocumentLabel

Overloaded function.

  1. __init__(self: samson.DataModel.Document.Label) -> None

Constructs a label

  1. __init__(self: samson.DataModel.Document.Label, name: str) -> None

Constructs a label with name

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

changed(self: samson.DataModel.Document.Label) → None

Emits the LabelChanged event

clone(self: samson.DataModel.Document.Label) → samson.DataModel.Document.Label

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

display(self: samson.DataModel.Document.Label) → None

Displays the label

displayForSelection(self: samson.DataModel.Document.Label) → None

Displays the label for selection purposes

displayForShadow(self: samson.DataModel.Document.Label) → None

Displays the label for shadow purposes

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

Erases the node

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

Returns the flags

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

Returns the inherited flags

getLayer(self: samson.DataModel.Document.Label) → samson.DataModel.Document.Layer

Returns the 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

getNextLabel(self: samson.DataModel.Document.Label) → samson.DataModel.Document.Label

Returns the next Label

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

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.DataModel.DataGraph.Node, selectionString: str='*', visitString: str='*', includeDependencies: bool=False) → SBDDataGraphNodeIndexer
Returns nodes (in a node indexer), based on a selectionString and a visitString, with our without dependencies).
For selectionString and visitString use Node Specification Language (SAMSON API: Node Specification Language
getParent(self: samson.DataModel.Document.Label) → samson.DataModel.DataGraph.Node

Returns the parent node

getPosition(self: samson.DataModel.Document.Label) → SBDTypePhysicalVector3Wrapper<SBDQuantityWrapper<SBDQuantityUnitSystemSI> >

Returns the position of the label

getPreviousLabel(self: samson.DataModel.Document.Label) → samson.DataModel.Document.Label

Returns the previous Label

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

  1. 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.DataModel.Document.Label, offset: int=0) → None

Prints some debugging information

updateText(self: samson.DataModel.Document.Label) → None

update text of the label

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.

drawOnTop
drawOutline
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

maximumDisplayRadius
minimumDisplayRadius
name

the label name

nodeIndex

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

selectionFlag
text

the text of the label

type

Returns the type of the data graph node

typeString

Returns a string describing the type of the data graph node

visibilityFlag
class samson.DataModel.Document.Layer(*args, **kwargs)

Bases: samson.DataModel.DataGraph.Node

This class describes a document layer.

SAMSON API: SBDDocumentLayer

Overloaded function.

  1. __init__(self: samson.DataModel.Document.Layer) -> None

Constructs a layer

  1. __init__(self: samson.DataModel.Document.Layer, name: str) -> None

Constructs a layer with name

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.Document.Layer, node: samson.DataModel.DataGraph.Node, nextNode: samson.DataModel.DataGraph.Node=None) → bool

Adds a child to the Layer

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.DataModel.Document.Layer) → samson.DataModel.Document.Layer

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

getActiveModel(self: samson.DataModel.Document.Layer) → SBMModel

Returns the active model

getControllerList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBDController, SBCReferenceToTarget>

Returns the list of controllers

getDocument(self: samson.DataModel.Document.Layer) → samson.DataModel.Document.Document

Returns the document

getDynamicalModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMDynamicalModel, SBCReferenceToTarget>

Returns the list of dynamical models

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

Returns the flags

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

Returns the inherited flags

getInteractionModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMInteractionModel, SBCReferenceToTarget>

Returns the list of interaction models

getLabelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBDDocumentLabel, SBCReferenceToTarget>

Returns the list of labels

getMaterial(self: samson.DataModel.DataGraph.Node) → SBDDataGraphNodeMaterial

Returns the material of the node

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

Returns the node whose material is inherited

getMemoryFootprint(self: samson.Core.Reference.SBCReferenceTarget) → int

Returns the memory footprint

getModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMModel, SBCReferenceToTarget>

Returns the list of models

getNextLayer(self: samson.DataModel.Document.Layer) → samson.DataModel.Document.Layer

Returns the next Layer

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

Returns the unique node corresponding to the node index nodeIndex

getNodes(self: samson.DataModel.Document.Layer, 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.DataModel.Document.Layer) → samson.DataModel.DataGraph.Node

Returns the parent node

getPreviousLayer(self: samson.DataModel.Document.Layer) → samson.DataModel.Document.Layer

Returns the previous Layer

getPropertyModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMPropertyModel, SBCReferenceToTarget>

Returns the list of property models

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

Returns the root of the hierarchy the node belongs to

getSimulatorList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBSSimulator, SBCReferenceToTarget>

Returns the list of simulators

getStructuralModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMStructuralModel, SBCReferenceToTarget>

Returns the list of structural models

getVisualModelList(self: samson.DataModel.Document.Layer) → SBCReferencePointerList<SBMVisualModel, SBCReferenceToTarget>

Returns the list of visual models

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

  1. 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.Document.Layer, node: samson.DataModel.DataGraph.Node) → bool

Removes a child from the Layer

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

Removes material from the node

setActiveModel(self: samson.DataModel.Document.Layer, model: SBMModel) → None

Sets the active model

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.DataModel.Document.Layer, 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

the layer name

nodeIndex

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

selectionFlag
type

Returns the type of the data graph node

typeString

Returns a string describing the type of the data graph node

visibilityFlag