Class SBMInteractionModel

ClassList > SBMInteractionModel

This class is the base class of interaction models. More...

• #include <SBMInteractionModel.hpp>

Inherits the following classes: SBMModel

Inherited by the following classes: SBMInteractionModelParticleSystem

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
	SBMInteractionModel () Default constructor.
virtual void	changed () Emits the InteractionModelChanged event.
virtual void	collectAmbientOcclusion (const SBPosition3 & boxOrigin, const SBPosition3 & boxSize, unsigned int nCellsX, unsigned int nCellsY, unsigned int nCellsZ, float * ambientOcclusionData) To collect ambient occlusion data.
void	connectInteractionSignalToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBInteractionEvent *) functionPointer, SBCReferenceTarget * nextReferenceTarget=0, void(SBCReferenceTarget::*)(SBInteractionEvent *) nextFunctionPointer=0) Connects the interaction signal to a slot.
void	disconnectInteractionSignalFromSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBInteractionEvent *) functionPointer) Disconnects the interaction signal from a slot.
virtual void	expandBounds (SBIAPosition3 & bounds) const Expands the bounds to make sure the interaction model fits inside them.
virtual void	flushForceBuffer () Flushes the force buffer.
virtual unsigned int	getChangedForceIndex (unsigned int i) const Returns an index of the changed force.
virtual const SBQuantity::energy &	getEnergy () const Returns the current energy.
virtual bool	getForceChanged (unsigned int i) const Returns whether force i has been changed since the last flush.
virtual SBDDataGraphNode::Type	getInteractionModelType () const Returns the interaction model type.
virtual SBDDataGraphNode::Type	getModelType () override const Returns the model type.
virtual unsigned int	getNumberOfChangedForces () const Returns the number of changed forces.
const SBPointerList< SBNode > *	getSimulatorList () const Returns the list of simulators associated with this interaction model.
virtual SBDDataGraphNode::Type	getType () override const Returns the node type.
virtual void	initializeInteractions () Initializes the interactions.
bool	interactionSignalIsConnectedToSlot (SBCReferenceTarget * referenceTarget, void(SBCReferenceTarget::*)(SBInteractionEvent *) functionPointer) const Returns true if and only if the interaction signal is connected to a given slot.
virtual bool	isSerializable () override const Returns true when the class is serializable.
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.
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 void	updateInteractions () Updates the interactions.
virtual	~SBMInteractionModel () Destructor.

Public Functions inherited from SBMModel

See SBMModel

Type	Name
	SB_NODE_GETTER_0 (SB_SBMMODEL_EXPORT, SBDDataGraphNode::Type, GetModelType)
	SB_NODE_PREDICATE_1 (SB_SBMMODEL_EXPORT, IsModelType, SBDDataGraphNode::Type)
void	clearSourceFileName () Clears the name of the file associated to the model.
virtual SBMModel *	clone () override Returns a copy of the node and its descendants.
virtual SBDDataGraphNode::Type	getModelType () const Returns the model type.
SBMModel *	getNextModel () const Returns the next model in the parent.
virtual unsigned int	getOpacity () override const Returns the opacity.
SBMModel *	getPreviousModel () const Returns the previous model in the parent.
bool	getShadowingFlag () const Returns whether the model casts shadows.
const std::string &	getSourceFileName () const Returns the name of the file associated to the model.
virtual unsigned int	getTransparency () override const Returns the transparency.
virtual SBDDataGraphNode::Type	getType () override const Returns the type of the data graph node.
bool	hasSourceFileName () const Returns true when the model has the source file name set.
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.
virtual void	setOpacity (unsigned int opacity) override Sets the opacity.
void	setShadowingFlag (bool shadowingFlag) Sets whether the model casts shadows.
void	setSourceFileName (const std::string & fileName) Sets the name of the file associated to the model.
virtual void	setTransparency (unsigned int transparency) override Sets the transparency.
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	~SBMModel () Delete the model.

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 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

Type	Name
SBQuantity::energy *	energy The energy.
SBSignal1< SBInteractionEvent * > *	interactionSignal
SBPointerList< SBNode > *	simulatorList

Protected Attributes inherited from SBCReferenceTarget

See SBCReferenceTarget

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

Protected Functions

