Tutorial
==============================

In this tutorial we are going to assemble a simple scene containing a deformable object colliding with static scenery. The completed tutorial is available as the *Tutorial* scene in the scene folder.

For the purpose of this guides component names will be written in a mono-spaced font e.g. ``SimulationManager``, whereas the names of GameObjects or EditorFields will be in italics e.g. `HeartModel`

- Create a new scene in Unity

- Set the `Main Camera` transform to the values as seen in the image below
  
  .. image:: media/guide/camera.png
     :align: center
     :alt: Camera Parameters

- Create a new gameobject and add a ``SimulationManager`` component to it
  
  The ``SimulationManager`` is a required component for all simulations using iMSTK-Unity, it controls initialization and updates and also lets you set a number of global variables. Set up the manager parameters as shown in the picture by checking the `Use Realtime` checkbox.

  .. image:: media/guide/simulationmanager.png
     :align: center
     :alt: SimulationManager Component UI

- Create an empty GameObject, add a ``PBDModel`` component and name it `HeartModel`. 
   
   ``PBDModel`` is one of the classes that iMSTK-Unity offers, it implements the PBD [#]_ and XPBD [#]_ methods for simulating deformable objects.

   We will add geometry separately but you can also use the items under the menu `iMSTK\\GameObject` to add very simple objects with algorithmically generated meshes. 
   
   The ``PBDModel`` has a large number of parameters but we will focus only on a few. This will eventually become a deformable object but there is still a lot of work to do. For more information look at the `iMSTK Documentation <https://imstk.readthedocs.io/en/latest/PbdModel.html>`_

   We will come back to this later.
   
- From the *Models* folder add model named `heart` under the `HeartModel` GameObject

   This will serve as the visual representation of what the simulation is doing, to make it look better, get the `flesh` material from the *Materials* folder and assign it as well.

   With the `heart` GameObject selected add a ``GeometryFilter`` component to it and drag the `MeshFilter` component, the name will be `Heart_mesh_surface (Mesh Filter)` into the `Mesh` field of the ``GeometryFilter``. The drop down menu should say `Unity Mesh`. This makes this mesh available to iMSTK-Unity.

   For every kind of geometry you want to use in the PBD model, iMSTK-Unity needs a ``GeometryFilter``. This maps the Unity type to something that iMSTK can understand. It can also be used to define fixed shapes like Plane or Capsule. For meshes the source of a Geometry filter can either be a Unity mesh in the scene, a mesh asset, or (especially for tetrahedral meshes) an asset imported by the geometry importer of iMSTK-Unity.

   You can use the check box named `Show Handles` to verify that the mesh is in the correct location

  .. image:: media/guide/geomfilter_heart_surface_drag.png
     :align: center
     :alt: Drag Meshfilter into Geometryfilter

- Set up the parameters for our ``PBDModel``

  First check the `Distance Stiffness`, `Volume Stiffness` and `Use Realtime` checkboxes and fill in the properties as you see in the image below. This sets the material properties of this object. Uncheck all other stiffness options

  .. image:: media/guide/heartmodel.png
     :align: center
     :alt: PBModel overview

- Add a ``GeometryFilter`` to use in the simulation
  
  We will need a mesh to use as the geometry for calculating the physical behavior of our object. Add a ``GeometryFilter`` to the `HeartModel` object. As we will use a tetrahedral mesh, the method to assign the mesh is slightly different than what we used before. First Select `Tetrahedral Mesh` in the drop down menu. Then click on the `o` icon to the right of the `Mesh` input field. This will bring up an input dialog. Select the "Assets" tab, and double click the item name `heart_mesh`. 
  
  As you can see the ``GeometryFilter`` component can be used for meshes in the scene or just assets of the project. 

  .. image:: media/guide/heart_mesh_tetrahedral.png
     :align: center
     :alt: Tetrahedral Mesh Geometry Filter

- Now we will set the shapes that are being used for simulation and visualization.
  
  The ``PBDModel`` uses three different geometries 

  - `Visual Geometry` is the geometry that is being shown on the screen, this is usually some textured mesh
  - `Physics Geometry` is the geometry that is being used in the simulation
  - `Collision Geometry` is the geometry that is being used to determine collisions with other objects.
  
  The tetrahedral mesh that was set up in the previous step will be used for the `Physics Geometry`; the other mesh from earlier will be used for the two other geometries. 

  First Drag the ``Geometry Filter`` that you just created into the `Physics Geometry` of the ``PBDModel`` component. Then drag the `heart` GameObject from the hierarchy view to both the `Visual Geometry` and the `Collision Geometry` fields. 
  
  .. image:: media/guide/heart_gameobject_drag.png
   :align: center
   :alt: Assign Visual Geometry

  As we used different geometries for visualization and simulation we need a way to keep those in the same state, this is the responsibility of the ``GeometryMap`` component. Add one and drag the `HeartModel` Gameobject into the `Parent Geom` slot. Then drag the `heart` GameObject into the `Child Geom` slot. Additionally make sure the `Force One One` is checked. 

  .. image:: media/guide/deformable_map.png
     :align: center
     :alt: Deformable Map

This concludes the setup for the ``PBDModel`` object.

You should be able to run the scene now but as there are no other objects to interact with the heart will just succumb to gravity and drop on the ground.

- Let's add a plane for collisions

  Instead of meshes we will use a fixed shape for the other side of the collision. In the hierarchy view add a Plane and move it to a position of 0.0, -2.5, and 0.0. Add a ``Geometry Filter`` to the plane object and select `Plane` in the drop down menu. The default settings for the plane will work, its position and normal will be calculated from the transform. Even though the visual mesh of the plan is finite in the editor, with regards to iMSTK this plane is infinite.

  To enable the plane to interact with other iMSTK objects we need to set up a model for it as well. Add a ``StaticModel`` component to the `Plane` object and drag the ``GeometryFilter`` component into the `Collision Geometry` field. A ``StaticModel`` represents an object that participates in collision but doesn't react.

  .. image:: media/guide/plane-static-model.png
     :align: center
     :alt: Plane Object

- Add the interaction between the Heart and the Plane
  
  iMSTK needs to know about which objects can interact with each other, in this case we want the heart and the plane to collide with each other. Add a ``CollisionInteraction`` to the plane object. Drag the `HeartModel` into the slot named `Model 1` and drag the plane itself into the slot named `Model 2`. The drop down menu named `Collision Type` can be left in the setting `Auto`. At the moment there is most likely no need to select the `Collision Type` yourself, the automatic mechanism should be sufficient.
  
  .. image:: media/guide/collision_interaction.png
     :align: center
     :alt: Adding a collision interaction

- This concludes the tutorial scene setup, press play you should see the deformable object hit the plane and bounce slightly on it. 
  
  .. image:: media/guide/heart_final.png
     :align: center
     :alt: The final result

.. compound::

   Please note that at the moment iMSTK-Unity is very sensitive to misconfigurations and may cause Unity to crash, we are working to improve the error handling and stability both on the Unity asset side and inside the iMSTK sources.

Example Scenes
==============================


PbdClothCollision
------------------------------
A scene with a freely moving deformable item (Cloth) that demonstrates how to set up a deformable (``PBDCloth``) with and various static obstacles.

PbdClothScene
------------------------------
A cloth constrained on the top that demonstrates how to set up boundary conditions on a ``PbdObject``

PbdThread
------------------------------
This demonstrates a line mesh that can be used as a thread

RbdScene
------------------------------
This is a simple example of two rigid spheres colliding with each other and the scenery. Uses geometric shapes rather than meshes, static colliders and collisions between dynamic objects

Tutorial
------------------------------
A scene that is used in the tutorial. It uses a deformable model colliding with a plane


Devices 
------------------------------

The scenes in the devices folder can only be used with VRPN or OpenHaptics built. You will have to build iMSTK and install it into the asset as described in :ref:`SetupForDevelopment` to support these features

RbdController
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
This sets up a ``OpenHapticsDevice`` with a ``RbdModel`` and a ``RigidController`` to show how these pieces are interactive

RbdControllerVRPN
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Uses the ``VRPNDevice`` in the same scene as the `RBDController`

TissueContact and PbdThinTissueContact
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Demonstrates the use of a rigid with haptics interacting with two kinds of simulated tissue


.. [#] M. Müller, B. Heidelberger, M. Hennix, and J. Ratcliff, “Position based dynamics,” Journal of Visual Communication and Image Representation, vol. 18, no. 2, pp. 109–118, Apr. 2007, doi: 10.1016/j.jvcir.2007.01.005.

.. [#] M. Macklin, M. Müller, and N. Chentanez, “XPBD: position-based simulation of compliant constrained dynamics,” in Proceedings of the 9th International Conference on Motion in Games, Burlingame California, Oct. 2016, pp. 49–54. doi: 10.1145/2994258.2994272.