Skip to content

Commit dca1333

Browse files
committed
even more doc
1 parent 809a490 commit dca1333

File tree

1 file changed

+20
-3
lines changed

1 file changed

+20
-3
lines changed

README.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,21 @@
66
[![Support us](https://img.shields.io/badge/support_us-on_Github_Sponsor-purple.svg)](https://github.com/sponsors/InfinyTech3D)
77

88
## Description
9-
This is a SOFA plugin (https://github.com/sofa-framework/sofa) that provides a customized collision pipeline, tailored for needle insertion simulations.
9+
This is a SOFA plugin (https://github.com/sofa-framework/sofa) that provides a customized collision pipeline,
10+
tailored for needle insertion simulations.
11+
Combined with SOFA's haptic device plugins, it offers users tactile feedback during tissue puncture, including friction and lateral movement blocking during insertion.
12+
and insertion procedures.
13+
14+
This plugin has already been integrated in Unity via the SOFA-Unity plugin by InfinyTech3D for an enhanced simulation experience.
15+
Contact us for more information!
16+
17+
## Features
18+
19+
The enhanced collision pipeline supports the detection of
20+
primitive proximities which are then used to enforce contact and insertion constraints on the needle.
21+
A dedicated insertion algorithm handles the management of needle simulation phases: tissue punture, insertion and retraction.
22+
Users can experience tactile feedback with resistance and relief during tissue punctures and
23+
lateral movement blocking of the needle during an insertion.
1024

1125
## Installation and Setup
1226

@@ -25,7 +39,8 @@ https://sofa-framework.github.io/doc/plugins/build-a-plugin-from-sources/
2539
- Compile SOFA solution (the plugin will be compiled as well)
2640

2741
> [!IMPORTANT]
28-
> In order to use the plugin, make sure that you have also built the [`ConstraintGeometry`](https://github.com/InfinyTech3D/ConstraintGeometry) plugin.
42+
> In order to use the plugin, make sure that you have also built the
43+
[`ConstraintGeometry`](https://github.com/InfinyTech3D/ConstraintGeometry) plugin.
2944

3045
Supported SOFA versions: > v25.06
3146

@@ -41,4 +56,6 @@ Supported SOFA versions: > v25.06
4156
- Files for automated regression testing in alignment with SOFA's testing framework
4257

4358
## Acknowledgments
44-
This project builds upon the original repository from [ICube Laboratory, University of Strasbourg](https://icube.unistra.fr/en/) and extends it with a needle insertion algorithm and additional functionality.
59+
This project builds upon the original repository from
60+
[ICube Laboratory, University of Strasbourg](https://icube.unistra.fr/en/)
61+
and extends it with a needle insertion algorithm and additional functionality.

0 commit comments

Comments
 (0)