=========
SimRender
=========

**SimRender** is a Python module for creating **3D renderings** of **numerical simulations** in a **very few lines of
code**.

The main feature is that users can launch an **interactive 3D rendering window without blocking** the execution of the
python process.

The project is **compatible with any numerical simulation** written in Python and provides the
following list of features.
**Additional features** are also compatible with :SOFA:`SOFA <>` **numerical simulations**.

.. image:: _static/img/heart.gif


Features
--------

Main features:

* a **simple API** to create and update visual objects from simulated data;
* several **customizable visual objects**: meshes, point clouds, arrows, lines, 2D text;
* several available **viewers**:
    * `Viewer`: a simple rendering window to render the current state of a **single** numerical simulation;
    * `ViewerBatch`: an advanced rendering window to render the current state of **several** numerical simulations
      **simultaneously**;
    * `Player`: an advanced rendering window to **navigate** through the numerical simulation **time steps** (play/pause,
      back/forth).

SOFA compatible features:

* an enhanced API to **update** visual objects **automatically** with Data callbacks;
* an option to **render** the numerical simulation **completely automatically** given the **scene graph**;
* an enhanced `Player` to **select** the **displayed models** (incoming).


Gallery
-------

.. image:: _static/img/gallery.png



.. toctree::
    :hidden:

    Install          <install.rst>
    About            <about.rst>
    Getting started  <usage.rst>
    API              <api.rst>