# elbrahmi-abdessamie/minirt architecture

> Architecture diagram of the GitHub repository elbrahmi-abdessamie/minirt, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-09-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/elbrahmi-abdessamie/minirt
- Repository: https://github.com/elbrahmi-abdessamie/minirt

## Overview

##### Project Type and Purpose
- miniRT is an open-source graphics tool: a simple ray tracer that parses scene descriptions, simulates light transport (ray casting & ray tracing), and outputs a 2D image.
- It is neither a full-stack web app nor a compiler; it’s a stand-alone rendering engine with optional bonus features (bump mapping, multithreading).

##### File Structure Analysis
- Top-level:
- Scenes/ (sample .rt scene files)
- images/ (texture bitmaps in .xpm)
- / (public headers: parser, tracer, vector, tools, etc.)
- src/ (core implementation split into minirt, parcer, tracer, vec_operations)
- bonus/ (parallel implementation of parser & tracer with bump mapping)
- libft/ (custom C standard library utilities)
- Makefile, LICENSE, README.md
- Patterns:
- Modular C code: parser module → scene graph, tracer module → ray-scene interactions, utility module → vectors/math, image I/O.
- Clear separation of concerns: parsing vs. geometry vs. ray operations vs. shading.

##### README Insights
- Describes rendering pipeline:
1) Ray-scene intersection
2) Shading (Phong: ambient, diffuse, specular)
3) Recursive reflection/refraction (depth limit)
4) Bonus: bump (normal) mapping

