Class SBMStructuralModelNode

ClassList > SBMStructuralModelNode

This class describes a structural model node. More...

• #include <SBMStructuralModelNode.hpp>

Inherits the following classes: SBMModelNode

Inherited by the following classes: SBMStructuralModelNodeAtom, SBMStructuralModelNodeBond, 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
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
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
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCClassProxy *, GetProxy)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, This)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetParent)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetThis)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetNextNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetPreviousNode)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDocument *, GetDocument)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode *, GetRoot)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetNodeIndex)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBDDataGraphNode::Type, GetType)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetSelectionFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetLockedFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetVisibilityFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, bool, GetHighlightingFlag)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, unsigned int, GetFlags)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetName)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetClass)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, std::string, GetElement)
	SB_NODE_GETTER_0 (SB_SBDDATAGRAPH_EXPORT, SBCContainerUUID, GetElementUUID)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, All)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, None)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsAtom)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBond)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralNode)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsStructuralModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisualModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsMesh)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLight)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsInteractionModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsDynamicalModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsPropertyModel)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSimulator)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsBallAndStick)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLicorice)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVanDerWaals)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCartoon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsRibbon)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsTube)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsGaussianSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventAccessibleSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSolventExcludedSurface)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, HasMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, OwnsMaterial)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsLocked)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSerializable)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsCreated)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsErased)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsSelected)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsVisible)
	SB_NODE_PREDICATE_0 (SB_SBDDATAGRAPH_EXPORT, IsHighlighted)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, IsType, SBDDataGraphNode::Type)
	SB_NODE_PREDICATE_1 (SB_SBDDATAGRAPH_EXPORT, HasOneOf, SBNodeIndexer)
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.
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

See 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

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

See SBCReferenceTarget

Type	Name
SBCReferenceTargetData *	dataPointer A pointer to the private data.

Protected Functions

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

See SBCReferenceTarget

Type	Name
	SBCReferenceTarget (SBCReferenceTargetData * dataPointer) Protected constructor.
void	removeAllReferenceOwners () Stops all the reference owners from referencing this reference target.

Detailed Description

Short name: SBStructuralNode

Public Functions Documentation

function clone

Returns a copy of the node and its descendants.

virtual SBMStructuralModelNode * SBMStructuralModelNode::clone () override

Creates a copy of this node and its descendant nodes.

Returns:

Pointer to the newly cloned structural model node.

Implements SBMModelNode::clone

---

function connectStructuralSignalToSlot

Connects the structural signal to a slot.

void SBMStructuralModelNode::connectStructuralSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBStructuralEvent *) functionPointer,
    SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any,
    SBCReferenceTarget * nextReferenceTarget=nullptr,
    void(SBCReferenceTarget::*)( SBStructuralEvent *) nextFunctionPointer=nullptr
) 

Connects a structural signal from this node to a slot on a target object.

Parameters:

• referenceTarget Pointer to the target object whose slot will be connected.
• functionPointer Pointer to the member function of the target to be called when the signal is emitted.
• eventType Type of the structural event that triggers the signal. Use SBStructuralEvent::Type::Any for any event.
• nextReferenceTarget Optional pointer to a second target for chained slot connections.
• nextFunctionPointer Optional pointer to a member function of the second target for chained connections.

---

function disconnectStructuralSignalFromSlot

Disconnects the structural signal from a slot.

void SBMStructuralModelNode::disconnectStructuralSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBStructuralEvent *) functionPointer,
    SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any
) 

Disconnects a structural signal from a slot on a target object.

Parameters:

• referenceTarget Pointer to the target object whose slot will be disconnected.
• functionPointer Pointer to the member function of the target to disconnect.
• eventType Type of the structural event associated with the signal.

---

function forEachNodeDepthFirst [1/2]

Performs the action on this node.

virtual void SBMStructuralModelNode::forEachNodeDepthFirst (
    void(*)( SBDDataGraphNode *node) action
) override

Executes the given action on this node.

Parameters:

• action Function pointer to be called with this node as argument.

Implements SBDDataGraphNode::forEachNodeDepthFirst

---

function forEachNodeDepthFirst [2/2]

Performs the object 'saction on this node.

virtual void SBMStructuralModelNode::forEachNodeDepthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBDDataGraphNode *node) action
) override

Executes the given member function on this node.

Parameters:

• object Pointer to the object whose member function will be invoked.
• action Member function pointer to be called with this node as argument.

