Loading...
Searching...
No Matches
SBMDynamicalModelArticulatedBodySystem Class Referenceabstract
This class describes an articulated-body dynamical model.
Identity | |
| virtual SBDDataGraphNode::Type | getType () const override |
| Returns the node type (SBNode::ArticulatedBodySystem) | |
| virtual SBDDataGraphNode::Type | getDynamicalModelType () const override |
| Returns the dynamical model type. | |
Debugging | |
| virtual void | print (unsigned int offset=0) const override |
| Prints debugging information. | |
Constructors and destructors | |
| SBMDynamicalModelArticulatedBodySystem () | |
| Builds an articulated body system | |
| virtual | ~SBMDynamicalModelArticulatedBodySystem () |
| Deletes the articulated-body system. | |
Event handling <br> | |
| virtual void | onBaseEvent (SBEvent *event)=0 |
| Handles base events. | |
| virtual void | onStructuralEvent (SBStructuralEvent *structuralEvent)=0 |
| Handles structural events. | |
Additional Inherited Members | |
 Public Types inherited from SBDDataGraphNode | |
| enum | Type { Undefined , StructuralModel , StructuralModelNode , StructuralModelConformation , Conformation , StructuralModelPath , Path , StructuralModelNodeGroup , StructuralGroup , StructuralModelNodeRoot , Root , StructuralModelNodeAtom , Atom , StructuralModelNodeBond , Bond , StructuralModelNodeHydrogenBond , HydrogenBond , StructuralModelNodeHydrogenBondGroup , HydrogenBondGroup , StructuralModelNodeResidue , Residue , StructuralModelNodeSegment , Segment , StructuralModelNodeChain , Chain , StructuralModelNodeMolecule , Molecule , StructuralModelNodeBackbone , Backbone , StructuralModelNodeSideChain , SideChain , VisualModel , VisualModelMesh , Mesh , DynamicalModel , DynamicalModelParticleSystem , ParticleSystem , DynamicalModelRigidBodySystem , RigidBodySystem , DynamicalModelArticulatedBodySystem , ArticulatedBodySystem , DynamicalModelNode , DynamicalNode , DynamicalModelNodeGroup , DynamicalGroup , DynamicalModelNodeRoot , DynamicalRoot , DynamicalModelNodeParticle , Particle , DynamicalModelNodeRigidBody , RigidBody , DynamicalModelNodeArticulatedBody , ArticulatedBody , InteractionModel , InteractionModelParticleSystem , InteractionModelRigidBodySystem , InteractionModelArticulatedBodySystem , PropertyModel , PropertyModelFunction , Simulator , SimulatorParticleSystem , SimulatorRigidBodySystem , SimulatorArticulatedBodySystem , StateUpdater , StateUpdaterParticleSystem , StateUpdaterRigidBodySystem , StateUpdaterArticulatedBodySystem , Animation , Camera , Document , DocumentManager , File , Folder , Label , Light , Note , Presentation , RenderPreset , DataGraphNodeGroup , NodeGroup , Controller , ControllerNode , Asset } |
| The type of the data graph node. More... | |
| enum class | RenderingPass { Setup , OpaqueGeometry , SelectableGeometry , ShadowingGeometry , TransparentGeometry , Interface , Text } |
| The rendering pass. More... | |
| Public Member Functions inherited from SBMDynamicalModel | |
| virtual bool | isSerializable () const override |
| Returns true when the class is serializable. | |
| virtual void | serialize (SBCSerializer *serializer, const SBNodeIndexer &nodeIndexer, const SBVersionNumber &sdkVersionNumber=SB_SDK_VERSION_NUMBER, const SBVersionNumber &classVersionNumber=SBVersionNumber(1, 0, 0)) const override |
| 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. | |
| SBMDynamicalModelNodeRoot * | getDynamicalRoot () const |
| Returns the root of the dynamical model. | |
| virtual SBMDynamicalModel * | clone () override |
| Returns a copy of the node and its descendants. | |
| virtual SBDDataGraphNode::Type | getModelType () const override |
| Returns the model type. | |
| virtual unsigned int | getNumberOfChangedPositions () const |
| Returns the number of changed positions. | |
| virtual unsigned int | getChangedPositionIndex (unsigned int i) const |
| Returns the index of a changed position. | |
| virtual bool | getPositionChanged (unsigned int i) const |
Returns whether position i has been changed since the last flush. | |
| virtual void | flushPositionBuffer () |
| Flushes the position buffer. | |
| virtual void | updateStructuralNodes () |
| Updates structural nodes based on the state of the dynamical model. | |
| SBIAPosition3 const & | getPeriodicBoundaryConditions () const |
| Returns the periodic boundary conditions. | |
| void | setPeriodicBoundaryConditions (SBIAPosition3 const &box) |
| Sets the periodic boundary conditions. | |
| bool | getPeriodicBoundaryConditionsFlag () const |
| Returns the periodic boundary conditions flag. | |
| void | setPeriodicBoundaryConditionsFlag (bool flag) |
| Sets the periodic boundary conditions flag. | |
| virtual bool | enforcePeriodicBoundaryConditions () |
| Enforces the periodic boundary conditions. | |
| void | connectDynamicalSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDynamicalEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBDynamicalEvent *)=0) |
| Connects the dynamical signal to a slot. | |
| bool | dynamicalSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDynamicalEvent *)) const |
| Returns true if and only if the dynamical signal is connected to a given slot. | |
| void | disconnectDynamicalSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBDynamicalEvent *)) |
| Disconnects the dynamical signal from a slot. | |
| virtual void | getNodes (SBNodeIndexer &nodeIndexer, SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const override |
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 override |
Collects nodes into nodeIndexer, based on a selectionPredicate and a visitPredicate, with or without dependencies. | |
| virtual bool | hasNode (SBNode::Type nodeType, bool selectedNodesOnly=false, const SBNodePredicate &visitPredicate=SBDDataGraphNode::All(), bool includeDependencies=false) const override |
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) const override |
Checks for nodes based on a selectionPredicate and a visitPredicate, with or without dependencies. | |
| virtual void | forEachNodeDepthFirst (void(*action)(SBDDataGraphNode *node)) override |
| Performs an action on each node. | |
| virtual void | forEachNodeDepthFirst (SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node)) override |
| Performs an action on each node. | |
| SB_DECLARE_DATA (SBMDynamicalModel) | |
| Public Member Functions inherited from SBMModel | |
| virtual | ~SBMModel () |
| Delete the model. | |
| SBMModel * | getNextModel () const |
| Returns the next model in the parent. | |
| SBMModel * | getPreviousModel () const |
| Returns the previous model in the parent. | |
| virtual unsigned int | getOpacity () const override |
| Returns the opacity. | |
| virtual void | setOpacity (unsigned int opacity) override |
| Sets the opacity. | |
| virtual unsigned int | getMinimumOpacity () const override |
| Returns the minimum opacity. | |
| virtual unsigned int | getTransparency () const override |
| Returns the transparency. | |
| virtual void | setTransparency (unsigned int transparency) override |
| Sets the transparency. | |
| virtual unsigned int | getMaximumTransparency () const override |
| Returns the maximum transparency. | |
| bool | getShadowingFlag () const |
| Returns whether the model casts shadows. | |
| void | setShadowingFlag (bool shadowingFlag) |
| Sets whether the model casts shadows. | |
| SB_NODE_GETTER_0 (, SBDDataGraphNode::Type, GetModelType) | |
| SB_NODE_PREDICATE_1 (, IsModelType, SBDDataGraphNode::Type) | |
| SB_DECLARE_DATA (SBMModel) | |
| Public Member Functions inherited from SBDDataGraphNode | |
| SBDDataGraphNode * | getParent () const |
| Returns the parent of the node. | |
| SBDDataGraphNode * | getThisNode () const |
| Returns the pointer to this node. | |
| SBDDataGraphNode * | getNextNode () const |
| Returns the pointer to the next node in the children of the node's parent. | |
| SBDDataGraphNode * | getPreviousNode () const |
| Returns the pointer to the previous 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. | |
| SBDDataGraphNode * | getPreviousNode (SBDDataGraphNode::Type nodeType) const |
Returns the pointer to the previous node with type nodeType in the children of the node's parent. | |
| SBDDocument * | getDocument () const |
| Returns the document the node belongs to. | |
| 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. | |
| virtual bool | canHaveDescendantType (SBDDataGraphNode::Type nodeType) const |
Returns whether this node can have a node with type nodeType as a descendant. | |
| virtual bool | addChild (SBDDataGraphNode *node, SBDDataGraphNode *nextNode=nullptr) |
| Adds a child to the node. | |
| virtual bool | removeChild (SBDDataGraphNode *node) |
| Removes a child from the node. | |
| 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 | 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. | |
| 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 | 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. | |
| SBDDataGraphNode * | getRoot () const |
| Returns the root of the hierarchy the node belongs to. | |
| unsigned int | getNodeIndex () const |
| Returns the node index (unique in the whole data graph, but non-persistent) | |
| std::string | getTypeString (bool humanReadable=false) const |
| Returns a string describing the type of the data graph node. | |
| virtual std::string const & | getName () const |
| Returns the name of the node. | |
| virtual void | setName (const std::string &name) |
| Sets the name of the node. | |
| bool | isType (Type type) const |
Returns true when the type of the node corresponds to type. | |
| bool | isModel () const |
| Returns true when the node is a model. | |
| bool | isAtom () const |
| Returns true when the node is an atom. | |
| bool | isBond () const |
| Returns true when the node is a bond. | |
| bool | isStructuralNode () const |
| Returns true when the node is a structural node. | |
| bool | isStructuralModel () const |
| Returns true when the node is a structural model. | |
| bool | isVisualModel () const |
| Returns true when the node is a visual model. | |
| bool | isDynamicalModel () const |
| Returns true when the node is a dynamical model. | |
| bool | isInteractionModel () const |
| Returns true when the node is a interaction model. | |
| bool | isPropertyModel () const |
| Returns true when the node is a property model. | |
| bool | isMesh () const |
| Returns true when the node is a mesh. | |
| bool | isLight () const |
| Returns true when the node is a light. | |
| bool | isSimulator () const |
| Returns true when the node is a simulator. | |
| bool | isBallAndStick () const |
| Returns true when the node is the default ball-and-stick visual model. | |
| bool | isLicorice () const |
| Returns true when the node is the default licorice visual model. | |
| bool | isVanDerWaals () const |
| Returns true when the node is the default van der Waals visual model. | |
| bool | isCartoon () const |
| Returns true when the node is the default cartoon visual model. | |
| bool | isRibbon () const |
| Returns true when the node is the default ribbon visual model. | |
| bool | isTube () const |
| Returns true when the node is the default tube visual model. | |
| bool | isGaussianSurface () const |
| Returns true when the node is the default Gaussian surface visual model. | |
| 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. | |
| virtual bool | isLocked () const |
| Returns whether the node is locked. | |
| virtual bool | getLockedFlag () const |
| Returns the locked flag. | |
| virtual void | setLockedFlag (bool flag) |
| Sets the locked flag. | |
| bool | isCreated () const |
| Returns true if and only if the node is created. | |
| void | create () |
| Creates the node. | |
| bool | isErased () const |
| Returns true if and only if the node is erased. | |
| void | erase () |
| Erases the node. | |
| virtual unsigned int | getFlags () const |
| Returns the flags. | |
| virtual unsigned int | getInheritedFlags () const |
| Returns the inherited flags. | |
| bool | isSelected () const |
| Returns whether the node is selected. | |
| bool | getSelected () const |
| Returns whether the node is selected. | |
| bool | getSelectionFlag () const |
| Returns the selection flag. | |
| void | setSelectionFlag (bool flag) |
| Sets the selection flag. | |
| bool | isVisible () const |
| Returns whether the node is visible. | |
| bool | getVisible () const |
| Returns whether the node is visible. | |
| bool | getVisibilityFlag () const |
| Returns the visibility flag. | |
| void | setVisibilityFlag (bool flag) |
| Sets the visibility flag. | |
| bool | isHighlighted () const |
| Returns whether the node is highlighted. | |
| bool | getHighlightingFlag () const |
| Returns the highlighting flag. | |
| void | setHighlightingFlag (bool flag) |
| Sets the highlighting flag. | |
| virtual void | display (RenderingPass renderingPass) |
| Displays the node. | |
| virtual void | display () |
| Displays the node (deprecated) | |
| virtual void | displayForShadow () |
| Displays the node for shadowing purposes (deprecated) | |
| virtual void | displayForSelection () |
| Displays the node for selection purposes (deprecated) | |
| virtual bool | hasOpacityRange () const |
| Returns whether the node has the opacity range. | |
| virtual unsigned int | getDefaultOpacity () const |
| Returns the default opacity. | |
| virtual unsigned int | getMaximumOpacity () const |
| Returns the maximum opacity. | |
| virtual unsigned int | getOpacitySingleStep () const |
| Returns the opacity single step. | |
| virtual std::string | getOpacitySuffix () const |
| Returns the opacity suffix. | |
| virtual bool | hasTransparencyRange () const |
| Returns whether the node has the transparency range. | |
| virtual unsigned int | getDefaultTransparency () const |
| Returns the default transparency. | |
| virtual unsigned int | getMinimumTransparency () const |
| Returns the minimum transparency. | |
| virtual unsigned int | getTransparencySingleStep () const |
| Returns the transparency single step. | |
| virtual std::string | getTransparencySuffix () const |
| Returns the transparency suffix. | |
| 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. | |
| bool | canAddMaterial () const |
| Returns whether can add a material to the node based on its type. | |
| bool | addMaterial (SBDDataGraphNodeMaterial *material) |
| Adds a material. | |
| 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. | |
| bool | hasMaterial () const |
| Returns whether the node has a material (by itself, or inherited) | |
| bool | ownsMaterial () const |
| Returns whether the node owns a material. | |
| SBDDataGraphNodeMaterial * | getMaterial () const |
| Returns the material. | |
| SBDDataGraphNode * | getMaterialOwner () const |
| Returns the node whose material is inherited. | |
| void | connectBaseSignalToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *), SBCReferenceTarget *nextReferenceTarget=0, void(SBCReferenceTarget::*nextFunctionPointer)(SBBaseEvent *)=0) |
| Connects the base signal to a slot. | |
| bool | baseSignalIsConnectedToSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) const |
| Returns true when the base signal is connected to a slot. | |
| void | disconnectBaseSignalFromSlot (SBCReferenceTarget *referenceTarget, void(SBCReferenceTarget::*functionPointer)(SBBaseEvent *)) |
| Disconnects the base signal from a slot. | |
| unsigned int | countNodes (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. | |
| 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. | |
| virtual unsigned int | getNumberOfChains () |
| Returns the number of chains. | |
| virtual unsigned int | getNumberOfMolecules () |
| Returns the number of molecules. | |
| 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 | getNumberOfAtoms () |
| Returns the number of atoms. | |
| virtual unsigned int | getNumberOfCarbons () |
| Returns the number of carbons. | |
| virtual unsigned int | getNumberOfHydrogens () |
| Returns the number of hydrogens. | |
| virtual unsigned int | getNumberOfNitrogens () |
| Returns the number of nitrogens. | |
| virtual unsigned int | getNumberOfOxygens () |
| Returns the number of oxygens. | |
| virtual unsigned int | getNumberOfSulfurs () |
| Returns the number of sulfurs. | |
| virtual unsigned int | getNumberOfCoarseGrainedAtoms () |
| Returns the number of coarse-grained atoms. | |
| virtual unsigned int | getNumberOfOtherAtoms () |
| Returns the number of other atoms. | |
| virtual int | getSumOfFormalCharges () |
| Returns the sum of formal charges. | |
| virtual float | getSumOfPartialCharges () |
| Returns the sum of partial charges. | |
| virtual SBQuantity::mass | getMolecularWeight () |
| Returns the molecular weight. | |
| SB_DECLARE_DATA (SBDDataGraphNode) | |
| Public Member Functions inherited from SBCReferenceTarget | |
| unsigned int | getMemoryFootprint () const |
| void | printReferencesToOwners () const |
| SBCReferenceTarget () | |
| virtual | ~SBCReferenceTarget () |
| Static Public Member Functions inherited from SBDDataGraphNode | |
| static void | clone (const SBNodeIndexer &sourceNodeIndexer, SBNodeIndexer &destinationNodeIndexer) |
Clones the nodes in sourceNodeIndexer (treated as a whole) and places the clones in destinationNodeIndexer. | |
| static SBDDataGraphNode * | getNode (unsigned int nodeIndex) |
Returns the unique node corresponding to the node index nodeIndex. | |
| static std::string | getTypeString (Type type, bool humanReadable=false) |
| Returns a string describing the type of the data graph node. | |
| static bool | canAddMaterial (SBDDataGraphNode::Type nodeType) |
Returns whether can add a material to a node of type nodeType. | |
| static void | forEachNodeInSelection (SBNodeIndexer &nodeIndexer, void(*action)(SBDDataGraphNode *node)) |
| Performs an action for each node in a selection. | |
| static void | forEachNodeInSelection (SBNodeIndexer &nodeIndexer, SBCClass *object, void(SBCClass::*action)(SBDDataGraphNode *node)) |
| Performs an action for each node in a selection. | |
| Protected Member Functions inherited from SBMDynamicalModel | |
| SBMDynamicalModel () | |
| Builds a dynamical model. | |
| SBMDynamicalModel (SBMDynamicalModelData *dataPointer) | |
| Builds a dynamical model. | |
| virtual | ~SBMDynamicalModel () |
| Deletes the dynamical model. | |
| Protected Member Functions inherited from SBMModel | |
| SBMModel () | |
| Builds a model. | |
| SBMModel (SBMModelData *dataPointer) | |
| Builds a model. | |
| Protected Member Functions inherited from SBDDataGraphNode | |
| SBDDataGraphNode () | |
| Builds a data graph node. | |
| SBDDataGraphNode (SBDDataGraphNodeData *dataPointer) | |
| Builds a data graph node. | |
| virtual | ~SBDDataGraphNode () |
| Destroys the node. | |
| Protected Member Functions inherited from SBCReferenceTarget | |
| void | removeAllReferenceOwners () |
| SBCReferenceTarget (SBCReferenceTargetData *dataPointer) | |
| Protected Attributes inherited from SBCReferenceTarget | |
| SBCReferenceTargetData * | dataPointer |
Constructor & Destructor Documentation
◆ SBMDynamicalModelArticulatedBodySystem()
|
protected |
Builds a base model.
◆ ~SBMDynamicalModelArticulatedBodySystem()
|
protectedvirtual |
Deletes the model.
Member Function Documentation
◆ getDynamicalModelType()
|
overridevirtual |
Reimplemented from SBMDynamicalModel.
◆ getType()
|
overridevirtual |
Reimplemented from SBMDynamicalModel.
◆ print()
|
overridevirtual |
Reimplemented from SBMDynamicalModel.