diff --git a/CMakeLists.txt b/CMakeLists.txt index a9a8b6a..5c39677 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -90,7 +90,7 @@ if (MeshRefinement_FOUND) add_definitions(-DHAS_MESHREFINEMENT_PLUGIN) endif() -set(README_FILES PluginInfinyToolkit.txt) +set(README_FILES README.md) # Create the plugin library. add_library(${PROJECT_NAME} SHARED ${HEADER_FILES} ${SOURCE_FILES} ${README_FILES}) diff --git a/PluginInfinyToolkit.txt b/PluginInfinyToolkit.txt deleted file mode 100644 index 709236f..0000000 --- a/PluginInfinyToolkit.txt +++ /dev/null @@ -1,27 +0,0 @@ -############################################################################## -# Copyright (C) - InfinyTech3D - All Rights Reserved # -# # -# Unauthorized copying of this file, via any medium is strictly prohibited # -# Proprietary and confidential. # -# # -# Written by Erik Pernod , September 2019 # -############################################################################## - -************************************ -* PluginSleeve.txt * -************************************ - - - -AUTHOR : - - Erik Pernod (erik.pernod@gmail.com) - - - - -LICENCE : - - None - - - -OTHER COMMENTS : diff --git a/README.md b/README.md index 0102a3c..b16084d 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,32 @@ -# InfinyToolkit +# InfinyToolkit SOFA plugin + +[![Documentation](https://img.shields.io/badge/info-on_website-green.svg)](https://infinytech3d.com/) +[![Support](https://img.shields.io/badge/support-on_GitHub_Discussions-blue.svg)](https://github.com/sofa-framework/sofa/discussions) +[![Gitter](https://img.shields.io/badge/chat-on_Gitter-ff69b4.svg)](https://app.gitter.im/#/room/#sofa-framework:gitter.im) ## Description -This repository gather all open code from InfinyTech3D that could be of any use with the https://www.sofa-framework.org/ +This repository gather all open code from InfinyTech3D that could be of any use for the https://www.sofa-framework.org/ Either as components or script. This repository should be sued as a external SOFA plugin. - ### Features Several components are still work in progress or just benchmarks. Here are the components that can be highlighted: -- **MiddleForceField:** basically compute a force field to a barycentric coordinate. Can be useful to fake a simple breathing or beating motion. + +- **MiddleForceField:** basically compute a force field to a barycentric coordinate. Can be useful to fake a simple breathing or beating motions. + + - **RotationEngine:** allows to apply a succession of rotation to an object. - **Triangle2RefinedTriangleTopologicalMapping:** define a topological mapping between a coarse triangulation to a refined triangulation. + +||| +|--|--| +| Triangle coarse mesh | Mapped triangle refined mesh | + - **NearestTexcoordsMap:** define a mapping for texture coordinates from a surface mesh (obj) to the surface of a volume mesh. + +|||| +|--|--|--| +| NearestTexcoordsMap textures| NearestTexcoordsMap wireframe | textures coordinates mapping| + - **AdvancedCarvingManager:** another version of the SOFA carving manager with several options using performer classes: - SimpleCarvingPerformer: similar to SOFA carving manager - SurfaceCarvingPerformer: will push the surface without removing element to fake a progressive carving @@ -18,10 +34,15 @@ Several components are still work in progress or just benchmarks. Here are the c - RefineCarvingPerformer: will refine the volume mesh before carving (using [MeshRefinement plugin](https://github.com/InfinyTech3D/MeshRefinement)) - CuttingPerformer: will define a fine cut or incision in the mesh (using [MeshRefinement plugin](https://github.com/InfinyTech3D/MeshRefinement)) + ### Architecture - **examples:** with several examples of the components and some benchmarks. -- **scripts:** a bunch of python scripts to apply changes to the SOFA code base or scenes. Such as changing requiredPlugin, updating components names, headers inclusion, etc. +- **scripts:** a bunch of python scripts to apply changes to the SOFA code base or scenes. Such as: + - Changing requiredPlugin in scenes + - Updating components names + - Update headers inclusion + - ... - **src/InfinyToolkit:** All the source code of the SOFA components. @@ -31,4 +52,4 @@ See SOFA documentation for more information ## License This work is dual-licensed under either [GPL](https://github.com/InfinyTech3D/Tearing/blob/main/LICENSE.md) or Commercial License. -For commercial license request, please contact us by email at contact@infinytech3d.com \ No newline at end of file +For commercial license request, please contact us by email at contact@infinytech3d.com diff --git a/doc/MeshRefinement_AdvancedCarving_penetration.gif b/doc/MeshRefinement_AdvancedCarving_penetration.gif new file mode 100644 index 0000000..3905066 Binary files /dev/null and b/doc/MeshRefinement_AdvancedCarving_penetration.gif differ diff --git a/doc/MiddleForceField.gif b/doc/MiddleForceField.gif new file mode 100644 index 0000000..fe0573c Binary files /dev/null and b/doc/MiddleForceField.gif differ diff --git a/doc/NearestTexcoordsMap_mapping.jpg b/doc/NearestTexcoordsMap_mapping.jpg new file mode 100644 index 0000000..c67845a Binary files /dev/null and b/doc/NearestTexcoordsMap_mapping.jpg differ diff --git a/doc/NearestTexcoordsMap_textures.jpg b/doc/NearestTexcoordsMap_textures.jpg new file mode 100644 index 0000000..810c9b2 Binary files /dev/null and b/doc/NearestTexcoordsMap_textures.jpg differ diff --git a/doc/NearestTexcoordsMap_wireframe.jpg b/doc/NearestTexcoordsMap_wireframe.jpg new file mode 100644 index 0000000..688cc3f Binary files /dev/null and b/doc/NearestTexcoordsMap_wireframe.jpg differ diff --git a/doc/Triangle2RefinedTriangleTopologicalMapping_coarse_mesh.jpg b/doc/Triangle2RefinedTriangleTopologicalMapping_coarse_mesh.jpg new file mode 100644 index 0000000..129bf39 Binary files /dev/null and b/doc/Triangle2RefinedTriangleTopologicalMapping_coarse_mesh.jpg differ diff --git a/doc/Triangle2RefinedTriangleTopologicalMapping_refine_mesh.jpg b/doc/Triangle2RefinedTriangleTopologicalMapping_refine_mesh.jpg new file mode 100644 index 0000000..fa97e06 Binary files /dev/null and b/doc/Triangle2RefinedTriangleTopologicalMapping_refine_mesh.jpg differ