Type	Name
void	addSimulator (SBNode * simulator) Adds a simulator to the interaction model.
virtual void	emitInteractionSignal (SBInteractionEvent * event) Emits an interaction event to all connected slots.
void	removeSimulator (SBNode * simulator) Removes a simulator from the interaction model.
void	setEnergy (const SBQuantity::energy & newEnergy) Sets the energy of the interaction model.

Protected Functions inherited from SBMModel

See SBMModel

Type	Name
	SBMModel () Builds a model.
	SBMModel (SBMModelData * dataPointer) Builds a model.

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: SBInteractionModel

Public Functions Documentation

function SBMInteractionModel

Default constructor.

SBMInteractionModel::SBMInteractionModel () 

Builds a base model.

---

function changed

Emits the InteractionModelChanged event.

virtual void SBMInteractionModel::changed () 

Emits the InteractionModelChanged event to notify listeners of a change.

---

function collectAmbientOcclusion

To collect ambient occlusion data.

virtual void SBMInteractionModel::collectAmbientOcclusion (
    const SBPosition3 & boxOrigin,
    const SBPosition3 & boxSize,
    unsigned int nCellsX,
    unsigned int nCellsY,
    unsigned int nCellsZ,
    float * ambientOcclusionData
) 

Collects ambient occlusion data for the interaction model.

Parameters:

• boxOrigin The origin of the bounding box.
• boxSize The size of the bounding box.
• nCellsX Number of cells in X direction.
• nCellsY Number of cells in Y direction.
• nCellsZ Number of cells in Z direction.
• ambientOcclusionData Pointer to the array where ambient occlusion data will be stored.

---

function connectInteractionSignalToSlot

Connects the interaction signal to a slot.

void SBMInteractionModel::connectInteractionSignalToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBInteractionEvent *) functionPointer,
    SBCReferenceTarget * nextReferenceTarget=0,
    void(SBCReferenceTarget::*)( SBInteractionEvent *) nextFunctionPointer=0
) 

Parameters:

• referenceTarget The target object that will receive the signal.
• functionPointer The member function pointer to be called on the target when the signal is emitted.
• nextReferenceTarget Optional next target for chaining slots; may be null.
• nextFunctionPointer Optional next member function pointer for the next target; may be null.

---

function disconnectInteractionSignalFromSlot

Disconnects the interaction signal from a slot.

void SBMInteractionModel::disconnectInteractionSignalFromSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBInteractionEvent *) functionPointer
) 

Disconnects the interaction signal from a specific slot.

Parameters:

• referenceTarget The target object from which to disconnect the signal.
• functionPointer The member function pointer associated with the target to be disconnected.

---

function expandBounds

Expands the bounds to make sure the interaction model fits inside them.

virtual void SBMInteractionModel::expandBounds (
    SBIAPosition3 & bounds
) const

Expands the given bounds to include the interaction model.

Parameters:

• bounds The bounds to be expanded.

---

function flushForceBuffer

Flushes the force buffer.

virtual void SBMInteractionModel::flushForceBuffer () 

Flushes the force buffer. This default implementation does nothing.

---

function getChangedForceIndex

Returns an index of the changed force.

virtual unsigned int SBMInteractionModel::getChangedForceIndex (
    unsigned int i
) const

Returns the index of a changed force.

Parameters:

• i The index of the changed force to query.

Returns:

The force index, which is always zero in the base implementation.

---

function getEnergy

Returns the current energy.

virtual const SBQuantity::energy & SBMInteractionModel::getEnergy () const

Retrieves the current energy of the interaction model.

Returns:

A constant reference to the energy value.

---

function getForceChanged

Returns whether force i has been changed since the last flush.

virtual bool SBMInteractionModel::getForceChanged (
    unsigned int i
) const

Checks whether a specific force has changed.

Parameters:

• i The index of the force to check.

Returns:

false, as no forces are tracked in the base implementation.

---

function getInteractionModelType

Returns the interaction model type.

virtual SBDDataGraphNode::Type SBMInteractionModel::getInteractionModelType () const

Returns the interaction model type of this object.

Returns:

The interaction model type, which is InteractionModel.

---

function getModelType

Returns the model type.

virtual SBDDataGraphNode::Type SBMInteractionModel::getModelType () override const

Returns the model type of this object.

Returns:

The model type, which is InteractionModel.

Implements SBMModel::getModelType

---

