This class describes a structural conformation. More...
Constructors and destructors | |
SBMStructuralModelConformation () | |
Constructs a structural model conformation. | |
SBMStructuralModelConformation (const std::string &name, const SBNodeIndexer &nodeIndexer, SBVector< SBPosition3 > *positionData=0, const SBQuantity::energy &energy=SBQuantity::energy::zero, const SBQuantity::time &time=SBQuantity::time::zero, SBVector< SBVelocity3 > *velocityData=0, SBVector< SBForce3 > *forceData=0) | |
Constructs a structural model conformation with name name from the nodes in nodeIndexer . | |
virtual | ~SBMStructuralModelConformation () |
Destructs the conformation. | |
Serialization | |
bool | isSerializable () const |
Returns true. | |
virtual void | serialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const |
Serializes the conformation. | |
virtual void | unserialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) |
Unserializes the conformation. | |
Topology | |
virtual SBMStructuralModelConformation * | clone () |
Returns a copy of the node and its descendants. | |
Identity | |
virtual SBNode::Type | getType () const |
Returns the data graph node type. | |
std::string const & | getName () const |
Returns the name of the conformation. | |
void | setName (const std::string &n) |
Sets the name of the conformation. | |
SBMStructuralModelConformation * | getNextConformation () const |
Returns the next conformation in the document. | |
SBMStructuralModelConformation * | getPreviousConformation () const |
Returns the previous conformation in the document. | |
Selection | |
virtual void | getNodes (SBNodeIndexer &nodeIndexer, const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) |
Returns some nodes. | |
Visitor | |
virtual void | forEachNodeDepthFirst (void(*action)(SBDDataGraphNode *node)) |
Performs action action on each node of this document. | |
virtual void | forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node)) |
Performs action action of object object on each node of this document. | |
Indexer | |
SBPointerIndexer< SBStructuralParticle > const * | getStructuralParticleIndexer () const |
Returns the indexer of structural particles for which a position is saved. | |
unsigned int | getNumberOfStructuralParticles () const |
Returns the number of particles for which a position is saved. | |
bool | addStructuralParticle (SBStructuralParticle *structuralParticle, const SBPosition3 &structuralParticlePosition) |
Adds a structuralParticle with position structuralParticlePosition . | |
bool | insertStructuralParticle (unsigned int structuralParticleIndex, SBStructuralParticle *structuralParticle, const SBPosition3 &structuralParticlePosition) |
Inserts a structuralParticle with position structuralParticlePosition at index structuralParticleIndex . | |
bool | removeStructuralParticle (SBStructuralParticle *structuralParticle) |
Removes a structural particle from the conformation. | |
Positions | |
virtual SBVector< SBPosition3 > * | getPositionData () const |
Returns the position data. | |
virtual void | setPositionData (SBVector< SBPosition3 > *positionData) |
Sets the position data. | |
bool | getPosition (unsigned int structuralParticleIndex, SBPosition3 &structuralParticlePosition) const |
Retrieves the position of structural particle structuralParticleIndex and stores it in structuralParticlePosition . | |
bool | getPosition (SBStructuralParticle *structuralParticle, SBPosition3 &structuralParticlePosition) const |
Retrieves the position of structural particle structuralParticle and stores it in structuralParticlePosition . | |
bool | setPosition (unsigned int structuralParticleIndex, const SBPosition3 &structuralParticlePosition) |
Sets the position of structural particle structuralParticleIndex and stores it in structuralParticlePosition . | |
bool | setPosition (SBStructuralParticle *structuralParticle, const SBPosition3 &structuralParticlePosition) |
Sets the position of structural particle structuralParticle and stores it in structuralParticlePosition . | |
void | restore () const |
Restores the conformation. | |
Energy | |
virtual SBQuantity::energy | getEnergy () const |
Returns the energy data. | |
virtual void | setEnergy (const SBQuantity::energy &energy) |
Sets the energy data. | |
Time | |
virtual SBQuantity::time | getTime () const |
Returns the time data. | |
virtual void | setTime (const SBQuantity::time &time) |
Sets the time data. | |
Velocities | |
virtual SBVector< SBVelocity3 > * | getVelocityData () const |
Returns the velocity data. | |
virtual void | setVelocityData (SBVector< SBVelocity3 > *velocityData) |
Sets the velocity data. | |
virtual bool | getVelocity (unsigned int structuralParticleIndex, SBVelocity3 &velocity) const |
Retrieves the velocity of structural particle structuralParticleIndex and stores it in velocity . | |
virtual bool | getVelocity (SBStructuralParticle *structuralParticle, SBVelocity3 &velocity) const |
Retrieves the velocity of structural particle structuralParticle and stores it in velocity . | |
virtual bool | setVelocity (unsigned int structuralParticleIndex, const SBVelocity3 &velocity) |
Sets the velocity of structural particle structuralParticleIndex to velocity . | |
virtual bool | setVelocity (SBStructuralParticle *structuralParticle, const SBVelocity3 &velocity) |
Sets the velocity of structural particle structuralParticle to velocity . | |
Forces | |
virtual SBVector< SBForce3 > * | getForceData () const |
Returns the force data. | |
virtual void | setForceData (SBVector< SBForce3 > *forceData) |
Sets the force data. | |
virtual bool | getForce (unsigned int structuralParticleIndex, SBForce3 &force) const |
Retrieves the force of structural particle structuralParticleIndex and stores it in force . | |
virtual bool | getForce (SBStructuralParticle *structuralParticle, SBForce3 &force) const |
Retrieves the force of structural particle structuralParticle and stores it in force . | |
virtual bool | setForce (unsigned int structuralParticleIndex, const SBForce3 &force) |
Sets the force of structural particle structuralParticleIndex to force . | |
virtual bool | setForce (SBStructuralParticle *structuralParticle, const SBForce3 &force) |
Sets the force of structural particle structuralParticle to force . | |
Structural models | |
virtual void | createStructuralModels (SBNodeIndexer &structuralModelIndexer) const |
Create structural models corresponding to all steps. | |
Debugging | |
void | print (unsigned int offset=0) const |
Prints the conformation. | |
Additional Inherited Members | |
Public Types inherited from SBDDataGraphNode | |
enum | Type { Undefined, StructuralModel, StructuralModelNode, StructuralModelConformation, Conformation, StructuralModelPath, Path, StructuralModelNodeGroup, StructuralGroup, StructuralModelNodeRoot, Root, StructuralModelNodeParticle, StructuralParticle, StructuralModelNodeAtom, Atom, StructuralModelNodePseudoAtom, PseudoAtom, StructuralModelNodeBond, Bond, StructuralModelNodeResidue, Residue, StructuralModelNodeSegment, Segment, StructuralModelNodeProtein, Protein, StructuralModelNodeChain, Chain, StructuralModelNodeMolecule, Molecule, StructuralModelNodeBackbone, Backbone, StructuralModelNodeSideChain, SideChain, VisualModel, DynamicalModel, DynamicalModelParticleSystem, ParticleSystem, DynamicalModelRigidBodySystem, RigidBodySystem, DynamicalModelArticulatedBodySystem, ArticulatedBodySystem, DynamicalModelNode, DynamicalNode, DynamicalModelNodeGroup, DynamicalGroup, DynamicalModelNodeRoot, DynamicalRoot, DynamicalModelNodeParticle, DynamicalParticle, DynamicalModelNodeRigidBody, RigidBody, DynamicalModelNodeArticulatedBody, ArticulatedBody, InteractionModel, InteractionModelParticleSystem, InteractionModelRigidBodySystem, InteractionModelArticulatedBodySystem, PropertyModel, PropertyModelFunction, Simulator, SimulatorParticleSystem, SimulatorRigidBodySystem, SimulatorArticulatedBodySystem, StateUpdater, StateUpdaterParticleSystem, StateUpdaterRigidBodySystem, StateUpdaterArticulatedBodySystem, DocumentManager, Document, Folder, Camera, Label, DataGraphNodeGroup, NodeGroup, Controller, ControllerNode } |
The type of the data graph node. More... | |
Public Member Functions inherited from SBDDataGraphNode | |
SBDDataGraphNode * | getParent () const |
Returns the parent of the node. More... | |
SBDDataGraphNode * | getThisNode () const |
Returns the pointer to this node. More... | |
SBDDataGraphNode * | getNextNode () const |
Returns the pointer to the next node in the children of the node's parent. More... | |
SBDDataGraphNode * | getPreviousNode () const |
Returns the pointer to the previous node in the children of the node's parent. More... | |
SBDDataGraphNode * | getNextNode (SBDDataGraphNode::Type nodeType) const |
Returns the pointer to the next node with type nodeType in the children of the node's parent. More... | |
SBDDataGraphNode * | getPreviousNode (SBDDataGraphNode::Type nodeType) const |
Returns the pointer to the previous node with type nodeType in the children of the node's parent. More... | |
SBDDocument * | getDocument () const |
Returns the document the node belongs to. More... | |
virtual bool | canAddChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=0) const |
Returns whether this node can add node as a child. More... | |
virtual bool | canAddChildType (SBDDataGraphNode::Type nodeType) const |
Returns whether this node can add a node with type nodeType as a child. More... | |
virtual bool | addChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=0) |
Adds a child to the node. More... | |
virtual bool | removeChild (SBDDataGraphNode *node) |
Removes a child from the node. More... | |
bool | hasOneOf (const SBNodeIndexer &nodeIndexer) const |
Returns true if and only if this node is one of the nodes of the nodeIndexer , or is the ancestor of one of them. More... | |
bool | isIn (SBDDataGraphNode *node) const |
Returns true if and only if this node is node , or descends from it. More... | |
bool | isIn (const SBNodeIndexer &nodeIndexer) const |
Returns true if and only if this node is one of the nodes of the nodeIndexer , or descends from one of them. More... | |
bool | isIn (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const |
Returns true if and only if this node is one of the nodes of the nodePointerIndexer , or descends from one of them. More... | |
bool | isOneOf (const SBNodeIndexer &nodeIndexer) const |
Returns true if and only if this node is one of the nodes of the nodeIndexer . More... | |
bool | isOneOf (SBPointerIndexer< SBDDataGraphNode > *nodePointerIndexer) const |
Returns true if and only if this node is one of the nodes of the nodePointerIndexer . More... | |
SBDDataGraphNode * | getRoot () const |
Returns the root of the hierarchy the node belongs to. More... | |
unsigned int | getNodeIndex () const |
Returns the node index (unique in the whole data graph, but non-persistent) More... | |
bool | isType (Type type) const |
Returns true when the type of the node corresponds to type . | |
bool | isModel () const |
Returns true when the node is a model. | |
bool | isStructuralModel () const |
Returns true when the node is a structural model. | |
bool | isVisualModel () const |
Returns true when the node is a visual model. | |
bool | isDynamicalModel () const |
Returns true when the node is a dynamical model. | |
bool | isInteractionModel () const |
Returns true when the node is a interaction model. | |
bool | isPropertyModel () const |
Returns true when the node is a property model. | |
bool | isSimulator () const |
Returns true when the node is a simulator. | |
bool | isStructuralParticle () const |
Returns true when the node is a structural particle (an atom or a pseudo-atom) | |
bool | isCreated () const |
Returns true if and only if the node is created. More... | |
void | create () |
Creates the node. More... | |
bool | isErased () const |
Returns true if and only if the node is erased. More... | |
void | erase () |
Erases the node. More... | |
unsigned int | getFlags () const |
Returns the flags. More... | |
unsigned int | getInheritedFlags () const |
Returns the inherited flags. More... | |
bool | isSelected () const |
Returns whether the node is selected. More... | |
bool | getSelected () const |
Returns whether the node is visible. | |
bool | getSelectionFlag () const |
Returns the selection flag. More... | |
void | setSelectionFlag (bool flag) |
Sets the selection flag. More... | |
bool | isVisible () const |
Returns whether the node is visible. More... | |
bool | getVisible () const |
Returns whether the node is visible. | |
bool | getVisibilityFlag () const |
Returns the visibility flag. More... | |
void | setVisibilityFlag (bool flag) |
Sets the visibility flag. More... | |
bool | isHighlighted () const |
Returns whether the node is highlighted. More... | |
bool | getHighlightingFlag () const |
Returns the highlighting flag. More... | |
void | setHighlightingFlag (bool flag) |
Sets the highlighting flag. More... | |
void | connectBaseSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBBaseEvent *)=0) |
Connects the base signal to a slot. More... | |
bool | baseSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) const |
Returns true when the base signal is connected to a slot. | |
void | disconnectBaseSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) |
Disconnects the base signal from a slot. | |
unsigned int | countNodes (const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) |
Collects nodes into nodeIndexer , based on a selectionPredicate and a visitPredicate , with our without dependencies. More... | |
bool | addMaterial (SBDDataGraphNodeMaterial *material) |
Adds a material. More... | |
bool | removeMaterial () |
Removes the material. More... | |
SBDDataGraphNodeMaterial * | getMaterial () const |
Returns the material. More... | |
SBDDataGraphNode * | getMaterialOwner () const |
Returns the node whose material is inherited. More... | |
Public Member Functions inherited from SBCReferenceTarget | |
SBCReferenceTarget () | |
virtual | ~SBCReferenceTarget () |
unsigned int | getMemoryFootprint () const |
void | printReferencesToOwners () const |
Static Public Member Functions inherited from SBDDataGraphNode | |
static SBDDataGraphNode * | getNode (unsigned int nodeIndex) |
Returns the unique node corresponding to the node index nodeIndex . More... | |
static std::string | getTypeString (Type type) |
Returns a string describing the type of the data graph node. More... | |
static void | forEachNodeInSelection (SBNodeIndexer &nodeIndexer, void(*action)(SBDDataGraphNode *node)) |
Performs an action for each node in a selection. | |
static void | forEachNodeInSelection (SBNodeIndexer &nodeIndexer, SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node)) |
Performs an action for each node in a selection. | |
Protected Member Functions inherited from SBDDataGraphNode | |
SBDDataGraphNode () | |
Builds a data graph node. More... | |
SBDDataGraphNode (SBDDataGraphNodeData *dataPointer) | |
Builds a data graph node. | |
virtual | ~SBDDataGraphNode () |
Destroys the node. More... | |
This class describes a structural conformation, i.e. a set of positions of structural particles. In SAMSON, the user may name and save a structural conformation. Stored conformations appear in the document view, and the user may thus restore structural conformations by right-clicking on them.
Short name: SBConformation