Accueil / Utilisation

Utilisation

Lancer le programme, comprendre les options de la ligne de commande, le mode de rendu headless et le format complet des fichiers de scène JSON.

Ligne de commande

./raytracer [OPTIONS] [FICHIER_SCENE]

Le FICHIER_SCENE est optionnel : sans lui, une scène vierge par défaut est chargée. Les arguments sont analysés par la structure Options (srcs/config/Options.hpp).

Exemples de commandes

# Interface graphique sur une scène d'exemple
./raytracer tests/configs/subject.json

# Rendu direct vers un PNG (sans interface)
./raytracer -r output.png tests/configs/subject.json

# Rendu headless avec le nom de sortie par défaut (render.png)
./raytracer --render tests/configs/cube.json

# Interface + serveur de cluster sur le port 8080
./raytracer --server 8080 tests/configs/subject.json

# Interface + connexion à un serveur de cluster
./raytracer --connect 127.0.0.1 8080 tests/configs/subject.json

Mode headless (rendu PNG)

Le mode -r / --render ne charge pas l’interface : il construit la scène, calcule l’image, l’exporte en PNG, puis quitte. Idéal pour les scripts et l’intégration continue.

./raytracer -r sortie.png tests/configs/cube.json
# Sortie console attendue :
#   Loaded 2 renderer plugin(s)
#    - Viewport
#    - Default
#   Finished rendering scene! Saving to file..
#   Render has been saved to file 'sortie.png'

Format des fichiers de scène

Une scène est un fichier JSON (extension .json obligatoire) lu par SceneParser. Les sections camera et objects sont obligatoires ; environment et materials sont facultatives. Les clés inconnues sont simplement ignorées.

Squelette général

{
  "environment": { "ambient": 0.4, "diffuse": 0.6 },
  "camera": {
    "resolution": [1920, 1080],
    "position":   [0.0, -100.0, 20.0],
    "rotation":   [0.0, 0.0, 0.0],
    "fieldOfView": 72.0,
    "samplesPerPixel": 128
  },
  "objects": [
    { "name": "Sphere A", "type": "sphere", "position": [60, 5, 40], "radius": 25, "material": "Material A" }
  ],
  "materials": [
    { "name": "Material A", "model": "pbr", "base_color": [230, 60, 60], "roughness": 0.5 }
  ]
}

Section environment

Facultative. Contrôle l’éclairage global.

Section camera

Obligatoire. Définit le point de vue et la qualité du rendu.

Section objects

Obligatoire. Liste des primitives, des lumières et des groupes. Chaque objet possède un type (obligatoire) et un name (facultatif). Les primitives peuvent référencer un material par son nom. Le SceneParser ne lit que les clés pertinentes pour le type ; les clés inconnues sont ignorées. Types disponibles :

Couleurs et vecteurs

• Un vecteur est un tableau [x, y, z] de 3 nombres (position, rotation en degrés, échelle, direction…).
• Une couleur est un tableau [r, g, b] de 3 composantes entières comprises entre 0 et 255.

Section materials

Facultative. Chaque matériau porte un name (référencé par les objets via material) et un model ("phong" ou "pbr"). Les champs lus par parseMaterial :

{
  "name": "GoldMetal",
  "model": "pbr",
  "base_color": [255, 198, 92],
  "metallic": 0.9,
  "roughness": 0.22,
  "clearcoat": 0.0,
  "transmission": 0.0,
  "ior": 1.5
}

Exemple complet commenté

Extrait fidèle de tests/configs/subject.json (deux sphères, un plan et une lumière) :

{
  "environment": { "ambient": 0.4, "diffuse": 0.6 },

  "camera": {
    "resolution": [1920, 1080],      // largeur x hauteur en pixels (obligatoire)
    "position":   [0.0, -100.0, 20.0],
    "rotation":   [0.0, 0.0, 0.0],   // degrés (obligatoire)
    "fieldOfView": 72.0,             // degrés (obligatoire)
    "samplesPerPixel": 128           // anti-aliasing (défaut 5)
  },

  "objects": [
    {
      "name": "Sphere A",
      "type": "sphere",
      "position": [60.0, 5.0, 40.0],
      "radius": 25,
      "material": "Material A"       // référence par nom
    },
    {
      "name": "Plane",
      "type": "plane",
      "axis": "z",                    // "x" | "y" | "z" — PAS "normal"/"origin"
      "position": [0.0, 0.0, -20.0],
      "material": "Material C"
    },
    {
      "name": "Point light",
      "type": "point_light",
      "intensity": 1000000.0,
      "position": [400.0, 100.0, 500.0]
    }
  ],

  "materials": [
    // La clé reconnue est "model" (phong | pbr) ; "base_color" en [r,g,b] 0-255.
    { "name": "Material A", "model": "phong", "base_color": [255, 64, 64] },
    { "name": "Material C", "model": "phong", "base_color": [64, 64, 255] }
  ]
}

Importer un maillage .obj

Un objet de type mesh charge un fichier .obj via la clé file. Les fichiers d’exemple sont dans tests/obj/ (cube.obj, poly.obj, slt.obj).

{
  "name": "Polished Metal",
  "type": "mesh",
  "file": "tests/obj/slt.obj",
  "position": [34.0, 4.0, 6.0],
  "rotation": [0.0, 0.0, -18.0],
  "scale": [110.0, 110.0, 110.0],
  "material": "GoldMetal"
}

Un maillage peut aussi être défini en ligne (sans fichier externe) via vertices, faces et normals, ou porter des modifications de sommets ponctuelles avec vertex_overrides (liste d’entrées { "index": n, "position": [x,y,z] }) — voir Édition de sommets.

Sauvegarde de scène

Depuis l’interface, la scène peut être ré-exportée en JSON : SceneRegister sérialise la caméra (resolution, position, rotation, fieldOfView, samplesPerPixel), les objets (avec leurs transformations locales, et pour les maillages leurs vertices/faces/normals ou vertex_overrides) et les matériaux. Le cycle charger → éditer → sauvegarder → recharger restitue fidèlement la scène.