Skip to content

Commit f2cd2d6

Browse files
committed
[scene] Update scene spaces and doc
1 parent 8ebefc5 commit f2cd2d6

File tree

1 file changed

+13
-7
lines changed

1 file changed

+13
-7
lines changed

README.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,32 +7,38 @@ This plugin interfaces [CGAL Skeletonization](https://doc.cgal.org/latest/Surfac
77

88
The build can be done In-tree or Out of tree, see SOFA [documentation](https://www.sofa-framework.org/community/doc/plugins/build-a-plugin-from-sources/).
99

10+
- CGAL version needed should be greater than 4.9
11+
- SOFA version compatible since v22.06
1012

1113

1214
## Usage
1315

1416
The example bellow store in the output file the skeleton of a the input vessel mesh.
1517
```xml
1618
<Node name="root" dt="0.01" gravity="0 -1 0">
17-
<VisualStyle displayFlags="showVisual showCollisionModels showWireframe"/>
18-
<RequiredPlugin pluginName="MeshSkeletonizationPlugin"/>
19-
<RequiredPlugin pluginName='SofaOpenglVisual'/>
19+
<VisualStyle displayFlags="showVisual showCollisionModels showWireframe"/>
20+
<RequiredPlugin name="Sofa.GL.Component.Rendering3D"/> <!-- Needed to use components [OglModel] -->
21+
<RequiredPlugin name="Sofa.Component.Visual"/> <!-- Needed to use components [VisualStyle] -->
22+
<RequiredPlugin name="Sofa.Component.SceneUtility"/> <!-- Needed to use components [InfoComponent] -->
23+
<RequiredPlugin name="Sofa.Component.IO.Mesh"/> <!-- Needed to use components [MeshOBJLoader] -->
24+
<RequiredPlugin name="MeshSkeletonizationPlugin"/>
2025

21-
<MeshObjLoader name="meshLoader" filename="../data/mesh/vessels.obj" />
26+
<DefaultAnimationLoop />
27+
<MeshOBJLoader name="meshLoader" filename="../data/mesh/vessels.obj" />
2228

2329
<MeshSkeletonization template="Vec3d" name="skeleton"
2430
inputVertices="@meshLoader.position" inputTriangles="@meshLoader.triangles"
25-
inputFile="../data/skeletons/output_vessels_skeleton.txt"
31+
outputSkeleton="../data/skeletons/output_vessels_skeleton.txt"
2632
/>
2733

2834
<Node name="visual">
2935
<OglModel src="@../meshLoader"/>
3036
</Node>
31-
37+
3238
</Node>
3339
```
3440

35-
It is important to specify the ```inputFile``` in which the plugin will write the centerlines.
41+
It is important to specify the Data ```outputSkeleton``` in which the plugin will write the centerlines.
3642

3743
This file will contain a set of points per polyline, polylines are separated by an empty line. Biforcation points can be found on their corresponant polylines.
3844

0 commit comments

Comments
 (0)