function getNumberOfChangedForces

Returns the number of changed forces.

virtual unsigned int SBMInteractionModel::getNumberOfChangedForces () const

Returns the number of forces that have changed.

Returns:

The count of changed forces, which is always zero in the base implementation.

---

function getSimulatorList

Returns the list of simulators associated with this interaction model.

const SBPointerList< SBNode > * SBMInteractionModel::getSimulatorList () const

Provides a constant pointer to the internal list of simulators. The returned list must not be modified by callers.

Returns:

A const pointer to the SBPointerList containing SBNode pointers for each simulator.

---

function getType

Returns the node type.

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

Returns the node type of this object.

Returns:

The node type, which is InteractionModel.

Implements SBMModel::getType

---

function initializeInteractions

Initializes the interactions.

virtual void SBMInteractionModel::initializeInteractions () 

Initializes interactions for the model. This default implementation does nothing.

---

function interactionSignalIsConnectedToSlot

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

bool SBMInteractionModel::interactionSignalIsConnectedToSlot (
    SBCReferenceTarget * referenceTarget,
    void(SBCReferenceTarget::*)( SBInteractionEvent *) functionPointer
) const

Checks if the interaction signal is connected to a specific slot.

Parameters:

• referenceTarget The target object to check.
• functionPointer The member function pointer associated with the target.

Returns:

true if the signal is connected to the specified slot; otherwise false.

---

function isSerializable

Returns true when the class is serializable.

virtual bool SBMInteractionModel::isSerializable () override const

Indicates whether the interaction model is serializable.

Returns:

Always returns false because this model does not support serialization.

Implements SBMModel::isSerializable

---

function print

Prints debugging information.

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

Prints debugging information for the interaction model.

Parameters:

• offset The indentation offset for the printed output.

Implements SBMModel::print

---

function serialize

Serializes the node.

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

Serializes the interaction model to a serializer.

Parameters:

• serializer The serializer to use for writing data.
• nodeIndexer The node indexer for mapping node IDs.
• sdkVersionNumber The SDK version number (default is SB_SDK_VERSION_NUMBER).
• classVersionNumber The class version number (default is 1.0.0).

Implements SBMModel::serialize

---

function unserialize

Unserializes the node.

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

Deserializes the interaction model from a serializer.

Parameters:

• serializer The serializer to use for reading data.
• nodeIndexer The node indexer for mapping node IDs.
• sdkVersionNumber The SDK version number (default is SB_SDK_VERSION_NUMBER).
• classVersionNumber The class version number (default is 1.0.0).

Implements SBMModel::unserialize

---

function updateInteractions

Updates the interactions.

virtual void SBMInteractionModel::updateInteractions () 

Updates interactions for the model. This default implementation does nothing.

---

function ~SBMInteractionModel

Destructor.

virtual SBMInteractionModel::~SBMInteractionModel () 

Deletes the model.

---

Protected Attributes Documentation

variable energy

The energy.

SBQuantity::energy* SBMInteractionModel::energy;

---

variable interactionSignal

SBSignal1<SBInteractionEvent*>* SBMInteractionModel::interactionSignal;

---

variable simulatorList

SBPointerList<SBNode>* SBMInteractionModel::simulatorList;

---

Protected Functions Documentation

function addSimulator

Adds a simulator to the interaction model.

void SBMInteractionModel::addSimulator (
    SBNode * simulator
) 

Parameters:

• simulator The simulator node to be added.

---

function emitInteractionSignal

Emits an interaction event to all connected slots.

virtual void SBMInteractionModel::emitInteractionSignal (
    SBInteractionEvent * event
) 

Parameters:

• event The interaction event to emit.

---

function removeSimulator

Removes a simulator from the interaction model.

void SBMInteractionModel::removeSimulator (
    SBNode * simulator
) 

This function removes the given simulator from the interaction model's internal list, allowing the removal to be undone if the Core is currently holding an undo operation.

Parameters:

• simulator The simulator to be removed. If the pointer is null, the function returns without action.

---

function setEnergy

Sets the energy of the interaction model.

void SBMInteractionModel::setEnergy (
    const SBQuantity::energy & newEnergy
) 

Sets a new energy value for the interaction model.

Parameters:

• newEnergy The new energy value to assign. Note: If the new energy is the same as the current one, no change is made.

---