Skip to content

Commit 218d38f

Browse files
committed
add usage examples
1 parent ca69ea9 commit 218d38f

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,15 @@ plugin by InfinyTech3D for an enhanced simulation experience. Contact us for mor
2323
- Support for haptic feedback such as resistance during puncture and friction during insertion
2424
- Compatible with SOFA-Unity integration for real-time interactive applications
2525

26+
## Usage
27+
28+
- To use the plugin, include the `CollisionAlgorithm` plugin in your SOFA scene file.
29+
``` <RequiredPlugin name=`CollisionAlgorithm`/> ``` for an .xml scene file.
30+
- Add the `CollisionLoop` component in the root node of your scene.
31+
``` <CollisionLoop/> ```
32+
This component substitutes the default `CollisionPipeline` in SOFA for managing the needle collision.
33+
The two components can co-exist.
34+
2635
## Installation and Setup
2736

2837
First review the official SOFA documentation for building and registering SOFA plugins

0 commit comments

Comments
 (0)