How to install

Once you receive the SofaUnity package, unzip the Unity3D package and follow those steps :

  1. From Unity3D, open your project or create a new 3D project. Use normal or HDRP project depending on the package version you requested.
  2. In Unity3D Editor, use Assets -> Import Package -> Custom Package and load the .unitypackage.

 

 

3. Once the package has been fully loaded, place the license file inside {your Unity3D project}/Assets/SofaUnity/License/. Replace the existing file if needed.

4. Finally, check the config file: {your Unity3D project}/Assets/SofaUnity/Plugins/Native/x64/sofa.ini

It should contain 2 lines leading to your project path. It should looks like this:

SHARE_DIR=C:/projects/Unity/SofaUnity_default/Assets/SofaUnity/scenes/SofaScenes

EXAMPLES_DIR=C:/projects/Unity/SofaUnity_default/Assets/SofaUnity/scenes/SofaScenes

5. Change those paths if you want to use another directory where you store your SOFA scenes and meshes.

Several API levels

Once ready to be used the SofaUnity asset folder should look like this:

  • License :  où placer le fichier de licence.
  • Plugins
    • Native :  dossier des fichiers dll x64 SOFA.
    • SofaUnityAPI :  scripts d’API s’interfaçant avec la bibliothèque Sofa.
    • SU_Geomagic :  plugin spécifique, contient des scripts et des scènes pour la prise en charge des appareils Geomagic.
    • SU_XRay :  Plugin spécifique, contient des scripts et des scènes pour la simulation XRay.
    • Virtual Capsule Endoscopy :  plugin spécifique pour la simulation d’endoscopie.
  • Ressources :  Matériaux, textures et images Unity.

  • Scènes

    • Benchmarks :  Quelques scènes spécifiques pour les tests de benchmark.
    • Démos :  Toutes les scènes de démonstration décrites dans la section Exemples.
    • SofaScenes : Fichiers  Sofa .scn avec leurs données.
  • Scripts : toutes classes d’assets en C# :
    • Core :  classe pour représenter les objets SOFA à l’aide de Unity3D GameObject
    • Editor :  classe pour implémenter les inspecteurs Objects Unity Editor
    • Modules :  Classes spécifiques héritant des classes Core
    • Interface utilisateur : interface  utilisateur 3D contrôlant le lecteur SOFA dans le jeu.
    • Utils :  Scripts de composants/algorithmes utiles.