Home Elements Documentation Blog Forum Download
List of all members
SBMStructuralModelNode Class Reference

This class describes a structural model node.

Destructors

virtual ~SBMStructuralModelNode ()
 

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 node.
 
virtual void unserialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0))
 Unserializes the node.
 

Topology

virtual SBDDataGraphNode * getParent () const
 Returns the parent of the node. More...
 
virtual bool addChild (SBMStructuralModelNode *node, SBMStructuralModelNode *nextNode=0)
 
virtual bool removeChild (SBMStructuralModelNode *node)
 
virtual SBPointerList< SBMStructuralModelNode > const * getChildren () const
 
SBMStructuralModelNode * getNextStructuralNode () const
 
SBMStructuralModelNode * getPreviousStructuralNode () const
 
virtual SBMStructuralModelNode * clone ()
 Returns a copy of the node and its descendants.
 

Identity

virtual SBDDataGraphNode::Type getType () const
 Returns the type of the data graph node. More...
 

Model

SBMStructuralModel * getModel () const
 

Mobility

bool getMobilityFlag () const
 Returns the mobility flag.
 
void setMobilityFlag (bool flag)
 Sets the mobility flag to flag.
 

Messaging

void connectStructuralSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBStructuralEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBStructuralEvent *)=0)
 
bool structuralSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBStructuralEvent *)) const
 
void disconnectStructuralSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBStructuralEvent *))
 

Selection functions

virtual void getNodes (SBNodeIndexer &nodeIndexer, const SBNodePredicate &selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false)
 Returns some nodes.
 
void getAllStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getInternalStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getLeafStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode *> &nodeIndexer, bool(*selectionRule)(SBMStructuralModelNode *))
 
void getAllStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getInternalStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getLeafStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode *> &nodeIndexer, bool(*selectionRule)(SBMStructuralModelNode *))
 
void getAllStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getInternalStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getLeafStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode *> &nodeIndexer)
 
void getStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode *> &nodeIndexer, bool(*selectionRule)(SBMStructuralModelNode *))
 
void getStructuralNodesBreadthFirst (std::vector< SBMStructuralModelNode *> &nodeVectorTopDown, std::vector< SBMStructuralModelNode *> &nodeVectorBottomUp, bool(*selectionRule)(SBMStructuralModelNode *))
 

Visitor functions

virtual void forEachNodeDepthFirst (void(*action)(SBDDataGraphNode *node))
 Performs an action on each node.
 
virtual void forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node))
 Performs an action on each node.
 
void forEachStructuralNodeBreadthFirst (void(*action)(SBMStructuralModelNode *node))
 
void forEachStructuralNodeDepthFirst (void(*action)(SBMStructuralModelNode *node))
 
void forEachStructuralNodeBreadthFirst (SBCClass *object, void(SBCClass::*action)(SBMStructuralModelNode *node))
 
void forEachStructuralNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBMStructuralModelNode *node))
 
static void forEachStructuralNodeInSelection (std::vector< SBMStructuralModelNode *> &selection, void(*action)(SBMStructuralModelNode *node))
 
static void forEachStructuralNodeInSelection (std::vector< SBMStructuralModelNode *> &selection, SBCClass *object, void(SBCClass::*action)(SBMStructuralModelNode *node))
 

Debugging

virtual void print (unsigned int offset=0) const
 Prints some debugging information.
 

Constructors and destructors

 SBMStructuralModelNode ()
 Builds a structural model node.
 
 SBMStructuralModelNode (SBMStructuralModelNodeData *dataPointer)
 Builds a structural model node.
 

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,
  DocumentLayer,
  Layer,
  DocumentCamera,
  Camera,
  DocumentLabel,
  Label,
  DataGraphNodeGroup,
  NodeGroup,
  Controller,
  ControllerNode
}
 The type of the data graph node. More...
 
- Public Member Functions inherited from SBMModelNode
- Public Member Functions inherited from SBDDataGraphNode
SBDDataGraphNode * getThisNode () const
 Returns the pointer to this node. 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 isOneOf (const SBNodeIndexer &nodeIndexer) const
 Returns true if and only if this node is one of the nodes of the nodeIndexer. 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 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 SBMModelNode
 SBMModelNode ()
 Builds a base object.
 
 SBMModelNode (SBMModelNodeData *dataPointer)
 Builds a base object.
 
virtual ~SBMModelNode ()
 
- 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...
 

Member Function Documentation

◆ getParent()

SBDDataGraphNode * SBMStructuralModelNode::getParent ( ) const
virtual

The data graph node has a hierarchical structure, in which each node has zero or one parent.

Reimplemented from SBMModelNode.

Reimplemented in SBMStructuralModelNodeRoot.

◆ getType()

SBDDataGraphNode::Type SBMStructuralModelNode::getType ( ) const
virtual

Each node in the data graph has a type, which can be used, for example, to rapidly search the data graph:

// Find all atoms
SBNodeIndexer nodeIndexer;
SAMSON::getActiveDocument()->getNodes(nodeIndexer, SBNode::IsType(SBNode::Atom));

Reimplemented from SBMModelNode.

Reimplemented in SBMStructuralModelNodeResidue, SBMStructuralModelNodeBond, SBMStructuralModelNodeAtom, SBMStructuralModelNodeBackbone, SBMStructuralModelNodeGroup, SBMStructuralModelNodeSideChain, SBMStructuralModelNodeRoot, SBMStructuralModelNodeSegment, SBMStructuralModelNodeChain, SBMStructuralModelNodeMolecule, SBMStructuralModelNodeParticle, and SBMStructuralModelNodePseudoAtom.