Class SBMDynamicalModelNode#

ClassList > SBMDynamicalModelNode

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

#include <SBMDynamicalModelNode.hpp>

Inherits the following classes: SBMModelNode

Inherited by the following classes: SBMDynamicalModelNodeArticulatedBody, SBMDynamicalModelNodeGroup, SBMDynamicalModelNodeParticle, SBMDynamicalModelNodeRigidBody

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 SBMDynamicalModelNode *	clone () override Returns a copy of the node and its descendants.
void	connectDynamicalSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::)(SBMDynamicalModelEvent* ) functionPointer, SBCReferenceTarget* * nextReferenceTarget=0, void(SBCReferenceTarget::)(SBMDynamicalModelEvent* ) nextFunctionPointer=0) Connects the dynamical signal to a slot.*
void	disconnectDynamicalSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::)(SBMDynamicalModelEvent* ) functionPointer) Disconnects the dynamical signal from a slot.*
bool	dynamicalSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::)(SBMDynamicalModelEvent* ) functionPointer) const Returns* `true` if and only if the dynamical signal is connected to a given slot.
void	forEachDynamicalNodeBreadthFirst (void()(SBMDynamicalModelNode* node) action) Performs the* `action` on each node, breadth-first.
void	forEachDynamicalNodeBreadthFirst (SBCClass * object, void(SBCClass::)(SBMDynamicalModelNode* node) action) Performs the* `object` 's`action` on each node, breadth-first.
void	forEachDynamicalNodeDepthFirst (void()(SBMDynamicalModelNode* node) action) Performs the* `action` on each node, depth-first.
void	forEachDynamicalNodeDepthFirst (SBCClass * object, void(SBCClass::)(SBMDynamicalModelNode* node) action) Performs the* `object` 's`action` on each node, depth-first.
virtual void	forEachNodeDepthFirst (void()(SBDDataGraphNode* node) action) override Performs the* `action` on each node of this dynamical model node (the dynamical model node itself and its children), depth-first.
virtual void	forEachNodeDepthFirst (SBCClass * object, void(SBCClass::)(SBDDataGraphNode* node) action) override Performs the* `object` 's`action` on each node of this dynamical model node (the dynamical model node itself and its children), depth-first.
virtual SBPointerList< SBMDynamicalModelNode > const *	getChildren () const Returns the list of child nodes.
SBMDynamicalModel *	getModel () const Returns the model which owns the node.
SBMDynamicalModelNode *	getNextDynamicalNode () const Returns the next dynamical node in the 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 a`nodeType` , a selection status and a`visitPredicate` , 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 a`selectionPredicate` and a`visitPredicate` , with or without dependencies.
SBMDynamicalModelNode *	getPreviousDynamicalNode () const Returns the previous dynamical node in the parent.
virtual SBDDataGraphNode::Type	getType () override const Returns the type of the data graph node.
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 a`visitPredicate` , 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 a`visitPredicate` , with or without dependencies.
virtual bool	isSerializable () override const Returns `true` when the class is serializable.
virtual void	print (unsigned int offset=0) override const = 0 Prints debugging information.
void	selectAllDynamicalNodesBreadthFirstBottomUp (std::vector< SBMDynamicalModelNode * > & selection) Selects all dynamical nodes, breadth-first, bottom-up.
void	selectAllDynamicalNodesBreadthFirstTopDown (std::vector< SBMDynamicalModelNode * > & selection) Selects all dynamical nodes, breadth-first, top-down.
void	selectAllDynamicalNodesDepthFirst (std::vector< SBMDynamicalModelNode * > & selection) Selects all dynamical nodes, depth-first.
void	selectDynamicalNodesBreadthFirst (std::vector< SBMDynamicalModelNode * > & selectionTopDown, std::vector< SBMDynamicalModelNode * > & selectionBottomUp, bool()(SBMDynamicalModelNode* ) selectionRule) Selects some dynamical nodes, breadth-first, both top-down and bottom-up.*
void	selectDynamicalNodesBreadthFirstBottomUp (std::vector< SBMDynamicalModelNode * > & selection, bool()(SBMDynamicalModelNode* ) selectionRule) Selects some dynamical nodes, breadth-first, bottom-up.*
void	selectDynamicalNodesBreadthFirstTopDown (std::vector< SBMDynamicalModelNode * > & selection, bool()(SBMDynamicalModelNode* ) selectionRule) Selects some dynamical nodes, breadth-first, top-down.*
void	selectDynamicalNodesDepthFirst (std::vector< SBMDynamicalModelNode * > & selection, bool()(SBMDynamicalModelNode* ) selectionRule) Selects some dynamical nodes, depth-first.*
void	selectInternalDynamicalNodesBreadthFirstBottomUp (std::vector< SBMDynamicalModelNode * > & selection) Selects internal dynamical nodes, breadth-first, bottom-up.
void	selectInternalDynamicalNodesBreadthFirstTopDown (std::vector< SBMDynamicalModelNode * > & selection) Selects internal dynamical nodes, breadth-first, top-down.
void	selectInternalDynamicalNodesDepthFirst (std::vector< SBMDynamicalModelNode * > & selection) Selects internal dynamical nodes, depth-first.
void	selectLeafDynamicalNodesBreadthFirstBottomUp (std::vector< SBMDynamicalModelNode * > & selection) Selects leaf dynamical nodes, breadth-first, bottom-up.
void	selectLeafDynamicalNodesBreadthFirstTopDown (std::vector< SBMDynamicalModelNode * > & selection) Selects leaf dynamical nodes, breadth-first, top-down.
void	selectLeafDynamicalNodesDepthFirst (std::vector< SBMDynamicalModelNode * > & selection) Selects leaf dynamical nodes, depth-first.
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.
virtual	~SBMDynamicalModelNode () Deletes the dynamical node.

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 a`visitPredicate` , 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 a`visitPredicate` , with or without dependencies.
void	create () Creates the node.
bool	descendsFrom (const SBDDataGraphNode * node) const Returns `true` if and only if this node is`node` , or descends from it.
bool	descendsFrom (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.
bool	descendsFrom (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns `true` if and only if this node is one of the nodes of the`nodePointerIndexer` , or descends from one of them.
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` 's`action` 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 a`nodeType` , a selection status and a`visitPredicate` , 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 a`selectionPredicate` and a`visitPredicate` , 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 a`visitPredicate` , 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 a`visitPredicate` , with or without dependencies.
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, 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 is`node` , or descends from it, or belongs to a group stored in`node` .
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, or belongs to a group stored in one of the nodes of the`nodeIndexer` .
bool	isIn (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns `true` if and only if this node is one of the nodes of the`nodePointerIndexer` , or descends from one of them, or belongs to a group stored in of the nodes of the`nodePointerIndexer` .
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 the`nodeIndexer` .
bool	isOneOf (SBPointerIndexer< SBDDataGraphNode > * nodePointerIndexer) const Returns `true` if and only if this node is one of the nodes of the`nodePointerIndexer` .
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 to`type` .
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	forEachDynamicalNodeInSelection (std::vector< SBMDynamicalModelNode * > & selection, void()(SBMDynamicalModelNode* node) action) Performs the* `action` on each node in the selection.
void	forEachDynamicalNodeInSelection (std::vector< SBMDynamicalModelNode * > & selection, SBCClass * object, void(SBCClass::)(SBMDynamicalModelNode* node) action) Performs the* `object` 's`action` on each node in the selection.

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 in`destinationNodeIndexer` .
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, void()(SBDDataGraphNode* node) action) Performs the* `action` for each node in`nodeIndexer` __
void	forEachNodeInSelection (SBNodeIndexer & nodeIndexer, SBCClass * object, void(SBCClass::)(SBDDataGraphNode* node) action) Performs the* `objects` 's`action` for each node in`nodeIndexer` __
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
	SBMDynamicalModelNode () Build a dynamical node.
	SBMDynamicalModelNode (SBMDynamicalModelNodeData * dataPointer) Build a dynamical 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: SBDynamicalNode

Public Functions Documentation#

function clone#

Returns a copy of the node and its descendants.

virtual SBMDynamicalModelNode * SBMDynamicalModelNode::clone () override

Creates a copy of this node and its descendants.

Returns:

Pointer to the cloned SBMDynamicalModelNode.

Implements SBMModelNode::clone

function connectDynamicalSignalToSlot#

Connects the dynamical signal to a slot.

void SBMDynamicalModelNode::connectDynamicalSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBMDynamicalModelEvent *) functionPointer,
    SBCReferenceTarget * nextReferenceTarget=0,
    void(SBCReferenceTarget::*)( SBMDynamicalModelEvent *) nextFunctionPointer=0
)

Connects a dynamical signal to a slot.

Establishes a connection between the node's dynamical signal and a member function of a reference target. Optionally, a second slot can be specified for chained connections.

Parameters:

referenceTarget The object whose member function will be connected.
functionPointer Pointer to the member function to be called when the signal is emitted.
nextReferenceTarget Optional second object for a chained connection; may be nullptr.
nextFunctionPointer Optional second member function for a chained connection; may be nullptr.

function disconnectDynamicalSignalFromSlot#

Disconnects the dynamical signal from a slot.

void SBMDynamicalModelNode::disconnectDynamicalSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBMDynamicalModelEvent *) functionPointer
)

Disconnects a dynamical signal from a slot.

Removes the connection between the node's dynamical signal and the specified member function of a reference target.

Parameters:

referenceTarget The object whose slot is to be disconnected.
functionPointer Pointer to the member function to disconnect.

function dynamicalSignalIsConnectedToSlot#

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

bool SBMDynamicalModelNode::dynamicalSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBMDynamicalModelEvent *) functionPointer
) const

Checks whether a dynamical signal is connected to a specific slot.

Determines if the given reference target and member function are currently connected to the node's dynamical signal.

Parameters:

referenceTarget The object to check.
functionPointer The member function pointer to check.

Returns:

true if the slot is connected; otherwise false.

function forEachDynamicalNodeBreadthFirst [1/2]#

Performs the action on each node, breadth-first.

void SBMDynamicalModelNode::forEachDynamicalNodeBreadthFirst (
    void(*)( SBMDynamicalModelNode *node) action
)

Executes a breadth-first traversal of this node and all descendant dynamical nodes, invoking the provided callback for each visited node.

Parameters:

action Callback function that receives a pointer to each visited SBMDynamicalModelNode.

function forEachDynamicalNodeBreadthFirst [2/2]#

Performs the object 'saction on each node, breadth-first.

void SBMDynamicalModelNode::forEachDynamicalNodeBreadthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBMDynamicalModelNode *node) action
)

Executes the given member function for each dynamical node in breadth‑first order.

Parameters:

object Object whose member function will be invoked.
action Member function pointer to be called for each node.

function forEachDynamicalNodeDepthFirst [1/2]#

Performs the action on each node, depth-first.

void SBMDynamicalModelNode::forEachDynamicalNodeDepthFirst (
    void(*)( SBMDynamicalModelNode *node) action
)

Executes the given function for each dynamical node in depth‑first order.

Parameters:

action Function to be called for each node.

function forEachDynamicalNodeDepthFirst [2/2]#

Performs the object 'saction on each node, depth-first.

void SBMDynamicalModelNode::forEachDynamicalNodeDepthFirst (
    SBCClass * object,
    void(SBCClass::*)( SBMDynamicalModelNode *node) action
)

Executes the given member function for each dynamical node in depth‑first order.

Parameters:

object Object whose member function will be invoked.
action Member function pointer to be called for each node.

function forEachNodeDepthFirst [1/2]#

Performs the action on each node of this dynamical model node (the dynamical model node itself and its children), depth-first.

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

Executes a depth-first traversal of this node and all descendant nodes, invoking the provided callback for each visited node.

Parameters:

action Callback function that receives a pointer to each visited SBDDataGraphNode.

Implements SBDDataGraphNode::forEachNodeDepthFirst

function forEachNodeDepthFirst [2/2]#

Performs the object 'saction on each node of this dynamical model node (the dynamical model node itself and its children), depth-first.

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

Executes a depth-first traversal of this node and all descendant nodes, invoking a member function on the given object for each visited node.

Parameters:

object Pointer to the object on which the member function will be called.
action Pointer to the member function to be invoked for each visited SBDDataGraphNode.

Implements SBDDataGraphNode::forEachNodeDepthFirst

function getChildren#

Returns the list of child nodes.

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

Returns:

Pointer to a list of child nodes, or nullptr if there are no children.

function getModel#

Returns the model which owns the node.

SBMDynamicalModel * SBMDynamicalModelNode::getModel () const

Returns the model that owns this node.

Returns:

Pointer to the owning SBMDynamicalModel.

function getNextDynamicalNode#

Returns the next dynamical node in the parent.

SBMDynamicalModelNode * SBMDynamicalModelNode::getNextDynamicalNode () const

Traverses sibling nodes to find the next node of type DynamicalModelNode.

Returns:

Pointer to the next dynamical node, or nullptr if none.

function getNodes [1/2]#

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

virtual void SBMDynamicalModelNode::getNodes (
    SBNodeIndexer & nodeIndexer,
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Collects nodes of a given type into an indexer.

Traverses this node and its descendants, adding nodes that match the specified type to the provided indexer. The collection can be filtered by selection status and a predicate.

Parameters:

nodeIndexer Indexer to receive the collected nodes.
nodeType Type of nodes to collect.
selectedNodesOnly If true, only selected nodes are added.
visitPredicate Predicate that determines whether a node should be visited during traversal.
includeDependencies Unused parameter; present for interface compatibility.

Implements SBDDataGraphNode::getNodes

function getNodes [2/2]#

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

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

Collects nodes that satisfy a selection predicate into an indexer.

Traverses this node and its descendants, adding nodes for which the selection predicate returns true. Traversal can be controlled by a visit predicate.

Parameters:

nodeIndexer Indexer to receive the collected nodes.
selectionPredicate Predicate that determines whether a node should be added to the indexer.
visitPredicate Predicate that determines whether a node should be visited during traversal.
includeDependencies Unused parameter; present for interface compatibility.

Implements SBDDataGraphNode::getNodes

function getPreviousDynamicalNode#

Returns the previous dynamical node in the parent.

SBMDynamicalModelNode * SBMDynamicalModelNode::getPreviousDynamicalNode () const

Traverses sibling nodes to find the previous node of type DynamicalModelNode.

Returns:

Pointer to the previous dynamical node, or nullptr if none.

function getType#

Returns the type of the data graph node.

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

Returns the type of this node.

Returns:

The type identifier for a dynamical model node.

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 SBMDynamicalModelNode::hasNode (
    SBNode::Type nodeType,
    bool selectedNodesOnly=false,
    const SBNodePredicate & visitPredicate=SBDDataGraphNode::All(),
    bool includeDependencies=false
) override const

Determines whether this node or its descendants contain a node of a given type.

Checks for the presence of a node matching the specified type, optionally filtering by selection status and a visit predicate.

Parameters:

nodeType Type of node to search for.
selectedNodesOnly If true, only selected nodes are considered.
visitPredicate Predicate that determines whether a node should be visited during the search.
includeDependencies Unused parameter; present for interface compatibility.

Returns:

true if a matching node is found; otherwise false.

Implements SBDDataGraphNode::hasNode

function hasNode [2/2]#

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

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

Determines whether this node or its descendants satisfy a selection predicate.

Checks if any node in the subtree matches the given selection predicate, optionally constrained by a visit predicate.

Parameters:

selectionPredicate Predicate that determines whether a node satisfies the condition.
visitPredicate Predicate that determines whether a node should be visited during the search.
includeDependencies Unused parameter; present for interface compatibility.

Returns:

true if a matching node is found; otherwise false.

Implements SBDDataGraphNode::hasNode

function isSerializable#

Returns true when the class is serializable.

virtual bool SBMDynamicalModelNode::isSerializable () override const

Returns whether the node is serializable.

Returns:

false indicating the node does not support serialization.

Implements SBMModelNode::isSerializable

function print#

Prints debugging information.

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

Implements SBDDataGraphNode::print

function selectAllDynamicalNodesBreadthFirstBottomUp#

Selects all dynamical nodes, breadth-first, bottom-up.

void SBMDynamicalModelNode::selectAllDynamicalNodesBreadthFirstBottomUp (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects all dynamical nodes using a breadth-first traversal and then reverses the order to provide a bottom-up sequence.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes in bottom-up order.

function selectAllDynamicalNodesBreadthFirstTopDown#

Selects all dynamical nodes, breadth-first, top-down.

void SBMDynamicalModelNode::selectAllDynamicalNodesBreadthFirstTopDown (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects all dynamical nodes in the subtree rooted at this node using a breadth-first, top-down traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes.

function selectAllDynamicalNodesDepthFirst#

Selects all dynamical nodes, depth-first.

void SBMDynamicalModelNode::selectAllDynamicalNodesDepthFirst (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects all dynamical nodes using a depth-first traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes.

function selectDynamicalNodesBreadthFirst#

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

void SBMDynamicalModelNode::selectDynamicalNodesBreadthFirst (
    std::vector< SBMDynamicalModelNode * > & selectionTopDown,
    std::vector< SBMDynamicalModelNode * > & selectionBottomUp,
    bool(*)( SBMDynamicalModelNode *) selectionRule
)

Selects dynamical nodes that satisfy a user-provided rule using a breadth-first traversal, providing both top-down and bottom-up selections.

Parameters:

selectionTopDown Reference to a vector that will be filled with pointers to the selected nodes in top-down order.
selectionBottomUp Reference to a vector that will be filled with pointers to the selected nodes in bottom-up order.
selectionRule Pointer to a function that returns true for nodes that should be selected.

function selectDynamicalNodesBreadthFirstBottomUp#

Selects some dynamical nodes, breadth-first, bottom-up.

void SBMDynamicalModelNode::selectDynamicalNodesBreadthFirstBottomUp (
    std::vector< SBMDynamicalModelNode * > & selection,
    bool(*)( SBMDynamicalModelNode *) selectionRule
)

Selects dynamical nodes that satisfy a user-provided rule using a breadth-first traversal, then reverses the order to provide a bottom-up sequence.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes in bottom-up order.
selectionRule Pointer to a function that returns true for nodes that should be selected.

function selectDynamicalNodesBreadthFirstTopDown#

Selects some dynamical nodes, breadth-first, top-down.

void SBMDynamicalModelNode::selectDynamicalNodesBreadthFirstTopDown (
    std::vector< SBMDynamicalModelNode * > & selection,
    bool(*)( SBMDynamicalModelNode *) selectionRule
)

Selects dynamical nodes that satisfy a user-provided rule using a breadth-first, top-down traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes.
selectionRule Pointer to a function that returns true for nodes that should be selected.

function selectDynamicalNodesDepthFirst#

Selects some dynamical nodes, depth-first.

void SBMDynamicalModelNode::selectDynamicalNodesDepthFirst (
    std::vector< SBMDynamicalModelNode * > & selection,
    bool(*)( SBMDynamicalModelNode *) selectionRule
)

Selects dynamical nodes that satisfy a user-provided rule using a depth-first traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected nodes.
selectionRule Pointer to a function that returns true for nodes that should be selected.

function selectInternalDynamicalNodesBreadthFirstBottomUp#

Selects internal dynamical nodes, breadth-first, bottom-up.

void SBMDynamicalModelNode::selectInternalDynamicalNodesBreadthFirstBottomUp (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects internal dynamical nodes using a breadth-first traversal, then reverses the order to provide a bottom-up sequence.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected internal nodes in bottom-up order.

function selectInternalDynamicalNodesBreadthFirstTopDown#

Selects internal dynamical nodes, breadth-first, top-down.

void SBMDynamicalModelNode::selectInternalDynamicalNodesBreadthFirstTopDown (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects internal dynamical nodes (nodes that have children) using a breadth-first, top-down traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected internal nodes.

function selectInternalDynamicalNodesDepthFirst#

Selects internal dynamical nodes, depth-first.

void SBMDynamicalModelNode::selectInternalDynamicalNodesDepthFirst (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects internal dynamical nodes (nodes that have children) using a depth-first traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected internal nodes.

function selectLeafDynamicalNodesBreadthFirstBottomUp#

Selects leaf dynamical nodes, breadth-first, bottom-up.

void SBMDynamicalModelNode::selectLeafDynamicalNodesBreadthFirstBottomUp (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects leaf dynamical nodes using a breadth-first traversal, then reverses the order to provide a bottom-up sequence.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected leaf nodes in bottom-up order.

function selectLeafDynamicalNodesBreadthFirstTopDown#

Selects leaf dynamical nodes, breadth-first, top-down.

void SBMDynamicalModelNode::selectLeafDynamicalNodesBreadthFirstTopDown (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects leaf dynamical nodes (nodes without children) using a breadth-first, top-down traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected leaf nodes.

function selectLeafDynamicalNodesDepthFirst#

Selects leaf dynamical nodes, depth-first.

void SBMDynamicalModelNode::selectLeafDynamicalNodesDepthFirst (
    std::vector< SBMDynamicalModelNode * > & selection
)

Selects leaf dynamical nodes (nodes without children) using a depth-first traversal and stores them in the provided vector.

Parameters:

selection Reference to a vector that will be filled with pointers to the selected leaf nodes.

function serialize#

Serializes the node.

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

Writes the node's data to the given serializer.

Parameters:

serializer Serializer used to write data.
nodeIndexer Indexer for nodes.
sdkVersionNumber SDK version number.
classVersionNumber Class version number.

Implements SBMModelNode::serialize

function unserialize#

Unserializes the node.

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

Reads the node's data from the given serializer.

Parameters:

serializer Serializer used to read data.
nodeIndexer Indexer for nodes.
sdkVersionNumber SDK version number.
classVersionNumber Class version number.

Implements SBMModelNode::unserialize

function ~SBMDynamicalModelNode#

Deletes the dynamical node.

virtual SBMDynamicalModelNode::~SBMDynamicalModelNode ()

Destroys the SBMDynamicalModelNode.

Public Static Functions Documentation#

function forEachDynamicalNodeInSelection [1/2]#

Performs the action on each node in the selection.

static void SBMDynamicalModelNode::forEachDynamicalNodeInSelection (
    std::vector< SBMDynamicalModelNode * > & selection,
    void(*)( SBMDynamicalModelNode *node) action
)

Executes the given function for each node in the provided selection.

Parameters:

selection Vector containing the nodes to iterate over.
action Function to be called for each node.

function forEachDynamicalNodeInSelection [2/2]#

Performs the object 'saction on each node in the selection.

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

Executes the given member function for each node in the provided selection.

Parameters:

selection Vector containing the nodes to iterate over.
object Object whose member function will be invoked.
action Member function pointer to be called for each node.

Protected Functions Documentation#

function SBMDynamicalModelNode [1/2]#

Build a dynamical node.

SBMDynamicalModelNode::SBMDynamicalModelNode ()

Constructs a SBMDynamicalModelNode.

Initializes a new dynamical model node with default internal data.

function SBMDynamicalModelNode [2/2]#

Build a dynamical node.

SBMDynamicalModelNode::SBMDynamicalModelNode (
    SBMDynamicalModelNodeData * dataPointer
)

Constructs a SBMDynamicalModelNode with the given data pointer.

Parameters:

dataPointer Pointer to the node's data structure.