Implements SBDDataGraphNode::forEachNodeDepthFirst

---

function forEachStructuralNodeBreadthFirst [1/2]

Performs the action on this node and all its structural node children in the breadth-first way.

void SBMStructuralModelNode::forEachStructuralNodeBreadthFirst (
    void(*)( SBMStructuralModelNode *node) action
) 

Applies a user‑provided function to each structural node in breadth‑first order.

Traverses the node hierarchy using a breadth‑first strategy, invoking action for each visited node.

Parameters:

• action Function pointer to be called for each node.

---

function forEachStructuralNodeBreadthFirst [2/2]

Performs the object 'saction on this node and all its structural node children in the breadth-first way.

void SBMStructuralModelNode::forEachStructuralNodeBreadthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBMStructuralModelNode *node) action
) 

Applies a member function to each structural node in breadth‑first order using a given object.

Traverses the hierarchy and invokes the member function action on object for each node.

Parameters:

• object Pointer to the object whose member function will be called.
• action Pointer to a member function of SBCClass that takes a SBMStructuralModelNode*.

---

function forEachStructuralNodeDepthFirst [1/2]

Performs the action on this node and all its structural node children in the depth-first way.

void SBMStructuralModelNode::forEachStructuralNodeDepthFirst (
    void(*)( SBMStructuralModelNode *node) action
) 

Applies a user‑provided function to each structural node in depth‑first order.

Traverses the node hierarchy using a depth‑first strategy, invoking action for each visited node.

Parameters:

• action Function pointer to be called for each node.

---

function forEachStructuralNodeDepthFirst [2/2]

Performs the object 'saction on this node and all its structural node children in the depth-first way.

void SBMStructuralModelNode::forEachStructuralNodeDepthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBMStructuralModelNode *node) action
) 

Applies a member function to each structural node in depth‑first order using a given object.

Traverses the hierarchy and invokes the member function action on object for each node.

Parameters:

• object Pointer to the object whose member function will be called.
• action Pointer to a member function of SBCClass that takes a SBMStructuralModelNode*.

---

function getAllStructuralNodesBreadthFirstBottomUp

Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), breadth-first, bottom-up.

void SBMStructuralModelNode::getAllStructuralNodesBreadthFirstBottomUp (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with all structural nodes (the node itself and all its structural node children) using a breadth-first, bottom-up traversal.

Parameters:

• selection Vector to be filled with pointers to structural nodes in bottom-up order.

---

function getAllStructuralNodesBreadthFirstTopDown

Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), breadth-first, top-down.

