Slides 3D interactives

Avant de commencer

Le tutoriel est organisé en une suite d'exemples complets, du plus simple au plus avancé. Chaque exemple est un dossier que l'on peut télécharger, compiler, et montrer tel quel dans une slide, et chaque page affiche tous ses fichiers. Les exemples peuvent être suivis dans l'ordre, et vous pouvez vous arrêter dès que vous avez ce dont vous avez besoin.

Le principe

Une slide affiche de la 3D interactive de la même manière qu'un navigateur : sous forme de page web, à l'intérieur d'un cadre (<iframe>).

1. Votre programme, pour le web

Votre programme C++ OpenGL, compilé en WebAssembly par Emscripten : project.js, project.wasm.

2. La page de la démo

slide-frame.html : elle fait tourner le programme dans le cadre, et lui transmet les réglages de son adresse.

3. La slide

Un cadre affiche cette page ; des boutons de la slide peuvent la piloter, et les flèches passent toujours à la slide suivante.

Les slides du tutoriel sont faites avec reveal.js (chaque exemple a sa slide, slides.html), et les mêmes démos sont dans un exposé fait avec lhtml-site. Les deux sont en HTML, où le cadre est natif.

Quelques mots utilisés dans le tutoriel :

  • La démo : votre programme, compilé pour le web, qui tourne dans le cadre d'une slide.
  • La page de la démo : slide-frame.html, copiée à côté de la compilation du programme sous le nom index.html (c'est le web/index.html de chaque exemple).
  • Le pont : le petit morceau de code qui relie le programme et la slide : la page de la démo, et deux fichiers C++ (slide_bridge.hpp/.cpp) qui lisent les réglages dans le programme.
  • Le panneau : les curseurs et boutons que la page de la démo dessine par-dessus, à partir des réglages que déclare le programme (exemple 2).
  • Le poster : une image de la démo, utilisée dans le PDF des slides, où un programme ne peut pas tourner.
  • data-src (reveal.js) et demo:: (lhtml-site) : la manière dont chaque outil écrit le cadre d'une démo (plus bas).

Ce qu'il vous faut

Pour voir les démos dans leurs slides, seul Python 3 est nécessaire (étape Récupérer le code). Pour recompiler les exemples 1 et 2, il faut en plus un compilateur C++, CMake, GLFW et Emscripten ; pour les exemples 3 à 6, la bibliothèque CGP en plus.

  • Un compilateur C++ et CMake, et GLFW pour la version bureau des exemples (brew install glfw sur macOS, sudo apt install libglfw3-dev sur Ubuntu).

  • Le SDK Emscripten, pour la version web :

    git clone https://github.com/emscripten-core/emsdk.git
    cd emsdk
    ./emsdk install latest
    ./emsdk activate latest
    source ./emsdk_env.sh        # in each new terminal, before building for the web
    

    (voir Download and install). Emscripten fournit alors emcmake, qui lance la commande cmake habituelle de façon à compiler pour le web.

  • Python 3, pour un serveur web local : un navigateur refuse de charger project.wasm depuis une page ouverte comme fichier.

  • lhtml-site, seulement pour les slides faites avec lhtml-site : pipx install lhtml-site (voir lhtml-site).

  • Pour les exemples 3 à 6 : la bibliothèque CGP, une bibliothèque C++ faite pour enseigner l'informatique graphique, nécessaire seulement pour les recompiler (git clone https://github.com/drohmer/cgp-2027.git). Les deux premiers exemples n'ont besoin que de GLFW.

Sous Windows (cliquez pour afficher les commandes)

Les commandes du tutoriel sont écrites pour macOS et Linux. Dans PowerShell sous Windows :

  • python (ou py) au lieu de python3 : python -m http.server 8080.
  • Le SDK Emscripten : .\emsdk install latest et .\emsdk activate latest, puis .\emsdk_env.ps1 dans chaque nouveau terminal (emsdk_env.bat dans cmd). emcmake a aussi besoin de Ninja : winget install Ninja-build.Ninja.
  • GLFW, pour la version bureau des exemples 1 et 2 : vcpkg install glfw3 (voir vcpkg), puis ajoutez -DCMAKE_TOOLCHAIN_FILE=<vcpkg>\scripts\buildsystems\vcpkg.cmake à la première commande cmake. Après cmake --build build --config Release, le programme est build\Release\project.exe.
  • Une variable donnée devant une commande (CGP_DIR=../cgp-2027 python3 ...) se définit sur sa propre ligne : $env:CGP_DIR = "..\cgp-2027", puis python scripts\build_examples.py ....

Le README.md en haut du zip de chaque exemple donne ces commandes pour cet exemple. (Ces commandes n'ont pas été testées sous Windows.)

Récupérer le code

Chaque page d'exemple a un zip de l'exemple et de ce dont il a besoin. Ou prenez tout d'un coup : interactive-3d-slides.zip (le pont, les neuf exemples avec leurs compilations web, les tests). Chaque fichier peut aussi s'ouvrir seul : tous les fichiers.

Chaque zip se décompresse dans un dossier de son nom, avec en haut un README.md qui donne les étapes. Les compilations web sont dans les zips (examples/<exemple>/web/) : vous pouvez montrer une démo avant de compiler quoi que ce soit. Dans le dossier décompressé :

python3 -m http.server 8080

puis ouvrez http://localhost:8080/examples/a1-opengl-cube/slides.html.

Dans reveal.js ou dans lhtml-site

reveal.js : un cadre dans une <section>. data-src le charge quand sa slide approche, et le décharge ensuite :

<section>
  <iframe class="demo" data-src="web/index.html?speed=0.2"
          style="width: 100%; height: 540px; border: 0"></iframe>
</section>

lhtml-site : la macro demo:: écrit le cadre et le dimensionne selon la mise en page de la slide (la compilation web de la démo est dans le dossier src/_demo/ de la présentation) :

media::
demo::../_demo/index.html?speed=0.2
::

Les réglages de la démo vont dans son adresse (?speed=0.2) : une seule compilation sert plusieurs slides. L'exposé d'exemple en reveal.js et celui en lhtml-site montrent les mêmes démos (en anglais).

Le cadre prend le clavier

Dès que vous cliquez dans une démo, le clavier va au cadre : les flèches et la télécommande ne changent plus de slide. C'est le fonctionnement des navigateurs. La page de la démo (slide-frame.html) renvoie les touches aux slides, dans les deux outils.

Ensuite : 1. Cube en rotation, le plus petit exemple.