Class SBMStructuralModelNodeMolecule#
ClassList > SBMStructuralModelNodeMolecule
This class describes a molecule in a structural model. More...
#include "SBMStructuralModelNodeMolecule.hpp"
Inherits the following classes: SBMStructuralModelNodeGroup
Public Types inherited from SBDDataGraphNode#
See SBDDataGraphNode
| Type | Name |
|---|---|
| enum | RenderingPass The rendering pass. |
| enum | Type The type of the data graph node. |
Public Functions#
| Type | Name |
|---|---|
| SBMStructuralModelNodeMolecule () Builds a molecule. |
|
| SBMStructuralModelNodeMolecule (const std::string & n) Builds a molecule with the given name. |
|
| virtual bool | canAddChildType (SBNode::Type nodeType) override const Returns whether this node can add a node with type nodeType as a child. |
| virtual bool | canHaveDescendantType (SBNode::Type nodeType) override const Returns whether this node can have a node with type nodeType as a descendant. |
| virtual SBMStructuralModelNodeMolecule * | clone () override Returns a copy of the node and its descendants. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the node type (returns SBNode::SideChain ) |
| virtual | ~SBMStructuralModelNodeMolecule () Destructor. |
Public Functions inherited from SBMStructuralModelNodeGroup#
See SBMStructuralModelNodeGroup
| Type | Name |
|---|---|
| SBMStructuralModelNodeGroup () Builds a structural group. |
|
| SBMStructuralModelNodeGroup (const std::string & n) Builds a structural group with the given name. |
|
| SB_DECLARE_DATA (SBMStructuralModelNodeGroup) |
|
| SB_NODE_GETTER_0 (std::string, GetComment) |
|
| SB_NODE_GETTER_0 (std::string, GetStatusBit) |
|
| SB_NODE_GETTER_0 (int, GetStructuralID) |
|
| SB_NODE_PREDICATE_0 (HasComment) |
|
| SB_NODE_PREDICATE_0 (HasStatusBit) |
|
| SB_NODE_PREDICATE_0 (HasStructuralID) |
|
| virtual bool | addChild (SBNode * node, SBNode * nextNode=nullptr) override Adds a child to the node. |
| virtual bool | canAddChild (const SBNode * node, const SBNode * nextNode=nullptr) override const Returns whether this node can add node as a child. |
| virtual bool | canAddChildType (SBNode::Type nodeType) override const Returns whether this node can add a node with type nodeType as a child. |
| virtual bool | canHaveDescendantType (SBNode::Type nodeType) override const Returns whether this node can have a node with type nodeType as a descendant. |
| void | clearComment () Clears the comment. |
| void | clearStatusBit () Clears the status bit. |
| void | clearStructuralID () Clears the structural group's id. |
| virtual SBMStructuralModelNodeGroup * | clone () override Returns a copy of the node and its descendants. |
| virtual void | forEachNodeDepthFirst (void(*)(SBDDataGraphNode *node) action) override Performs the action on this node and then its children in the depth-first way. |
| virtual void | forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) override Performs the object 'saction on this node and then its children in the depth-first way. |
| virtual SBPointerList< SBMStructuralModelNode > const * | getChildren () override const Returns the list of child nodes. |
| std::string const & | getComment () const Returns the comment. |
| virtual SBQuantity::mass | getMolecularWeight () override Returns the molecular weight. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies. |
| virtual unsigned int | getNumberOfAtoms () override Returns the number of atoms. |
| virtual unsigned int | getNumberOfCarbons () override Returns the number of carbons. |
| virtual unsigned int | getNumberOfChains () override Returns the number of chains. |
| virtual unsigned int | getNumberOfCoarseGrainedAtoms () override Returns the number of coarse-grained atoms. |
| virtual unsigned int | getNumberOfHydrogens () override Returns the number of hydrogens. |
| virtual unsigned int | getNumberOfMolecules () override Returns the number of molecules. |
| virtual unsigned int | getNumberOfNitrogens () override Returns the number of nitrogens. |
| virtual unsigned int | getNumberOfOtherAtoms () override Returns the number of other atoms. |
| virtual unsigned int | getNumberOfOxygens () override Returns the number of oxygens. |
| virtual unsigned int | getNumberOfResidues () override Returns the number of residues. |
| virtual unsigned int | getNumberOfSegments () override Returns the number of segments. |
| virtual unsigned int | getNumberOfStructuralGroups () override Returns the number of structural groups. |
| virtual unsigned int | getNumberOfSulfurs () override Returns the number of sulfurs. |
| std::string const & | getStatusBit () const Returns the status bit. |
| int const & | getStructuralID () const Returns the structural group's id. |
| virtual int | getSumOfFormalCharges () override Returns the sum of formal charges. |
| virtual float | getSumOfPartialCharges () override Returns the sum of partial charges. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the node type ( SBNode::StructuralGroup ) |
| bool | hasComment () const Returns true when the comment is set. |
| virtual bool | hasNode (SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual bool | hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a selectionPredicate and avisitPredicate , with or without dependencies. |
| bool | hasStatusBit () const Returns true when the status bit is set. |
| bool | hasStructuralID () const Returns true when the structural group's id is set. |
| bool | isMonatomicIon () Returns true if the structural group is a monatomic ion. |
| virtual bool | isSerializable () override const Returns true __ |
| bool | isWater () Returns true if the structural group is a water molecule. |
| virtual void | onBaseEvent (SBEvent * event) Handles base events. |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| virtual bool | removeChild (SBNode * node) override Removes a child from the node. |
| virtual void | serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the node. |
| void | setComment (const std::string & comment) Sets the comment. |
| virtual void | setName (const std::string & name) override Sets the name of the structural group. |
| void | setStatusBit (const std::string & statusBit) Sets the status bit. |
| void | setStructuralID (const int & groupID) Sets the structural group's id. |
| virtual void | unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override Unserializes the node. |
| virtual | ~SBMStructuralModelNodeGroup () Destructor. |
Public Functions inherited from SBMStructuralModelNode#
| Type | Name |
|---|---|
| SB_DECLARE_DATA (SBMStructuralModelNode) |
|
| virtual SBMStructuralModelNode * | clone () override Returns a copy of the node and its descendants. |
| void | connectStructuralSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBStructuralEvent *) functionPointer, SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any, SBCReferenceTarget * nextReferenceTarget=nullptr, void(SBCReferenceTarget::*)(SBStructuralEvent *) nextFunctionPointer=nullptr) Connects the structural signal to a slot. |
| void | disconnectStructuralSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBStructuralEvent *) functionPointer, SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any) Disconnects the structural signal from a slot. |
| virtual void | forEachNodeDepthFirst (void(*)(SBDDataGraphNode *node) action) override Performs the action on this node. |
| virtual void | forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) override Performs the object 'saction on this node. |
| void | forEachStructuralNodeBreadthFirst (void(*)(SBMStructuralModelNode *node) action) Performs the action on this node and all its structural node children in the breadth-first way. |
| void | forEachStructuralNodeBreadthFirst (SBCClass * object, void(SBCClass::*)(SBMStructuralModelNode *node) action) Performs the object 'saction on this node and all its structural node children in the breadth-first way. |
| void | forEachStructuralNodeDepthFirst (void(*)(SBMStructuralModelNode *node) action) Performs the action on this node and all its structural node children in the depth-first way. |
| void | forEachStructuralNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBMStructuralModelNode *node) action) Performs the object 'saction on this node and all its structural node children in the depth-first way. |
| void | getAllStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), breadth-first, bottom-up. |
| void | getAllStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), breadth-first, top-down. |
| void | getAllStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), depth-first. |
| virtual SBPointerList< SBMStructuralModelNode > const * | getChildren () const Returns the list of child nodes. |
| void | getInternalStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with internal structural nodes (the node's structural node children), breadth-first, bottom-up. |
| void | getInternalStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with internal structural nodes (the node's structural node children), breadth-first, top-down. |
| void | getInternalStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with internal structural nodes (the node's structural node children), depth-first. |
| void | getLeafStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), breadth-first, bottom-up. |
| void | getLeafStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), breadth-first, top-down. |
| void | getLeafStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode * > & nodeIndexer) Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), depth-first. |
| virtual bool | getLockedFlag () override const Returns the locked flag of the model. |
| SBMStructuralModel * | getModel () const Returns a pointer to the structural model this structural node belongs to. |
| SBMStructuralModelNode * | getNextStructuralNode () const Returns the next structural node in the node's parent. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies. |
| virtual unsigned int | getOpacity () override const Returns the opacity. |
| SBMStructuralModelNode * | getPreviousStructuralNode () const Returns the previous structural node in the node's parent. |
| void | getStructuralNodesBreadthFirst (std::vector< SBMStructuralModelNode * > & nodeVectorTopDown, std::vector< SBMStructuralModelNode * > & nodeVectorBottomUp, bool(*)(SBMStructuralModelNode *) selectionRule) Selects some structural nodes, breadth-first, both top-down and bottom-up. |
| void | getStructuralNodesBreadthFirstBottomUp (std::vector< SBMStructuralModelNode * > & nodeIndexer, bool(*)(SBMStructuralModelNode *) selectionRule) Populates nodeIndexer with some structural nodes based on theselectionRule , breadth-first, bottom-up. |
| void | getStructuralNodesBreadthFirstTopDown (std::vector< SBMStructuralModelNode * > & nodeIndexer, bool(*)(SBMStructuralModelNode *) selectionRule) Populates nodeIndexer with some structural nodes based on theselectionRule , breadth-first, top-down. |
| void | getStructuralNodesDepthFirst (std::vector< SBMStructuralModelNode * > & nodeIndexer, bool(*)(SBMStructuralModelNode *) selectionRule) Populates nodeIndexer with some structural nodes based on theselectionRule , depth-first. |
| bool | getStructuralSignalFlag () const Returns true when the node can send structural signals. |
| virtual unsigned int | getTransparency () override const Returns the transparency. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the node type. |
| virtual bool | hasNode (SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual bool | hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) override const Checks for nodes based on a selectionPredicate and avisitPredicate , with or without dependencies. |
| virtual bool | isLocked () override const Returns whether the node is locked (because of the model) |
| virtual bool | isSerializable () override const Returns true __ |
| virtual void | print (unsigned int offset=0) override const Prints debugging information. |
| virtual void | serialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override const Serializes the node. |
| void | setStructuralSignalFlag (bool structuralSignalFlag) Sets whether the node can send structural signals. |
| bool | structuralSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBStructuralEvent *) functionPointer, SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any) const Returns true if and only if the structural signal is connected to a given slot. |
| virtual void | unserialize (SBCSerializer * serializer, const SBNodeIndexer & nodeIndexer, const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber & classVersionNumber=SBVersionNumber(1, 0, 0)) override Unserializes the node. |
| virtual | ~SBMStructuralModelNode () Destructor. |
Public Functions inherited from SBMModelNode#
See SBMModelNode
| Type | Name |
|---|---|
| SB_DECLARE_DATA (SBMModelNode) |
|
| virtual SBMModelNode * | clone () override Returns a copy of the node and its descendants. |
| virtual SBDDataGraphNode::Type | getType () override const Returns the type of the data graph node. |
| virtual bool | isSerializable () override 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)) override 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)) override Unserializes the node. |
Public Functions inherited from SBDDataGraphNode#
See SBDDataGraphNode
| Type | Name |
|---|---|
| virtual bool | addChild (SBDDataGraphNode * node, SBDDataGraphNode * nextNode=nullptr) Adds a child to the node. |
| bool | addMaterial (SBDDataGraphNodeMaterial * material) Adds a material. |
| bool | baseSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) const Returns true when the base signal is connected to a slot. |
| virtual bool | canAddChild (const SBDDataGraphNode * node, const SBDDataGraphNode * nextNode=nullptr) const Returns whether this node can add node as a child. |
| virtual bool | canAddChildType (SBDDataGraphNode::Type nodeType) const Returns whether this node can add a node with type nodeType as a child. |
| bool | canAddMaterial () const Returns whether can add a material to the node based on its type. |
| virtual bool | canHaveDescendantType (SBDDataGraphNode::Type nodeType) const Returns whether this node can have a node with type nodeType as a descendant. |
| virtual SBDDataGraphNode * | clone () Returns a copy of the node and its descendants. |
| void | connectBaseSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBBaseEvent *) nextFunctionPointer=0) Connects the base signal to a slot. |
| unsigned int | countNodes (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies. |
| unsigned int | countNodes (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Counts nodes based on a selectionPredicate and avisitPredicate , with or without dependencies. |
| void | create () Creates the node. |
| bool | descendsFrom (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it. |
| bool | descendsFrom (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them. |
| bool | descendsFrom (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them. |
| void | disconnectBaseSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBBaseEvent *) functionPointer) Disconnects the base signal from a slot. |
| virtual void | display (RenderingPass renderingPass) Displays the node. |
| virtual void | display () Displays the node (deprecated) |
| virtual void | displayForSelection () Displays the node for selection purposes (deprecated) |
| virtual void | displayForShadow () Displays the node for shadowing purposes (deprecated) |
| void | erase () Erases the node. |
| virtual void | forEachNodeDepthFirst (void(*)(SBDDataGraphNode *node) action) Performs the action on this node. |
| virtual void | forEachNodeDepthFirst (SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction on this node. |
| SBDDataGraphNodeData * | getDataPointer () |
| const SBDDataGraphNodeData * | getDataPointer () const |
| unsigned int | getDefaultOpacity () const Returns the default opacity. |
| unsigned int | getDefaultTransparency () const Returns the default transparency. |
| SBDDocument * | getDocument () const Returns the document the node belongs to. |
| virtual unsigned int | getFlags () const Returns the flags. |
| virtual std::string | getHierarchyString (const std::string & separator=" / ", bool includeNodeType=false) const Returns a string with hierarchical information on the node and its parents names. |
| bool | getHighlightingFlag () const Returns the highlighting flag. |
| virtual unsigned int | getInheritedFlags () const Returns the inherited flags. |
| float | getInheritedOpacity () const Returns the cumulative opacity, when taking into account the ascendants. |
| float | getInheritedTransparency () const Returns the cumulative transparency, when taking into account the ascendants. |
| virtual bool | getLockedFlag () const Returns the locked flag. |
| SBDDataGraphNodeMaterial * | getMaterial () const Returns the material. |
| SBDDataGraphNode * | getMaterialOwner () const Returns the node whose material is inherited. |
| unsigned int | getMaximumOpacity () const Returns the maximum opacity. |
| unsigned int | getMaximumTransparency () const Returns the maximum transparency. |
| unsigned int | getMinimumOpacity () const Returns the minimum opacity. |
| unsigned int | getMinimumTransparency () const Returns the minimum transparency. |
| virtual SBQuantity::mass | getMolecularWeight () Returns the molecular weight. |
| virtual std::string const & | getName () const Returns the name of the node. |
| SBDDataGraphNode * | getNextNode () const Returns the pointer to the next node in the children of the node's parent. |
| SBDDataGraphNode * | getNextNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the next node with type nodeType in the children of the node's parent. |
| unsigned int | getNodeIndex () const Returns the node index (unique in the whole data graph, but non-persistent) |
| SBUUID | getNodeUUID () const Returns the node UUID. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual void | getNodes (SBNodeIndexer & nodeIndexer, const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies. |
| virtual unsigned int | getNumberOfAtoms () Returns the number of atoms. |
| virtual unsigned int | getNumberOfCarbons () Returns the number of carbons. |
| virtual unsigned int | getNumberOfChains () Returns the number of chains. |
| virtual unsigned int | getNumberOfCoarseGrainedAtoms () Returns the number of coarse-grained atoms. |
| virtual unsigned int | getNumberOfHydrogens () Returns the number of hydrogens. |
| virtual unsigned int | getNumberOfMolecules () Returns the number of molecules. |
| virtual unsigned int | getNumberOfNitrogens () Returns the number of nitrogens. |
| virtual unsigned int | getNumberOfOtherAtoms () Returns the number of other atoms. |
| virtual unsigned int | getNumberOfOxygens () Returns the number of oxygens. |
| virtual unsigned int | getNumberOfResidues () Returns the number of residues. |
| virtual unsigned int | getNumberOfSegments () Returns the number of segments. |
| virtual unsigned int | getNumberOfStructuralGroups () Returns the number of structural groups. |
| virtual unsigned int | getNumberOfStructuralModels () Returns the number of structural models. |
| virtual unsigned int | getNumberOfSulfurs () Returns the number of sulfurs. |
| virtual unsigned int | getOpacity () const Returns the opacity. |
| unsigned int | getOpacitySingleStep () const Returns the opacity single step. |
| std::string | getOpacitySuffix () const Returns the opacity suffix. |
| SBDDataGraphNode * | getParent () const Returns the parent of the node. |
| SBDDataGraphNode * | getPreviousNode () const Returns the pointer to the previous node in the children of the node's parent. |
| SBDDataGraphNode * | getPreviousNode (SBDDataGraphNode::Type nodeType) const Returns the pointer to the previous node with type nodeType in the children of the node's parent. |
| SBDDataGraphNode * | getRoot () const Returns the root of the hierarchy the node belongs to. |
| bool | getSelected () const Returns whether the node is selected. |
| bool | getSelectionFlag () const Returns the selection flag. |
| virtual int | getSumOfFormalCharges () Returns the sum of formal charges. |
| virtual float | getSumOfPartialCharges () Returns the sum of partial charges. |
| SBDDataGraphNode * | getThisNode () const Returns the pointer to this node. |
| virtual unsigned int | getTransparency () const Returns the transparency. |
| unsigned int | getTransparencySingleStep () const Returns the transparency single step. |
| std::string | getTransparencySuffix () const Returns the transparency suffix. |
| virtual Type | getType () const Returns the type of the data graph node. |
| std::string | getTypeString (bool humanReadable=false) const Returns a string describing the type of the data graph node. |
| bool | getVisibilityFlag () const Returns the visibility flag. |
| bool | getVisible () const Returns whether the node is visible. |
| bool | hasMaterial () const Returns whether the node has a material (by itself, or inherited) |
| virtual bool | hasNode (SBDDataGraphNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies. |
| virtual bool | hasNode (const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(), const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const Returns whether the node has nodes based on a selectionPredicate and avisitPredicate , with or without dependencies. |
| bool | hasOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or is the ancestor of one of them, or is a group that stores one of them. |
| bool | hasOpacityRange () const Returns whether the node has the opacity range. |
| bool | hasTransparencyRange () const Returns whether the node has the transparency range. |
| bool | isAtom () const Returns true when the node is an atom. |
| bool | isBallAndStick () const Returns true when the node is the default ball-and-stick visual model. |
| bool | isBond () const Returns true when the node is a bond. |
| bool | isCartoon () const Returns true when the node is the default cartoon visual model. |
| bool | isCreated () const Returns true if and only if the node is created. |
| bool | isDynamicalModel () const Returns true when the node is a dynamical model. |
| bool | isErased () const Returns true if and only if the node is erased. |
| bool | isGaussianSurface () const Returns true when the node is the default Gaussian surface visual model. |
| bool | isHighlighted () const Returns whether the node is highlighted. |
| bool | isIn (const SBDDataGraphNode * node) const Returns true if and only if this node isnode , or descends from it, or belongs to a group stored innode . |
| bool | isIn (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer , or descends from one of them, or belongs to a group stored in one of the nodes of thenodeIndexer . |
| bool | isIn (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer , or descends from one of them, or belongs to a group stored in of the nodes of thenodePointerIndexer . |
| bool | isInteractionModel () const Returns true when the node is a interaction model. |
| bool | isLicorice () const Returns true when the node is the default licorice visual model. |
| bool | isLight () const Returns true when the node is a light. |
| virtual bool | isLocked () const Returns whether the node is locked. |
| bool | isMesh () const Returns true when the node is a mesh. |
| bool | isModel () const Returns true when the node is a model. |
| bool | isOneOf (const SBNodeIndexer & nodeIndexer) const Returns true if and only if this node is one of the nodes of thenodeIndexer . |
| bool | isOneOf (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns true if and only if this node is one of the nodes of thenodePointerIndexer . |
| bool | isPropertyModel () const Returns true when the node is a property model. |
| bool | isRibbon () const Returns true when the node is the default ribbon visual model. |
| bool | isSelected () const Returns whether the node is selected. |
| virtual bool | isSerializable () const Returns true when the class is serializable. |
| bool | isSimulator () const Returns true when the node is a simulator. |
| bool | isSolventAccessibleSurface () const Returns true when the node is the default solvent accessible surface visual model. |
| bool | isSolventExcludedSurface () const Returns true when the node is the default solvent excluded surface visual model. |
| bool | isStructuralModel () const Returns true when the node is a structural model. |
| bool | isStructuralNode () const Returns true when the node is a structural node. |
| bool | isTube () const Returns true when the node is the default tube visual model. |
| bool | isType (Type type) const Returns true when the type of the node corresponds totype . |
| bool | isVanDerWaals () const Returns true when the node is the default van der Waals visual model. |
| bool | isVisible () const Returns whether the node is visible. |
| bool | isVisualModel () const Returns true when the node is a visual model. |
| bool | ownsMaterial () const Returns whether the node owns a material. |
| virtual void | print (unsigned int offset=0) const Prints some debugging information. |
| virtual bool | removeChild (SBDDataGraphNode * node) Removes a child from the node. |
| bool | removeMaterial () Removes the material. |
| void | removeMaterialsFromDescendants () Removes materials from all nodes that descend from this node, but it does not remove the material from the node itself. |
| 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. |
| void | setHighlightingFlag (bool flag) Sets the highlighting flag. |
| virtual void | setLockedFlag (bool flag) Sets the locked flag. |
| virtual void | setName (const std::string & name) Sets the name of the node. |
| virtual void | setOpacity (unsigned int opacity) Sets the opacity. |
| void | setSelectionFlag (bool flag) Sets the selection flag. |
| virtual void | setTransparency (unsigned int transparency) Sets the transparency. |
| void | setVisibilityFlag (bool flag) Sets the visibility flag. |
| 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. |
Public Functions inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTarget () Builds the reference target. |
|
| unsigned int | getMemoryFootprint () const Returns the memory footprint. |
| void | printReferencesToOwners () const Prints the references to the owners of this reference target. |
| virtual | ~SBCReferenceTarget () Destructor. |
Public Static Functions inherited from SBMStructuralModelNode#
| Type | Name |
|---|---|
| void | forEachStructuralNodeInSelection (std::vector< SBMStructuralModelNode * > & selection, void(*)(SBMStructuralModelNode *node) action) Performs the action on nodes in theselection __ |
| void | forEachStructuralNodeInSelection (std::vector< SBMStructuralModelNode * > & selection, SBCClass * object, void(SBCClass::*)(SBMStructuralModelNode *node) action) Performs the object 'saction on nodes in theselection __ |
Public Static Functions inherited from SBDDataGraphNode#
See SBDDataGraphNode
| Type | Name |
|---|---|
| bool | canAddMaterial (SBDDataGraphNode::Type nodeType) Returns whether can add a material to a node of type nodeType . |
| void | clone (const SBNodeIndexer & sourceNodeIndexer, SBNodeIndexer & destinationNodeIndexer) Clones the nodes in sourceNodeIndexer (treated as a whole) and places the clones indestinationNodeIndexer . |
| void | forEachNodeInSelection (SBNodeIndexer & nodeIndexer, void(*)(SBDDataGraphNode *node) action) Performs the action for each node innodeIndexer __ |
| void | forEachNodeInSelection (SBNodeIndexer & nodeIndexer, SBCClass * object, void(SBCClass::*)(SBDDataGraphNode *node) action) Performs the objects 'saction for each node innodeIndexer __ |
| SBDDataGraphNode * | getNode (unsigned int nodeIndex) Returns the unique node corresponding to the node index nodeIndex . |
| std::string | getTypeString (Type type, bool humanReadable=false) Returns a string describing the type of the data graph node. |
Protected Attributes inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTargetData * | dataPointer A pointer to the private data. |
Protected Functions inherited from SBMStructuralModelNodeGroup#
See SBMStructuralModelNodeGroup
| Type | Name |
|---|---|
| SBMStructuralModelNodeGroup (SBMStructuralModelNodeGroupData * dataPointer) Builds a base object. |
Protected Functions inherited from SBMStructuralModelNode#
| Type | Name |
|---|---|
| SBMStructuralModelNode () Builds a structural model node. |
|
| SBMStructuralModelNode (SBMStructuralModelNodeData * dataPointer) Builds a structural model node. |
Protected Functions inherited from SBMModelNode#
See SBMModelNode
| Type | Name |
|---|---|
| SBMModelNode () Builds a base object. |
|
| SBMModelNode (SBMModelNodeData * dataPointer) Builds a base object. |
|
| virtual | ~SBMModelNode () Destructor. |
Protected Functions inherited from SBDDataGraphNode#
See SBDDataGraphNode
| Type | Name |
|---|---|
| SBDDataGraphNode () Builds a data graph node. |
|
| SBDDataGraphNode (SBDDataGraphNodeData * dataPointer) Builds a data graph node. |
|
| virtual | ~SBDDataGraphNode () Destroys the node. |
Protected Functions inherited from SBCReferenceTarget#
| Type | Name |
|---|---|
| SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor. |
|
| void | removeAllReferenceOwners () Stops all the reference owners from referencing this reference target. |
Detailed Description#
Short name: SBMolecule
Public Functions Documentation#
function SBMStructuralModelNodeMolecule [1/2]#
Builds a molecule.
Builds a base model.
function SBMStructuralModelNodeMolecule [2/2]#
Builds a molecule with the given name.
function canAddChildType#
Returns whether this node can add a node with type nodeType as a child.
virtual bool SBMStructuralModelNodeMolecule::canAddChildType (
SBNode::Type nodeType
) override const
Implements SBMStructuralModelNodeGroup::canAddChildType
function canHaveDescendantType#
Returns whether this node can have a node with type nodeType as a descendant.
virtual bool SBMStructuralModelNodeMolecule::canHaveDescendantType (
SBNode::Type nodeType
) override const
Implements SBMStructuralModelNodeGroup::canHaveDescendantType
function clone#
Returns a copy of the node and its descendants.
Implements SBMStructuralModelNodeGroup::clone
function getType#
Returns the node type (returns SBNode::SideChain )
Implements SBMStructuralModelNodeGroup::getType
function ~SBMStructuralModelNodeMolecule#
Destructor.
Deletes the model.