##### Main Components
a. Input Layer
- Scene Loader (parcer module)
- File system: Scenes/*.rt, textures in images/*.xpm
b. Core Engine
- Scene Graph: in-memory representation of objects (spheres, planes, cones, lights, camera)
- Ray Tracer:
- Ray generation (camera)
- Intersection manager (calls Geometry Module)
- Shading engine (Phong + recursive rays)
- Texture & bump mapper (bonus)
c. Output Layer
- Pixel Buffer (framebuffer)
- Image Writer (writes .bmp or displays via MLX)
d. Optional Bonus/Multi-threading Layer
- Thread manager (divides image into tiles)
- Parallel tracer instances

##### Relationships & Data Flow
- Scene Graph → Ray Tracer (for each pixel)
- Ray Tracer → Geometry Module → returns hit info → Shading Engine
- Shading Engine → updates Pixel Buffer
- Thread Manager (if bonus) orchestrates multiple Ray Tracer workers in parallel → merges buffers
- Pixel Buffer → Image Writer → final image output

##### Architectural Patterns & Principles
- Modular layering (Parser → Core Engine → Output)
- Recursive algorithm for reflection/refraction with depth cutoff

##### Technologies & Frameworks
- C99 / POSIX
- Custom libft (string, memory, list utilities)
- XPM for textures
- MLX (optional) or BMP writer for output
- Makefile for build automation

##### Summary
- Recursive nature of ray tracing, plus the optional parallelism in bonus features

## Diagram (Mermaid)

```mermaid
graph TD
    %% Input Layer
    subgraph "Input Layer"
        SCENEF["Scenes/*.rt"]:::data
        parcerC["parcer.c"]:::parser
        objsDir["src/parcer/objects/"]:::parser
        sceneDir["src/parcer/scene/"]:::parser
        toolsDir["src/parcer/tools/"]:::parser
        headerP["include/parcer.h"]:::parser
    end

    %% Core Engine
    subgraph "Core Engine"
        subgraph "Scene Graph"
            sg["include/structs.h"]:::core
        end
        subgraph "Geometry Module"
            geomDir["src/tracer/intersections/"]:::core
            headerT["include/tracer.h"]:::core
        end
        subgraph "Ray Tracer"
            cameraC["src/tracer/camera.c"]:::core
            tracerC["src/tracer/tracer.c"]:::core
            raytrC["src/tracer/raytracing.c"]:::core
            hooksDir["src/tracer/rt_hooks.c"]:::core
            hookMove["src/tracer/hooks_obj_move.c"]:::core
            hookScale["src/tracer/hooks_obj_scale.c"]:::core
        end
        subgraph "Shading Engine"
            lightC["src/tracer/light.c"]:::core
            pixelsC["src/tracer/pixels.c"]:::core
        end
    end

    %% Utilities
    subgraph "Utilities"
        vecDir["src/tracer/vec_operations/"]:::util
        vectorH["include/vector.h"]:::util
        toolsH["include/tools.h"]:::util
        libftDir["libft/src/"]:::util
        libftH["libft/include/libft.h"]:::util
    end

    %% Output Layer
    subgraph "Output Layer"
        mainC["src/minirt/main.c"]:::output
        drawH["include/draw.h"]:::output
        libH["include/library.h"]:::output
    end

    %% Assets
    subgraph "Assets"
        imgDir["images/*.xpm"]:::data
    end

    %% Optional Bonus
    subgraph "Optional Bonus"
        bonusHdr["bonus/include_bonus/"]:::bonus
        mainBonus["bonus/src_bonus/minirt_bonus/main_bonus.c"]:::bonus
        threadMan["bonus/src_bonus/multithreading_managment_bonus.c"]:::bonus
        parcerBonus["bonus/src_bonus/parcer_bonus/"]:::bonus
        tracerBonus["bonus/src_bonus/tracer_bonus/"]:::bonus
    end

    %% Data Flow
    SCENEF --> parcerC
    objsDir --> parcerC
    sceneDir --> parcerC
    toolsDir --> parcerC
    headerP --> parcerC
    parcerC --> sg

    sg --> cameraC
    sg --> tracerC

    cameraC --> tracerC
    tracerC --> geomDir
    geomDir --> tracerC
    tracerC --> raytrC

    raytrC --> lightC
    lightC --> pixelsC
    pixelsC --> mainC

    lightC -.->|recursive ray| tracerC

    vectorH --> cameraC
    vectorH --> geomDir
    toolsH --> parcerC

    libftDir --> toolsH
    libftH --> toolsH

    mainC --> drawH
    mainC --> libH
    mainC --> vectorH
    mainC --> headerT

    imgDir --> parcerC

    %% Bonus Flow
    bonusHdr --> parcerBonus
    bonusHdr --> tracerBonus
    parcerBonus --> mainBonus
    tracerBonus --> mainBonus
    threadMan --> tracerBonus
    threadMan --> parcerBonus
    threadMan --> pixelsC
    mainBonus --> drawH

    %% Click Events
    click parcerC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/parcer/parcer.c"
    click objsDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/src/parcer/objects/"
    click sceneDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/src/parcer/scene/"
    click toolsDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/src/parcer/tools/"
    click headerP "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/parcer.h"
    click sg "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/structs.h"
    click geomDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/src/tracer/intersections/"
    click headerT "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/tracer.h"
    click cameraC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/camera.c"
    click tracerC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/tracer.c"
    click raytrC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/raytracing.c"
    click hooksDir "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/rt_hooks.c"
    click hookMove "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/hooks_obj_move.c"
    click hookScale "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/hooks_obj_scale.c"
    click lightC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/light.c"
    click pixelsC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/tracer/pixels.c"
    click vecDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/src/tracer/vec_operations/"
    click vectorH "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/vector.h"
    click toolsH "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/tools.h"
    click libftDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/libft/src/"
    click libftH "https://github.com/elbrahmi-abdessamie/minirt/blob/master/libft/include/libft.h"
    click mainC "https://github.com/elbrahmi-abdessamie/minirt/blob/master/src/minirt/main.c"
    click drawH "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/draw.h"
    click libH "https://github.com/elbrahmi-abdessamie/minirt/blob/master/include/library.h"
    click imgDir "https://github.com/elbrahmi-abdessamie/minirt/tree/master/images/"
    click bonusHdr "https://github.com/elbrahmi-abdessamie/minirt/tree/master/bonus/include_bonus/"
    click mainBonus "https://github.com/elbrahmi-abdessamie/minirt/blob/master/bonus/src_bonus/minirt_bonus/main_bonus.c"
    click threadMan "https://github.com/elbrahmi-abdessamie/minirt/blob/master/bonus/src_bonus/multithreading_managment_bonus.c"
    click parcerBonus "https://github.com/elbrahmi-abdessamie/minirt/tree/master/bonus/src_bonus/parcer_bonus/"
    click tracerBonus "https://github.com/elbrahmi-abdessamie/minirt/tree/master/bonus/src_bonus/tracer_bonus/"

    %% Styles
    classDef parser fill:#e2f7e2,stroke:#2d7f2d
    classDef core fill:#e2e8f7,stroke:#264d7f
    classDef util fill:#f7e8e2,stroke:#7f4026
    classDef bonus fill:#f3e2f7,stroke:#7f2d7f
    classDef output fill:#d3d3d3,stroke:#4f4f4f
    classDef data fill:#f0f0f0,stroke:#999999
```
