How to use

This light tutorial reviews the whole project API to create 3D objects and export them in HTML.

Step 1: Create the Exporter

The Exporter class is the main user API to create and export 3D objects:

from SimExporter.Core import Exporter

exporter = Exporter(animation=True,
                    fps=30)

The animation option defines if the exported output will be a static 3D plot or an animation (in that case, the frame rate fps can be specified).

The Exporter exposes the methods to create several 3D objects in the objects attribute.

Adding mesh with objects.add_mesh:

exporter.objects.add_mesh(positions=my_mesh_positions,
                          cells=my_mesh_cells)

Adding points with objects.add_points:

exporter.objects.add_points(positions=my_points_positions)

Adding arrows with objects.add_arrows:

exporter.objects.add_arrows(positions=my_arrows_positions,
                            vectors=my_arrows_vectors)

Adding standard k3d objects with objects.add_k3d_objects:

import k3d

lines = k3d.lines(vertices=my_lines_vertices,
                  indices=my_lines_indices)
exporter.objects.add_k3d_objects(lines)

Finally, the call to to_html will export the 3D scene in HTML:

exporter.to_html(filename='scene.html')

To include an exported animation, you can simply use an HTML Iframe:

<iframe src="animation.html" height="600px" width="100%"></iframe>