The `APIVersion` component in the SOFA framework is used to specify the API version of the components utilized within a scene. This helps ensure compatibility and proper functionality by verifying tha…
AbstractDataLink is the base class for all links between two data fields in SOFA's object model. It establishes connections (links) from one `BaseData` field to another, referred to as the "target." T…
The `AddFrameButtonSetting` is a GUI component in the SOFA framework designed to add a frame to a skinned model through button settings. It inherits from `sofa::component::setting::MouseButtonSetting`…
The `AddRecordedCameraButtonSetting` is a GUI component in the SOFA framework, specifically designed to configure a button for saving the camera's view point (position and orientation). This class inh…
The `AddRecordedCameraPerformer` is a component in the SOFA framework, specifically within the `sofa::gui::component::performer` namespace. It inherits from `InteractionPerformer`, making it part of t…
The `AffineMovementProjectiveConstraint` is a SOFA component designed to constrain the movement of specific points in a mesh by applying an affine transformation (rigid motion). This constraint impose…
The `AngularSpringForceField` is a force field in SOFA that applies elastic angular springs to the rotational degrees of freedom of rigid bodies or frames. It computes forces based on the deviation fr…
The `AnimateBeginEvent` is an event in the SOFA framework fired by the `Simulation::animate()` function before computing a new animation step. It inherits from the base `sofa::core::objectmodel::Event…
The `AnimateEndEvent` is an event fired by the Simulation module in SOFA after computing a new animation step. It inherits from the base Event class and signals the completion of an animation frame, a…
The `AnimateVisitor` is a SOFA component within the `sofa::simulation` namespace and part of the `Sofa.framework.Simulation.Core` module. It inherits from the `Visitor` class and plays a crucial role …
The `AnimationLoopParallelScheduler` is part of SOFA's MultiThreading module and serves as a parallel animation loop, leveraging the Intel tbb (Thread Building Blocks) library for efficient multithrea…
The `AssembleGlobalVectorFromLocalVectorVisitor` is a visitor in the SOFA framework that copies vectors stored in a `BaseMechanicalState` into a global vector of type `BaseVector`. This copying operat…
This linear solver is based on SparseLDLSolver and performs factorization asynchronously.
The `AttachBodyButtonSetting` component is part of the SOFA GUI module and inherits from `MouseButtonSetting`. It manages the configuration for attaching bodies through user interaction with mouse but…
The `AttachProjectiveConstraint` is a projective constraint component in the SOFA framework, designed to attach pairs of particles by projecting the positions of one set of particles onto another. Thi…
The `AverageCoord` component is part of the SOFA framework and belongs to the `sofa::component::engine::analyze` namespace. It computes the average of a set of coordinates, which can be useful for var…
The `BDFOdeSolver` is a velocity-based ODE solver in the SOFA framework that uses the Backward Differentiation Formula (BDF). It supports any order and variable time step sizes, enabling precise contr…
The BTDMatrix is a specialized matrix implementation in the Sofa framework used for simulations involving rigid bodies and large-scale deformable models. It stands for Block Tridiagonal Decomposition …
The BVH (Bounding Volume Hierarchy) Narrow Phase is a collision detection algorithm designed for efficient narrow phase collision testing in physics simulations and computer graphics applications. Thi…
The `BackgroundSetting` component in the SOFA framework is responsible for configuring the visual appearance of the background within simulations, specifically setting the color and potentially an ima…
The `BarycentricContactMapper` is a base class for all contact mappers using BarycentricMapping in the SOFA framework. It inherits from `BaseContactMapper` and specializes in handling collision models…
The `BarycentricMapperEdgeSetTopology` is a SOFA component that facilitates barycentric mapping computations on a BaseMeshTopology with edges, specifically designed for linear mappings in the Sofa.Com…
The BarycentricMapperHexahedronSetTopology is a specialized component used in simulation frameworks like Sofa to map points from one topology (the 'from' topology) to another (the 'to' topology). Spec…
This component is part of the SOFA (Simulation Open-Framework Architecture) library and implements a barycentric mapping between two topological models. It performs geometric interpolation from points…
The `BarycentricMapperQuadSetTopology` class in the SOFA framework is part of the mapping module and facilitates barycentric mapping computations on quad-based topologies (i.e., Quadrilateral sets). T…
The `BarycentricMapperRegularGridTopology` is a SOFA component in the `sofa::component::mapping::linear` namespace, designed for barycentric mapping computation on a `RegularGridTopology`. It inherits…
The BarycentricMapper(SparseGridTopology) is a component used in the SOFA (Simulation Open Framework Architecture) framework for mapping points between two different meshes with sparse grid topology.
The BarycentricMapperTetrahedronSetTopology class is a specialized mapping mechanism in the SOFA (Simulation Open-Framework Architecture) framework designed for use with tetrahedral meshes. This compo…
The `BarycentricMapperTopologyContainer` is a template class in the SOFA framework that extends `TopologyBarycentricMapper`. It facilitates the mapping between different topology containers, allowing …
The `BarycentricMapperTriangleSetTopology` is a SOFA component designed for barycentric mapping computation on TriangleSetTopologies within the simulation framework. It inherits from `BarycentricMappe…
The BarycentricStickContact class is a contact handler in the SOFA (Simulation Open-Framework Architecture) framework designed to manage and apply forces between colliding objects using stick-like spr…
The `Base` class in SOFA is the foundational class from which all other objects inherit. It provides essential functionality common to every object within the framework, such as managing data fields (…
The `BaseAnimationLoop` component is responsible for managing the main animation algorithms in SOFA, controlling how and when mechanical computations occur during an animation step. It provides an abs…
**Overview** The BaseCamera component serves as an abstract base class for defining various types of cameras in the SOFA (Simulation Open Framework Architecture) framework. It provides fundamental fu…
The `BaseConstraintSet` is an abstract class in the SOFA framework that serves as the foundation for defining and managing constraints within a simulation. It inherits from `objectmodel::BaseObject`, …
The `BaseContactMapper` is an abstract class in the SOFA framework, specifically designed to handle contact mappings between collision models and mechanical states. It serves as a base for specialized…
The BaseData class represents a data field in Sofa (Simulation Open Framework Architecture) that can be linked, updated and modified within the simulation framework. It serves as an abstract base for …
The `BaseElement` class in the SOFA framework is a fundamental building block for constructing and managing simulation scenes. It inherits from `sofa::core::objectmodel::BaseObjectDescription` and ser…
The `BaseFileAccess` class in the SOFA framework is designed to provide a unified interface for file access operations within Sofa simulations. This abstraction allows different methods or implementat…
The `BaseForceField` class in the SOFA framework is an abstract base class that defines the API common to all force fields. Its role is to compute forces applied to simulated bodies based on their cur…
The `BaseGUI` class in SOFA (Simulation Open-Framework Architecture) serves as the foundation for implementing graphical user interfaces (GUIs). It provides an interface and basic functionalities that…
The `BaseInteractionForceField` is a fundamental class in the SOFA framework, derived from `BaseForceField`. It serves as an abstract base for interaction force fields that link multiple bodies (Mecha…
The `BaseLagrangianConstraint` is an abstract class in the SOFA framework that serves as the foundation for all constraints applied to simulated bodies, whether internal or linking multiple bodies tog…
The `BaseLinearMultiStepMethod` is a base class for linear multistep methods used in the SOFA framework to solve ordinary differential equations (ODEs). It provides a generic implementation that compu…
The `BaseLinearSolver` is an abstract base class in the SOFA framework, identified by its namespace `sofa::core::behavior`. It serves as a type identifier for linear system solvers but does not provid…
The `BaseLoader` is an abstract base class in the SOFA ecosystem responsible for loading and parsing files that represent simulation components or models. It inherits from `objectmodel::BaseObject`, i…
The `BaseMapping` class in the SOFA (Simulation Open-Framework Architecture) framework serves as an abstract base for mapping components that define relationships between different parts of a simulati…
The `BaseMatrix` class is an abstract interface in SOFA's linear algebra framework, providing a generic matrix API that allows for operations independently of the underlying linear algebra library. Th…
The `BaseMatrixAccumulatorComponent` is a matrix accumulator designed to be associated with another component in the SOFA ecosystem. It inherits from `BaseObject`, which makes it part of the object mo…
The `BaseMatrixLinearSystem` is an abstract base class in the SOFA framework, specifically within the `sofa::core::behavior` namespace. It serves as a foundation for components that store and assemble…
The `BaseMatrixProjectionMethod` is a template class in the SOFA framework, part of the `Sofa.Component.LinearSystem` module and defined within the `sofa::component::linearsystem` namespace. It serves…
The BaseMechanicalVisitor class in SOFA (Simulation Open-Framework Architecture) is an abstract class that serves as the foundation for mechanical visitors, which are used to propagate and process var…
The `BaseMeshTopology` is an abstract base class in Sofa (Simulation Open Framework Architecture) used to represent the topological structure of 3D geometric meshes for simulation purposes.
The `BaseMultiMappingElement` is an abstract class within the SOFA framework that represents a base element for handling multi-mapping operations in simulation nodes. It inherits from `ObjectElement`,…
The `BaseNode` class in the SOFA framework is central to defining the hierarchical scene data structure for simulations. Each node represents an element within the simulation and can have parent and c…
The BaseObject is the fundamental class from which most Sofa components inherit. It serves as the base for all physical objects, engines, and other system elements in Sofa. This class provides essenti…
The `BaseObjectDescription` class in the SOFA framework is designed to provide an interface for classes that contain descriptions used for constructing objects, typically read from configuration files…
The `BaseOpenSurfaceConstraint` is a constraint component in the SOFA ecosystem, specifically designed to handle Lagrange constraints with integrated volume computation (dV as part of the Jacobian row…
The `BaseOrderingMethod` is an abstract base class within the SOFA framework that defines ordering methods for sparse linear solvers. Its primary role is to compute and apply permutations on sparse ma…
The `BaseProjectiveConstraintSet` is an abstract base class in the SOFA framework responsible for computing projective constraints within simulated bodies. It provides a common interface for all types…
The `BaseProximityIntersection` class in the SOFA framework serves as a base for intersection methods that use proximity-based computations. This class is part of the collision detection subsystem and…
The `BaseSimulationExporter` is an abstract class in SOFA that provides a uniform handling of export-related functionalities for simulation components. This class inherits from `BaseObject`, making it…
<description>The `BaseSimulationTest` class in the SOFA framework is part of the testing module and serves as a base for conducting simulation tests within the Sofa ecosystem. It inherits from `BaseTe…
The `BaseState` class in the SOFA framework is an abstract base class that stores position and velocity vectors. It defines the interface for components used as sources and destinations of regular (no…
The `BaseTest` class in the SOFA framework is a base class for Sofa test fixtures, designed to help with setting up and tearing down tests within the testing environment. It inherits from Google Test'…
The `BaseTetraForceField` component in SOFA (Simulation Open Framework Architecture) is designed to handle force computations for tetrahedral meshes, which are commonly used in simulations involving d…
The `BaseTopologyObject` is a core class in the SOFA framework, residing within the `sofa::core::topology` namespace and defined in the `Sofa.framework.Core` module. It inherits from `BaseObject`, whi…
The `BaseVTKLoader` is part of the SOFA.VTK module and serves as an abstract base class for loading VTK (Visualization Toolkit) data files into the SOFA simulation framework. It inherits from the `Mes…
The BaseVTKReader is an abstract base class for reading VTK (Visualization Toolkit) files in the SOFA framework, enabling the loading and processing of geometric data stored in VTK formats.
The `BaseVector` class in the SOFA framework provides a generic vector API that allows for filling and using vectors independently of the linear algebra library being used. It is part of the Sofa.line…
The BaseViewer class is an abstract base class that defines the interface for GUI viewers in the Sofa framework.
The `BatchGUI` component in SOFA is designed for batch processing simulations without graphical user interface interaction. It inherits from the `BaseGUI` class and is part of the `Sofa.GUI.Batch` mod…
This component sets the positions and velocities of points attached to a beam using linear interpolation between degrees of freedom (DOFs). It is designed for use with rigid body models where the chil…
The `BeamLinearMapping_mt` is part of the MultiThreading module in SOFA and extends the functionality of the base `BeamLinearMapping` to support multithreaded operations. Its primary role is to set th…
The `BehaviorModel` is an abstract interface in the SOFA framework that defines the behavior of a simulated object, particularly for 'black-box' objects such as certain fluid algorithms. It allows com…
The `BehaviorUpdatePositionVisitor` is a class in the SOFA framework's Simulation Core module, responsible for updating the position of behaviors during a new simulation step. It inherits from the `Vi…
This component represents a bilateral holonomic constraint that defines an equality relationship between two points or rigid bodies in the simulation.
The `BlockDiagonalMatrix` is part of the SOFA framework's LinearAlgebra module and inherits from `BaseMatrix`. This class provides functionality for managing block diagonal matrices in simulations. A …
The `BlockGaussSeidelConstraintSolver` is a constraint solver in the SOFA framework designed to solve Constraint-based components using the Linear Complementarity Problem formulation with a Block Gaus…
The `BlockVector` class in the `sofa::linearalgebra` namespace is part of the Sofa framework's LinearAlgebra module and inherits from `FullVector`. It represents a vector composed of blocks, where eac…
The `BroadPhaseDetection` component in SOFA is designed to compute potentially colliding pairs from a set of root collision models. This class manages the broad-phase detection, which aims at reducing…
The `BruteForceBroadPhase` component is part of the SOFA framework's collision detection algorithms, specifically within the broad phase of collision detection. Its role is to perform extensive pair-w…
The `BruteForceDetection` is a collision detection algorithm in the SOFA framework, specifically designed for interactive computational medical simulation scenarios. It combines brute force broad phas…
The `BuildConstraintSystemEndEvent` is an event in the SOFA simulation framework, specifically within the `sofa::simulation` namespace. Its primary role is to signal the end of the process of building…
The `BuiltConstraintSolver` is a virtual base class in the SOFA framework designed to build systems for solvers that utilize a built version of the constraint matrix. This component provides infrastru…
This component is designed to perform continuous collision detection between different types of geometric elements in a simulation environment, specifically for the SofaPhysics framework. Continuous c…
The `CGLinearSolver` is a linear system solver in the SOFA framework that uses the Conjugate Gradient (CG) iterative algorithm to solve systems of equations represented by matrices and vectors. It is …
The `Camera` component in the Sofa.Component.Visual module is responsible for rendering the simulation scene from a specified location and orientation. It inherits from `BaseCamera`, providing basic c…
The `CenterPointTopologicalMapping` component is part of the SOFA framework and resides in the `sofa::component::topology::mapping` namespace within the module `Sofa.Component.Topology.Mapping`. This …
The `CentralDifferenceSolver` is an explicit time integrator in the SOFA framework, specifically designed for forward integration methods such as central difference (also known as Verlet or Leap-frog)…
<p>The <code>ClangStyleMessageFormatter</code> is part of the SOFA framework's logging system, specifically within the <code>sofa::helper::logging</code> namespace. It inherits from the <code>MessageF…
The `CleanupVisitor` is a class in the SOFA framework under the `sofa::simulation` namespace, inheriting from the `Visitor` class. Its primary role is to facilitate the cleanup process by traversing a…
The **ClipPlane** is a component in the SOFA framework that defines an arbitrary clipping plane for OpenGL rendering, allowing users to visually slice or clip parts of a 3D scene. It inherits from `Vi…
The `ClusteringEngine` is part of the `sofa::component::engine::analyze` namespace in the SOFA framework and is designed to group points into overlapping clusters based on user-defined parameters such…
The `CollisionAnimationLoop` is a component in the SOFA framework, specifically part of the Sofa.framework.Simulation.Core module. It inherits from `BaseAnimationLoop` and is responsible for managing …
The `CollisionBeginEvent` is part of the SOFA simulation module and serves as an event fired by the `CollisionVisitor` before initiating the collision detection step in simulations involving collision…
The `CollisionEndEvent` is an event class in the SOFA framework, defined within the `sofa::simulation` namespace and part of the `Sofa.framework.Simulation.Core` module. It inherits from the base `Eve…
The CollisionModel is an abstract base class in SOFA (Simulation Open Framework Architecture) used to represent collision geometry for physics simulations. It serves as the foundation for various type…
The CollisionResponse class manages the response to collisions between collision models in SOFA (Simulation Open-Framework Architecture). It inherits from core::collision::ContactManager and is respon…
The `ColourPickingVisitor` is part of the SOFA GUI ecosystem and extends the `simulation::Visitor` class to facilitate colour-based picking in collision models. It is used for rendering collision mode…
The `CompareTopology` component in the SOFA framework is designed to compare topology containers from a reference frame to an associated Topology at each timestep. It extends the functionality provide…
The `ComplementaryROI` component is part of the SOFA framework and operates within the engine/select module, inheriting from `DataEngine`. Its primary role is to find points that are not included in s…
The CompositeLinearSystem is a component in the SOFA (Simulation Open-Framework Architecture) that acts as a linear system but delegates its functionalities to multiple underlying linear systems, allo…
The `CompositingVisualLoop` is a visual management loop in the SOFA framework, specifically within the rendering and shader components (namespace: sofa::gl::component::shader). It enables multipass re…
The `CompressedRowSparseMatrixConstraint` is a specialized sparse matrix implementation in the SOFA Linear Algebra framework, derived from `CompressedRowSparseMatrixGeneric`. This component manages co…
The `CompressedRowSparseMatrixGeneric` is a generic compressed row sparse matrix (CRS) implementation used in the SOFA framework's Linear Algebra module. It provides efficient storage and operations f…
This class is a specific implementation of the Compressed Row Sparse (CRS) matrix format tailored for mechanical systems in the SOFA framework. It extends functionality to support various block sizes …
The `ConfigurationSetting` class in the SOFA framework serves as a base class for all configuration settings within SOFA. It inherits from `BaseObject`, which is part of the core object model in SOFA,…
The Conical Force Field is a force field in the SOFA physics engine that applies outward repulsion based on a cone geometry. This component can be used to model forces emanating from or acting against…
The ConstantForceField is a force field component in the Sofa physics engine that applies constant forces to specified degrees of freedom (DOFs) within a simulated object or system.
This component is a specialized linear system designed to take advantage of the constant sparsity pattern in the global matrix assembly process, which can significantly speed up simulation performance…
The `ConstantSparsityProjectionMethod` is a component in the SOFA framework under the namespace `sofa::component::linearsystem`, part of the module `Sofa.Component.LinearSystem`. It extends the `Matri…
The `ConstraintAnimationLoop` is an advanced simulation loop manager in the SOFA framework, designed to handle complex constraint resolution and collision detection efficiently. It inherits from `Coll…
The `ConstraintAttachButtonSetting` is a GUI component in SOFA designed to modify mouse picking behavior, enabling the attachment of an object to the mouse using Lagrangian-based constraints. This com…
The `ConstraintCorrection` component in the SOFA framework is responsible for computing constraint forces within a simulated body using the compliance method. It inherits from `BaseConstraintCorrectio…
The `ConstraintParams` class in the SOFA (Simulation Open-Framework Architecture) framework is designed to gather and manage parameters used by constraint components during mechanical computations. It…
The `ConstraintSolver` is a core SOFA component responsible for expressing and solving systems of equations related to constraints in the simulation framework. It inherits from `BaseObject` and provid…
The ConstraintSolverImpl is an abstract class in the SOFA (Simulation Open-Framework Architecture) framework that serves as a base for implementing constraint solvers within the Lagrangian solver cont…
The `ConstraintStoreLambdaVisitor` is a visitor class in the SOFA framework, specifically designed to handle Lagrangian constraints within the constraint solver module. This class inherits from `BaseM…
The `Contact` component in the SOFA framework is responsible for handling contact response between pairs of models. It is dynamically created by the `ContactManager`, and it persists across iterations…
The `ContactIdentifier` is a component in the SOFA framework used to uniquely identify contact points in collision detection and response systems. It belongs to the `sofa::component::collision::respon…
<p>The `ContactListener` is an utility component in the SOFA framework, designed to retrieve and store information about contacts between collision models.</p> <p>It inherits from `BaseObject`, which…
The `ContextObject` class in the SOFA framework is a base class for simulation objects that modify the shared context, such as gravity or local coordinate systems. It inherits from `BaseObject`, which…
The `Controller` class in the SOFA framework serves as an interface for user interaction with SOFA components, including handling various types of events such as mouse, keyboard, joystick, and haptic …
The `CpuTask` class in the SOFA framework serves as a base for implementing tasks that run on the CPU. It inherits from the `Task` class and is designed to handle all tasks executed on the CPU within …
The Cube Collision Model is a hierarchical bounding volume representation used in collision detection for physics simulations and computer graphics applications. It constructs a tree-like structure wh…
The `CubeTopology` component in the SOFA framework represents the surface topology of a cube in 3D, encompassing points, edges, and quads. It inherits from `MeshTopology`, which is part of the `Sofa.C…
This component represents a collection of cylinders in the simulation, used for collision detection and visual representation. Each cylinder is defined by its center position, radius, height, and orie…
The `CylinderGridTopology` is a SOFA component that defines the topology of a cylindrical grid in 3D space. It inherits from `GridTopology`, providing specific functionalities for cylinder-shaped grid…
The `CylinderVisualModel` is a visual representation component in the SOFA ecosystem designed to visualize sets of cylinders within simulations. It inherits from the `core::visual::VisualModel` and im…
The `DAGSimulation` class is the main controller of the scene in the SOFA framework, derived from the `BaseObject`. It defines how the scene initializes at the start and updates at each time step, fac…
A `DDGNode` is a vertex in the data dependencies graph used by SOFA to manage data updates when changes occur. It forms part of the implementation for DataEngines and other data update mechanisms. Th…
The **DampVelocitySolver** is not an ODE solver but serves as a post-processing tool to reduce and threshold velocities in SOFA simulations. It inherits from `OdeSolver`, facilitating its integration …
The `Data` component in the SOFA framework is a fundamental template class used to encapsulate member variables for Sofa components, allowing dynamic and generic access at runtime. It serves as a cont…
The `DataCallback` component in SOFA is designed to associate callbacks with sets of data. When any associated input data changes, the registered callback functions are triggered. This mechanism allow…
The `DataDisplay` component in the SOFA framework is part of the Sofa.GL.Component.Rendering3D module and provides functionality for color rendering of data associated with a mesh. It inherits from `V…
The `DataEngine` is an abstract class in the SOFA framework, designed to compute sets of Data outputs based on given Data inputs. It inherits from `BaseObject`, indicating that it integrates into the …
The `DataExchange` component is part of the MultiThreading plugin in SOFA and is designed for data memory sharing within multi-threading applications. This component facilitates copying data from one …
The `DataLink` class in the SOFA framework is responsible for establishing and managing connections between two objects of type `Data<XXX>`. It implements the `AbstractDataLink` interface, providing f…
The `DebugMSContraction` component in the SOFA framework applies contraction forces along fiber directions in tetrahedral meshes, coupling with a Mitchell-Schaeffer (MS) model. It inherits from `BaseT…
This component is responsible for driving the animation loop in Sofa simulations by triggering several critical steps to compute collision detection, solve physics equations, update simulation context…
The `DefaultMultiMatrixAccessor` is a class in the SOFA framework responsible for managing the global matrix setup, which includes contributions from multiple mechanical states and interactions betwee…
The `DefaultStyleMessageFormatter` is a class in the SOFA framework, specifically within the `sofa::helper::logging` namespace. It inherits from `MessageFormatter` and provides a simple style for form…
The `DefaultTaskScheduler` is a part of the SOFA framework's simulation module, specifically under the `sofa::simulation` namespace within the `Sofa.framework.Simulation.Core` module. It inherits from…
The `DefaultVisualManagerLoop` is a core component in the SOFA framework, specifically designed for managing the visual loop when no custom VisualManager is defined by the user. It inherits from the `…
The `DeleteVisitor` is a component in the SOFA framework under the namespace `sofa::simulation`, part of the `Sofa.framework.Simulation.Core` module. It inherits from the `Visitor` class and is respon…
The `DetachNodeEvent` class in the SOFA framework is an event that signifies a child node is being detached from the scene graph. This event plays a critical role in maintaining the integrity and cons…
The `DiagonalMass` component in the SOFA framework is designed to compute a lumped (diagonalized) mass matrix by integrating a density over a domain's volume. This mass computation assumes that the ma…
The `DiagonalVelocityDampingForceField` is a component in the SOFA framework designed to apply velocity damping forces to specified degrees of freedom, contributing to more realistic dynamics by simul…
The **DifferenceEngine** is a component in the `sofa::component::engine::transform` namespace, part of the Sofa.Component.Engine.Transform module. This engine computes the difference between two vecto…
The `DirectSAP` component in the SOFA framework is used for collision detection using the Sweep and Prune (SAP) algorithm. It serves as a bridge between broad-phase and narrow-phase collision detectio…
This component implements the direct version of Sweep and Prune (SAP) collision detection algorithm for narrow phase processing.
The DiscreteIntersection class is part of the SOFA (Simulation Open-Framework Architecture) framework and serves as an implementation for discrete collision detection between various geometric models,…
The `DispatchFromGlobalVectorToLocalVectorVisitor` is a component in the SOFA framework under the namespace `sofa::component::linearsystem`. This visitor is part of the Sofa.Component.LinearSystem mod…
The `DistanceMultiMapping` component in the SOFA framework is designed to map point positions from several mechanical states (mstates) to distances in distance units. It supports the mapping of points…
The `Distances` class in SOFA is designed to compute distances between sets of mechanical objects based on a grid. It inherits from `DataEngine`, which enables it to perform computations and update da…
The `DrawToolGL` class in SOFA is responsible for rendering various geometric shapes and text within the OpenGL context. It inherits from `DrawTool`, indicating that it provides functionality for draw…
The `DynamicSparseGridTopologyContainer` is part of the SOFA framework, specifically within the topology container module designed to handle dynamic sparse grid geometry. It inherits from the `Hexahed…
The `DynamicSparseGridTopologyModifier` is a SOFA component that modifies the topology by adding and removing hexahedral elements within a dynamic sparse grid. It inherits from `HexahedronSetTopologyM…
The `EPSExporter` is a component in the SOFA framework under the `vrender` namespace, inheriting from the `Exporter` class. Its primary role is to export simulation data into EPS (Encapsulated PostScr…
The `Edge2QuadTopologicalMapping` is a specific implementation in SOFA for converting an EdgeSetTopology to a QuadSetTopology, generating new degrees-of-freedom (DOFs) as the tubular skinning of the i…
The EdgePressureForceField class is part of the SOFA (Simulation Open-Framework Architecture) framework, which is used for modeling and simulation in various domains such as biomechanics and virtual r…
The `EdgeSetGeometryAlgorithms` class in the SOFA framework provides geometry information specifically for an edge topology, inheriting from `PointSetGeometryAlgorithms`. This class is designed to han…
The EdgeSetTopologyContainer is a topology container in the SOFA (Simulation Open Framework Architecture) framework that manages edges as topological elements.
The EdgeSetTopologyModifier component is part of the SofaFramework and is designed to modify the topology of an edge set in simulation environments, particularly useful for applications involving grap…
The `EigenVector` component is part of the SOFA framework's LinearAlgebra module, providing a container for Eigen library vectors. It inherits from `BaseVector`, offering methods to manipulate vector …
The `ElecIntegrator` component in the SOFA ecosystem is part of the SofaMitchellSchaeffer plugin and inherits from the `ForceField` class. Its primary role is to call an electrical (elec) model using …
The `ElecPMJCouplingForceField` is a SOFA component designed for bidirectional explicit electrical coupling between the three-dimensional (3D) myocardium modeled using the Mitchell-Schaeffer monodomai…
<h3>Role and Purpose in the SOFA Ecosystem</h3> The `Element` class, defined within the `sofa::topology` namespace, is a fundamental building block used to represent geometric elements (e.g., vertice…
The Ellipsoid Force Field is a force field component in the Sofa framework that applies outward or inward repulsion forces based on an ellipsoid geometry.
The `EulerExplicitSolver` is an ODE (Ordinary Differential Equation) solver in the SOFA framework, designed for simple explicit time integration. This component provides two variants of Euler methods:…
The Euler Implicit Solver is a time integrator that uses the implicit backward Euler scheme to solve dynamic systems. This method is unconditionally stable, making it suitable for stiff systems where …
The `Event` class in SOFA is the base class for all events that are received by objects within the framework. Its primary role is to propagate event notifications through the simulation pipeline until…
The `ExampleEngine` is an example template engine that demonstrates the usage of engines in the SOFA framework, specifically within the SofaTestPlugin module. It inherits from the `DataEngine` class a…
The `ExecParams` class in the SOFA framework is designed to gather parameters used by most components' methods and transmitted by all visitors. It manages execution modes, thread IDs, and ensures corr…
The `ExportGnuplotVisitor` is part of the SOFA framework's simulation module, designed to traverse and process nodes in the scene graph for exporting data to Gnuplot. This visitor inherits from the ba…
The `ExportVisualModelOBJVisitor` is a SOFA component designed to export visual models in OBJ format, which is commonly used for storing 3D geometry data. This visitor class inherits from the `Visitor…
The `Exporter` class in the SOFA framework, part of the vrender namespace, is designed to facilitate exporting simulation data to files. It provides methods for setting bounding boxes (`setBoundingBox…
The `ExtrudeEdgesAndGenerateQuads` component in the Sofa framework is designed to extrude a given set of edges along a specified direction and generate quads from these edges. This process involves cr…
The `ExtrudeQuadsAndGenerateHexas` component in the SOFA framework is designed to extrude a quad-based surface into a set of hexahedral elements, allowing for the creation of complex geometries from s…
The `ExtrudeSurface` component in the SOFA framework is designed to generate a 3D mesh by extruding the surface of an existing mesh. This process involves extending or pulling out parts of the surface…
The `FIGExporter` is a component within the SOFA framework's vrender namespace designed to export simulation data into FIG format, a vector graphics file format used for storing and displaying scienti…
The `Factory` class in the SOFA framework is a template-based mechanism designed to manage and create instances of objects dynamically based on registered keys. Its primary role is to facilitate objec…
This component implements a fast corotational finite element method for tetrahedral meshes, suitable for simulating deformable objects in real-time applications.
A bending force field for triangular meshes in SOFA physics engine.
The `FileAccess` class in the `sofa::helper::io` namespace is part of the Sofa framework and provides functionality for reading from and writing to files. It inherits from `BaseFileAccess`. The primar…
The `FilesRecentlyOpenedManager` class in the SOFA framework, located under the `sofa::gui::common` namespace and part of the `Sofa.GUI.Common` module, manages a list of recently opened files for the …
The `FillingConstraint` is part of the SofaTestPlugin module and inherits from `BaseOpenSurfaceConstraint`. It serves to apply surface constraints in simulations, particularly focusing on pressure and…
The `FixPickedParticleButtonSetting` is a component in SOFA's GUI module that allows for fixing a picked particle in space, effectively pinning it to its current position. It inherits from the `MouseB…
The `FixedLagrangianConstraint` is part of the SOFA framework and serves to fix Degrees of Freedom (DOFs) in a model, enforcing Lagrangian-based constraints on specified points or all points if config…
The Fixed Plane Projective Constraint is a constraint model in SOFA (Simulation Open-Framework Architecture) that restricts the movement of particles to lie within a defined plane or between two paral…
This component fixes certain degrees of freedom of the mechanical model to constant values.
The `FixedRotationProjectiveConstraint` is a SOFA component designed to prevent rotation around the X, Y, or Z axis for a given object in the simulation environment. It inherits from the `ProjectiveCo…
This constraint component in the Sofa framework is designed to fix the translational degrees of freedom (DOFs) of objects while allowing them to rotate freely. Specifically, it ensures that the object…
The `ForceFeedback` class is part of the SOFA framework's haptics module and serves as an abstract base class for implementing force feedback in simulations. Its primary role is to act as a controller…
The `ForceField` is an abstract class in the SOFA framework, designed to compute forces acting on simulated bodies using given degrees of freedom (DOFs). It inherits from `BaseForceField` and `SingleS…
The `FrameSpringForceField` is a SOFA (Simulation Open-Framework Architecture) component that simulates 6D springs between moving frames, typically used in rigid body dynamics simulations.
The `FreeMotionAnimationLoop` is an animation loop designed to handle simulations involving constraints in the SOFA framework. It inherits from the `CollisionAnimationLoop`, indicating it integrates c…
The FullMatrix class is part of the Sofa Linear Algebra module and provides an implementation for a full matrix container. This component is designed to store and manipulate dense matrices, which are …
The `FullVector` component in the SOFA framework is a templated class that provides an implementation for dense vectors used in linear algebra operations. It inherits from `BaseVector`, which suggests…
The GIDMeshLoader component in the SOFA framework is designed to load mesh data from files using the GID file format, which is commonly used for representing finite element models and simulations. Thi…
The `GLPickHandler` is part of the SOFA framework, specifically within the `sofa::qt` namespace. It inherits from the `PickHandler` class and is designed to handle picking operations in OpenGL context…
The `GUIEvent` class in the SOFA framework is designed to notify about interactions with the Graphical User Interface (GUI). It inherits from the base `Event` class and is part of the Sofa.framework.C…
The `GearSpringForceField` component in the SOFA framework simulates 6D springs between Rigid DOFs, providing both translational and rotational stiffnesses across different local axes. This component …
The `GenerateCylinder` component in the SOFA framework is an engine that generates a tetrahedral mesh representing a cylindrical shape. This component inherits from `DataEngine`, which enables it to p…
The `GenerateGrid` component is part of the SOFA framework and belongs to the `sofa::component::engine::generate` namespace within the `Sofa.Component.Engine.Generate` module. Its primary role is to g…
The `GenerateRigidMass` is an engine component in the SOFA framework, designed to compute the Rigid Mass properties (mass, volume, and inertia matrix) of a given mesh. It inherits from `DataEngine`, a…
This class generates an implicit surface mesh for use in simulations within the Sofa framework.
The GenericConstraintCorrection component is part of the SOFA (Simulation Open-Framework Architecture) framework. It computes constraint forces within a simulated body using the compliance method.
The `GenericConstraintSolver` is a SOFA component in the Lagrangian constraint solver module, designed to handle and solve general constraint problems involving constraints on degrees-of-freedom (DOFs…
The `GraphDataWidget` is a Qt-based widget in the SOFA framework, specifically part of the `sofa::qt` namespace. This component inherits from `SimpleDataWidget`, indicating it provides graphical user …
<description>The `GraphListenerQListView` is part of the SOFA framework's Qt module and inherits from the `MutationListener` class, indicating its role in listening to changes in the simulation graph.…
The **Gravity** component in SOFA is responsible for applying gravitational force to the simulation within world coordinates. It allows users to override the default gravity settings and specify custo…
The `GridMeshCreator` is a SOFA component that procedurally generates a two-dimensional triangular grid mesh. It inherits from the `MeshLoader` class and creates vertices within a specified resolution…
The `GroupFilterYoungModulus` is an engine in the SOFA framework designed to generate a vector of Young's moduli based on predefined groups of primitives. It inherits from `DataEngine` and operates wi…
The `HapticDeviceEvent` is an event class in the SOFA framework that notifies about interactions with haptic devices. It inherits from the base `Event` class and provides information about the device'…
The `HemodynamicConstraint` is a specialized constraint component in the SOFA framework, primarily designed for simulating hemodynamics and fluid dynamics within cardiovascular systems. It inherits fr…
The `HermiteSplineProjectiveConstraint` is a constraint component in the SOFA (Simulation Open-Framework Architecture) framework that imposes a trajectory on specified degrees-of-freedom (DOFs) follow…
The `Hexa2QuadTopologicalMapping` is a specific implementation within the SOFA framework that handles topological mappings between two types of mesh topology: **HexahedronSetTopology** (input) and **Q…
The `Hexa2TetraTopologicalMapping` component is part of the SOFA framework and serves as a topological mapping that converts a HexahedronSetTopology to a TetrahedronSetTopology. This conversion allows…
The `HexahedralFEMForceField` is a specialized force field component in SOFA's solid mechanics module, designed to compute finite element forces based on hexahedral elements (cubes). It inherits from …
HexahedralFEMForceFieldAndMass is a component in the SOFA (Simulation Open-Framework Architecture) framework designed for simulating solid mechanics with finite element methods based on hexahedral ele…
HexahedronCompositeFEMForceFieldAndMass is a non-uniform finite element method (FEM) force field component for hexahedral elements in the SOFA physics engine. It extends NonUniformHexahedronFEMForceFi…
The HexahedronFEMForceField component computes finite element forces based on hexahedral elements using the corotational formulation. It is commonly used in simulating deformable bodies with tetrahedr…
This component computes finite element forces based on hexahedral elements and includes continuum mass matrices for more accurate physical simulations.
The `HexahedronSetGeometryAlgorithms` component is part of the SOFA framework and provides geometry-related information for hexahedral topologies in simulation scenarios. It inherits from `QuadSetGeom…
The Hexahedron Topology Container in SOFA (Simulation Open Framework Architecture) is designed to manage and manipulate hexahedral mesh topologies, which are commonly used for volumetric simulations d…
This is an advanced container for managing topological data in simulations involving hexahedral (3D cuboid) elements. It extends the QuadSetTopologyContainer to support not only quadrilateral but also…
The `IdentityTopologicalMapping` is a specific implementation within the SOFA framework, used for maintaining identical topology between a source and destination model. It inherits from `sofa::core::t…
The `IdleEvent` is part of the SOFA framework and belongs to the `sofa::core::objectmodel` namespace within the `Sofa.framework.Core` module. It inherits from the `Event` class, which means it handles…
The `sofa::helper::io::Image` class in SOFA is designed for handling image data, including loading and saving images with various formats and types (e.g., compressed or uncompressed). This component p…
The `ImageRAW` class in the SOFA framework (`sofa::helper::io`) inherits from the `Image` base class and handles reading and writing raw image data. It manages both the header information and pixel da…
The `ImprovedJacobiConstraintSolver` is a constraint solver component in the SOFA framework, designed to solve constraint-based components using a Projected Jacobi iterative method. It inherits from `…
The `InciseAlongPathPerformer` is a component designed to perform incisions (topological cuts) along a path defined by user interactions in a simulation environment, such as within the SOFA framework.…
Implementation of incremental sweep and prune (ISAP) collision detection algorithm in SOFA physics engine.
The `IndexValueMapper` is a component in the SOFA framework that serves as an engine for mapping input values to output values based on specified indices. It inherits from `DataEngine`, indicating its…
The `Indices2ValuesMapper` is a SOFA engine component designed to map input indices to corresponding values, producing an output vector of mapped values. It inherits from the `DataEngine` class and op…
The `IndicesFromValues` component in the Sofa framework is an engine designed to find and return the indices of specified values within a larger set of global values. It inherits from `DataEngine`, in…
The `InfoComponent` in the SOFA framework is designed to retain information and error messages within the scene graph. Despite its seemingly passive role—it does not perform any active computations or…
The `InitVisitor` is a core component in the SOFA framework, responsible for initializing a newly created or modified scene graph. It inherits from the `Visitor` class and implements methods to proces…
The `InputEventReader` component in SOFA reads input events from a specified file (e.g., `/dev/input/eventX`) and propagates them as SOFA MouseEvents within the simulation framework. It is part of the…
The **InspectorDock** is a user interface component within the SOFA framework, specifically designed for visualization and interaction purposes. It resides in the `Ui` namespace and is implemented in …
The `IntegrateBeginEvent` is an event in the SOFA simulation framework, specifically part of the `sofa::simulation` namespace within the `Sofa.framework.Simulation.Core` module. It inherits from the b…
The `IntegrateEndEvent` is an event in the SOFA simulation framework, specifically designed to be fired by the `IntegrateVisitor` after completing its integrate detection step. This event inherits fro…
This component applies an outward or inward repulsion force based on an ellipsoidal geometry to interact with other objects in the simulation.
The `InteractionPerformer` is a class in the SOFA framework under the namespace `sofa::gui::component::performer`, part of the module `Sofa.GUI.Component`. It acts as an abstract base class for intera…
The `InteractiveCamera` is a camera class in the SOFA framework that allows for interactive control using mouse and keyboard inputs.
The `IntrusiveObject` class in the SOFA framework is designed to implement an internal reference counting mechanism for managing its own lifetime. This mechanism works in conjunction with intrusive sm…
The `JoinPoints` component in SOFA is designed to merge points from a set of input points if they are within a specified distance, effectively reducing the number of points while maintaining their ave…