void SBMStructuralModelNode::getAllStructuralNodesBreadthFirstTopDown (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with all structural nodes (the node itself and all its structural node children) using a breadth-first, top-down traversal.

Parameters:

• selection Vector to be filled with pointers to structural nodes in traversal order.

---

function getAllStructuralNodesDepthFirst

Populates nodeIndexer with all structural nodes (the node itself and all its structural node children), depth-first.

void SBMStructuralModelNode::getAllStructuralNodesDepthFirst (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with all structural nodes using a depth-first traversal.

Parameters:

• selection Vector to be filled with pointers to structural nodes in depth-first order.

---

function getChildren

Returns the list of child nodes.

virtual SBPointerList< SBMStructuralModelNode > const * SBMStructuralModelNode::getChildren () const

Returns the list of child structural model nodes.

Returns:

Pointer to the constant list of child nodes, or nullptr if none.

---

function getInternalStructuralNodesBreadthFirstBottomUp

Populates nodeIndexer with internal structural nodes (the node's structural node children), breadth-first, bottom-up.

void SBMStructuralModelNode::getInternalStructuralNodesBreadthFirstBottomUp (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with internal structural nodes using a breadth-first, bottom-up traversal.

Parameters:

• selection Vector to be filled with pointers to internal structural nodes.

---

function getInternalStructuralNodesBreadthFirstTopDown

Populates nodeIndexer with internal structural nodes (the node's structural node children), breadth-first, top-down.

void SBMStructuralModelNode::getInternalStructuralNodesBreadthFirstTopDown (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with internal structural nodes (the node's structural node children) using a breadth-first, top-down traversal.

Parameters:

• selection Vector to be filled with pointers to internal structural nodes.

---

function getInternalStructuralNodesDepthFirst

Populates nodeIndexer with internal structural nodes (the node's structural node children), depth-first.

void SBMStructuralModelNode::getInternalStructuralNodesDepthFirst (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with internal structural nodes using a depth-first traversal.

Parameters:

• selection Vector to be filled with pointers to internal structural nodes.

---

function getLeafStructuralNodesBreadthFirstBottomUp

Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), breadth-first, bottom-up.

void SBMStructuralModelNode::getLeafStructuralNodesBreadthFirstBottomUp (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with leaf structural nodes using a breadth-first, bottom-up traversal.

Parameters:

• selection Vector to be filled with pointers to leaf structural nodes.

---

function getLeafStructuralNodesBreadthFirstTopDown

Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), breadth-first, top-down.

void SBMStructuralModelNode::getLeafStructuralNodesBreadthFirstTopDown (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with leaf structural nodes (nodes with no children) using a breadth-first, top-down traversal.

Parameters:

• selection Vector to be filled with pointers to leaf structural nodes.

---

function getLeafStructuralNodesDepthFirst

Populates nodeIndexer with leaf structural nodes (i.e., only with the nodes that have no shildren), depth-first.

void SBMStructuralModelNode::getLeafStructuralNodesDepthFirst (
    std::vector< SBMStructuralModelNode * > & nodeIndexer
) 

Populates selection with leaf structural nodes using a depth-first traversal.

Parameters:

• selection Vector to be filled with pointers to leaf structural nodes.

---

function getLockedFlag

Returns the locked flag of the model.

virtual bool SBMStructuralModelNode::getLockedFlag () override const

Retrieves the locked flag from the node's model.

Returns:

true if the model's locked flag is set, otherwise false.

Implements SBDDataGraphNode::getLockedFlag

---

function getModel

Returns a pointer to the structural model this structural node belongs to.

SBMStructuralModel * SBMStructuralModelNode::getModel () const

Retrieves the associated structural model of the node.

Returns:

Pointer to the SBMStructuralModel the node belongs to, or nullptr if none.

---

function getNextStructuralNode

Returns the next structural node in the node's parent.

SBMStructuralModelNode * SBMStructuralModelNode::getNextStructuralNode () const

Returns:

Pointer to the next structural node, or nullptr if there is none.

---

function getNodes [1/2]

Collects nodes into nodeIndexer , based on anodeType , a selection status and avisitPredicate , with or without dependencies.

virtual void SBMStructuralModelNode::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 node type, selection status, and a visit predicate.

Parameters:

• nodeIndexer Vector that will receive pointers to matching nodes.
• nodeType The type of nodes to collect.
• selectedNodesOnly If true, only selected nodes are collected.
• visitPredicate Predicate used to filter nodes during traversal.
• includeDependencies Reserved for future use; not used in this implementation.

Implements SBDDataGraphNode::getNodes

---

function getNodes [2/2]

Collects nodes into nodeIndexer , based on aselectionPredicate and avisitPredicate , with or without dependencies.

virtual void SBMStructuralModelNode::getNodes (
    SBNodeIndexer & nodeIndexer,
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Collects nodes into nodeIndexer based on a selection predicate and a visit predicate.

Parameters:

• nodeIndexer Vector that will receive pointers to matching nodes.
• selectionPredicate Predicate that determines if a node should be selected.
• visitPredicate Predicate used to filter nodes during traversal.
• includeDependencies Reserved for future use; not used in this implementation.

Implements SBDDataGraphNode::getNodes

---

function getOpacity

Returns the opacity.

virtual unsigned int SBMStructuralModelNode::getOpacity () override const

Returns the opacity value of the node's model.

Returns:

Opacity as an unsigned integer (0-100). Returns 100 if no model is associated.

Implements SBDDataGraphNode::getOpacity

---

function getPreviousStructuralNode

Returns the previous structural node in the node's parent.

SBMStructuralModelNode * SBMStructuralModelNode::getPreviousStructuralNode () const

Returns:

Pointer to the previous structural node, or nullptr if there is none.

---

function getStructuralNodesBreadthFirst

Selects some structural nodes, breadth-first, both top-down and bottom-up.

void SBMStructuralModelNode::getStructuralNodesBreadthFirst (
    std::vector< SBMStructuralModelNode * > & nodeVectorTopDown,
    std::vector< SBMStructuralModelNode * > & nodeVectorBottomUp,
    bool(*)( SBMStructuralModelNode *) selectionRule
) 

Collects structural nodes using a breadth‑first traversal and a selection rule.

This function traverses the hierarchy starting from this node, selects nodes for which selectionRule returns true, and stores them in selectionTopDown in top‑down order. It also fills selectionBottomUp with the selected nodes in reverse order (bottom‑up).

Parameters:

• selectionTopDown Vector to receive the selected nodes in top‑down order.
• selectionBottomUp Vector to receive the selected nodes in bottom‑up order.
• selectionRule Function pointer that determines whether a node should be selected.

---

function getStructuralNodesBreadthFirstBottomUp

Populates nodeIndexer with some structural nodes based on theselectionRule , breadth-first, bottom-up.

void SBMStructuralModelNode::getStructuralNodesBreadthFirstBottomUp (
    std::vector< SBMStructuralModelNode * > & nodeIndexer,
    bool(*)( SBMStructuralModelNode *) selectionRule
) 

Populates selection with structural nodes that satisfy a selection rule, using a breadth-first, bottom-up traversal.

Parameters:

• selection Vector to be filled with pointers to selected structural nodes.
• selectionRule Function pointer that returns true for nodes to be included.

---

function getStructuralNodesBreadthFirstTopDown

Populates nodeIndexer with some structural nodes based on theselectionRule , breadth-first, top-down.

void SBMStructuralModelNode::getStructuralNodesBreadthFirstTopDown (
    std::vector< SBMStructuralModelNode * > & nodeIndexer,
    bool(*)( SBMStructuralModelNode *) selectionRule
) 

Populates selection with structural nodes that satisfy a selection rule, using a breadth-first, top-down traversal.

Parameters:

• selection Vector to be filled with pointers to selected structural nodes.
• selectionRule Function pointer that returns true for nodes to be included.

---

function getStructuralNodesDepthFirst

Populates nodeIndexer with some structural nodes based on theselectionRule , depth-first.

void SBMStructuralModelNode::getStructuralNodesDepthFirst (
    std::vector< SBMStructuralModelNode * > & nodeIndexer,
    bool(*)( SBMStructuralModelNode *) selectionRule
) 

Populates selection with structural nodes that satisfy a selection rule, using a depth-first traversal.

Parameters:

• selection Vector to be filled with pointers to selected structural nodes.
• selectionRule Function pointer that returns true for nodes to be included.

---

function getStructuralSignalFlag

Returns true when the node can send structural signals.

bool SBMStructuralModelNode::getStructuralSignalFlag () const

Returns whether the node can send structural signals.

Returns:

true if the structural signal flag is set.

---

function getTransparency

Returns the transparency.

virtual unsigned int SBMStructuralModelNode::getTransparency () override const

Returns the transparency value of the node's model.

Returns:

Transparency as an unsigned integer (0-100). Returns 0 if no model is associated.

Implements SBDDataGraphNode::getTransparency

---

function getType

Returns the node type.

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

Returns the type identifier of the node.

Returns:

The node type, SBDDataGraphNode::StructuralModelNode.

Implements SBMModelNode::getType

---

function hasNode [1/2]

Checks for nodes based on a nodeType , a selection status and avisitPredicate , with or without dependencies.

virtual bool SBMStructuralModelNode::hasNode (
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks whether a node of the given type exists, optionally filtered by selection status and a visit predicate.

Parameters:

• nodeType The type of node to check for.
• selectedNodesOnly If true, only selected nodes are considered.
• visitPredicate Predicate used to filter nodes during traversal.
• includeDependencies Reserved for future use; not used in this implementation.

Returns:

true if a matching node exists; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function hasNode [2/2]

Checks for nodes based on a selectionPredicate and avisitPredicate , with or without dependencies.

virtual bool SBMStructuralModelNode::hasNode (
    const SBNodePredicate & selectionPredicate=SBDDataGraphNode::All(),
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Checks whether any node satisfies the given selection predicate, optionally filtered by a visit predicate.

Parameters:

• selectionPredicate Predicate that determines if a node matches the selection criteria.
• visitPredicate Predicate used to filter nodes during traversal.
• includeDependencies Reserved for future use; not used in this implementation.

Returns:

true if a matching node exists; otherwise false.

Implements SBDDataGraphNode::hasNode

---

function isLocked

Returns whether the node is locked (because of the model)

virtual bool SBMStructuralModelNode::isLocked () override const

Checks whether the node is locked due to its model.

Returns:

true if the node's model is locked, otherwise false.

Implements SBDDataGraphNode::isLocked

---

function isSerializable

Returns true __

virtual bool SBMStructuralModelNode::isSerializable () override const

Indicates whether the node supports serialization.

Returns:

true if the node can be serialized.

Implements SBMModelNode::isSerializable

---

function print

Prints debugging information.

virtual void SBMStructuralModelNode::print (
    unsigned int offset=0
) override const

Prints debugging information for the node.

Outputs information about this node, using offset for indentation.

Parameters:

• offset Number of indentation spaces (or levels) to prepend to the output.

Implements SBDDataGraphNode::print

---

function serialize

Serializes the node.

virtual void SBMStructuralModelNode::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 to a serializer.

Parameters:

• serializer Pointer to the serializer to write data to.
• nodeIndexer Indexer for node identification.
• sdkVersionNumber Version of the SDK used for serialization.
• classVersionNumber Version of the class used for serialization.

Implements SBMModelNode::serialize

---

function setStructuralSignalFlag

Sets whether the node can send structural signals.

void SBMStructuralModelNode::setStructuralSignalFlag (
    bool structuralSignalFlag
) 

Sets the structural signal flag for the node.

Parameters:

• structuralSignalFlag true to enable structural signals, false to disable.

---

function structuralSignalIsConnectedToSlot

Returns true if and only if the structural signal is connected to a given slot.

bool SBMStructuralModelNode::structuralSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBStructuralEvent *) functionPointer,
    SBStructuralEvent::Type eventType=SBStructuralEvent::Type::Any
) const

Checks if a structural signal is connected to a specific slot.

Parameters:

• referenceTarget Pointer to the target object.
• functionPointer Pointer to the member function of the target that would be called.
• eventType Type of the structural event.

Returns:

true if the specified signal-slot connection exists, otherwise false.

---

function unserialize

Unserializes the node.

virtual void SBMStructuralModelNode::unserialize (
    SBCSerializer * serializer,
    const SBNodeIndexer & nodeIndexer,
    const SBVersionNumber & sdkVersionNumber=SB_SDK_VERSION_NUMBER,
    const SBVersionNumber & classVersionNumber=SBVersionNumber (1, 0, 0)
) override

Unserializes the node from a serializer.

Parameters:

• serializer Pointer to the serializer to read data from.
• nodeIndexer Indexer for node identification.
• sdkVersionNumber Version of the SDK used for deserialization.
• classVersionNumber Version of the class used for deserialization.

Implements SBMModelNode::unserialize

---

function ~SBMStructuralModelNode

Destructor.

virtual SBMStructuralModelNode::~SBMStructuralModelNode () 

Destroys the SBMStructuralModelNode.

---

Public Static Functions Documentation

function forEachStructuralNodeInSelection [1/2]

Performs the action on nodes in theselection __

static void SBMStructuralModelNode::forEachStructuralNodeInSelection (
    std::vector< SBMStructuralModelNode * > & selection,
    void(*)( SBMStructuralModelNode *node) action
) 

Applies a user‑provided function to each node in a selection vector.

Calls action for each node in the provided selection vector in order.

Parameters:

• selection Vector of structural model nodes to process.
• action Function pointer to be called for each node.

---

function forEachStructuralNodeInSelection [2/2]

Performs the object 'saction on nodes in theselection __

static void SBMStructuralModelNode::forEachStructuralNodeInSelection (
    std::vector< SBMStructuralModelNode * > & selection,
    SBCClass * object,
    void(SBCClass::*)( SBMStructuralModelNode *node) action
) 

Applies a member function to each node in a selection vector using a given object.

Calls the member function action on object for each node in the selection vector.

Parameters:

• selection Vector of structural model nodes to process.
• object Pointer to the object whose member function will be called.
• action Pointer to a member function of SBCClass that takes a SBMStructuralModelNode*.

---

Protected Functions Documentation

function SBMStructuralModelNode [1/2]

Builds a structural model node.

SBMStructuralModelNode::SBMStructuralModelNode () 

Constructs a SBMStructuralModelNode with a newly allocated data object.

---

function SBMStructuralModelNode [2/2]

Builds a structural model node.

SBMStructuralModelNode::SBMStructuralModelNode (
    SBMStructuralModelNodeData * dataPointer
) 

Constructs a SBMStructuralModelNode using an existing data pointer.

Parameters:

• dataPointer Pointer to an existing SBMStructuralModelNodeData.

---