# berachem/computer_graphics architecture

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

- Interactive diagram: https://gitdiagram.com/berachem/computer_graphics
- Repository: https://github.com/berachem/computer_graphics

## Overview

##### Project Type and Purpose
- This is a C++ OpenGL‐based graphics application (“Système Solaire”) intended to render a 3D scene (solar system) with multiple objects, shaders, environment maps, camera navigation, and optional GUI.
- It uses GLFW/SDL for window/context, GLAD/GLEW for OpenGL loading, TinyOBJLoader for `.obj` models, IMGUI for UI, and standard CMake for builds.

##### High‐Level File Structure Analysis
- Top‐level: CMakeLists.txt, README.md, SETUP.md, TODO.md
- extern/imgui: immediate‐mode GUI library
- /: public headers for all subsystems (AudioSource, Camera, Scene, ShaderManager, SoundManager, etc.)
- src/: implementation of each subsystem plus main.cpp
- shaders/: GLSL programs (Lambert, Phong, environment, skybox, etc.)
- models/, skybox/, textures/, sound/: asset directories
- libs/: single‐header utilities (stb_image)

##### Core Components
- Window & GL Context
- GLFW/SDL + GLAD/GLEW initialization
- Resource Managers (Singleton‐style)
- ShaderManager: compiles/links GLSL from shaders/
- TextureLoader & SkyboxManager: loads textures, cubemaps from textures/ & skybox/
- Mesh/Model Loader: TinyOBJLoader + Mesh class (OBJ → VAO/VBO)
- SoundManager & AudioSource: loads and plays WAV from sound/
- Scene Management
- SceneManager or MainScene: holds Scene objects, Lights, Cameras, Skybox
- Objects: Model, Sphere, UIHelpers overlays
- Rendering Pipeline
- Mat4, UBO: handles projection/view/model matrices via uniform blocks
- Input & Camera
- Camera class + MainScene navigation (orbit or free‐fly)
- GUI
- IMGUI integration under extern/imgui + UIHelpers for tweaking parameters
- Build & Deployment
- CMake → compiles src/, links extern/imgui, stb_image, TinyOBJLoader

##### Relationships and Data Flow
- App Init → Window/Context → Load Managers (ShaderManager, TextureLoader, SoundManager)
- Load Scene: SceneManager reads assets → creates Model & Mesh instances → associates shaders & textures
- Main Loop:
- Input → Camera updates → UBO updates → SceneManager update
- Audio pass → AudioSource playback
- Shutdown: release Managers, destroy Window

##### Architectural Patterns & Principles
- Manager/Factory pattern for resource loading & caching
- Single Responsibility: separate classes for Camera, Shader, Mesh, Sound
- Uniform Buffer Objects (UBOs) for grouping global GPU data (projection/view)
- Plug‐in‐style shaders: each effect lives in its own shader program
- Immediate‐mode GUI overlay decoupled from render pipeline

##### Essential Elements
- Clear labels (e.g., “ShaderManager”, “SceneManager”, “AudioSource”)
- File paths (e.g., include/for headers, shaders/ for GLSL, src/ for cpp)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Initialization
    A["App Init (src/main.cpp)"]:::core --> B["Window & GL Context Init"]:::core
    click A "https://github.com/berachem/computer_graphics/blob/master/src/main.cpp"

    %% External Libraries
    subgraph "External Libraries"
        direction TB
        GLF["GLFW/SDL"]:::external
        GLE["GLAD/GLEW"]:::external
        TOL["TinyOBJLoader"]:::external
        IMG["IMGUI"]:::external
        STB["stb_image.h"]:::external
        click TOL "https://github.com/berachem/computer_graphics/blob/master/include/tiny_obj_loader.h"
        click IMG "https://github.com/berachem/computer_graphics/tree/master/extern/imgui"
        click STB "https://github.com/berachem/computer_graphics/blob/master/libs/stb_image.h"
    end

    B --> GLF
    B --> GLE
    GLF --> B
    GLE --> B

    %% Resource Managers
    subgraph "Resource Managers"
        direction TB
        SM["ShaderManager"]:::resource
        TL["TextureLoader"]:::resource
        SBM["SkyboxManager"]:::resource
        SNDM["SoundManager"]:::resource
        click SM "https://github.com/berachem/computer_graphics/blob/master/include/ShaderManager.h"
        click SM "https://github.com/berachem/computer_graphics/blob/master/src/ShaderManager.cpp"
        click TL "https://github.com/berachem/computer_graphics/blob/master/include/TextureLoader.h"
        click TL "https://github.com/berachem/computer_graphics/blob/master/src/TextureLoader.cpp"
        click SBM "https://github.com/berachem/computer_graphics/blob/master/include/SkyboxManager.h"
        click SBM "https://github.com/berachem/computer_graphics/blob/master/src/SkyboxManager.cpp"
        click SNDM "https://github.com/berachem/computer_graphics/blob/master/include/SoundManager.h"
        click SNDM "https://github.com/berachem/computer_graphics/blob/master/src/SoundManager.cpp"
    end

    GLF --> SM
    GLE --> SM
    GLF --> TL
    GLF --> SBM
    GLF --> SNDM

    %% Shader and Mesh Abstractions
    subgraph "Core Abstractions"
        direction TB
        SH["Shader"]:::core
        MSH["Mesh"]:::core
        MDL["Model"]:::core
        U4["Mat4"]:::core
        UBO["UBO"]:::core
        click SH "https://github.com/berachem/computer_graphics/blob/master/include/Shader.h"
        click SH "https://github.com/berachem/computer_graphics/blob/master/src/Shader.cpp"
        click MSH "https://github.com/berachem/computer_graphics/blob/master/include/Mesh.h"
        click MSH "https://github.com/berachem/computer_graphics/blob/master/src/Mesh.cpp"
        click MDL "https://github.com/berachem/computer_graphics/blob/master/include/Model.h"
        click MDL "https://github.com/berachem/computer_graphics/blob/master/src/Model.cpp"
        click U4 "https://github.com/berachem/computer_graphics/blob/master/include/Mat4.h"
        click U4 "https://github.com/berachem/computer_graphics/blob/master/src/Mat4.cpp"
        click UBO "https://github.com/berachem/computer_graphics/blob/master/include/UBO.h"
        click UBO "https://github.com/berachem/computer_graphics/blob/master/src/UBO.cpp"
    end

    SM --> SH
    TL --> SH
    TL --> MSH
    TOL --> MSH
    MSH --> MDL

    %% Audio Components
    subgraph "Audio System"
        direction TB
        ASRC["AudioSource"]:::resource
        SND["Sound"]:::resource
        click ASRC "https://github.com/berachem/computer_graphics/blob/master/include/AudioSource.h"
        click ASRC "https://github.com/berachem/computer_graphics/blob/master/src/AudioSource.cpp"
        click SND "https://github.com/berachem/computer_graphics/blob/master/include/Sound.h"
        click SND "https://github.com/berachem/computer_graphics/blob/master/src/Sound.cpp"
    end

    SNDM --> ASRC
    SNDM --> SND

    %% Scene Management
    subgraph "Scene Management"
        direction TB
        SCM["SceneManager"]:::core
        MSC["MainScene"]:::core
        LSC["LightScene"]:::core
        SCN["Scene"]:::core
        CAM["Camera"]:::core
        SPH["Sphere"]:::core
        UIO["UIHelpers"]:::core
        click SCM "https://github.com/berachem/computer_graphics/blob/master/include/SceneManager.h"
        click SCM "https://github.com/berachem/computer_graphics/blob/master/src/SceneManager.cpp"
        click MSC "https://github.com/berachem/computer_graphics/blob/master/include/MainScene.h"
        click MSC "https://github.com/berachem/computer_graphics/blob/master/src/MainScene.cpp"
        click LSC "https://github.com/berachem/computer_graphics/blob/master/include/LightScene.h"
        click LSC "https://github.com/berachem/computer_graphics/blob/master/src/LightScene.cpp"
        click SCN "https://github.com/berachem/computer_graphics/blob/master/include/Scene.h"
        click CAM "https://github.com/berachem/computer_graphics/blob/master/include/Camera.h"
        click CAM "https://github.com/berachem/computer_graphics/blob/master/src/Camera.cpp"
        click SPH "https://github.com/berachem/computer_graphics/blob/master/include/Sphere.h"
        click SPH "https://github.com/berachem/computer_graphics/blob/master/src/Sphere.cpp"
        click UIO "https://github.com/berachem/computer_graphics/blob/master/include/UIHelpers.h"
        click UIO "https://github.com/berachem/computer_graphics/blob/master/src/UIHelpers.cpp"
        click UIO "https://github.com/berachem/computer_graphics/tree/master/extern/imgui"
    end

    SM --> SCM
    TL --> SCM
    SBM --> SCM
    SNDM --> SCM
    SCM --> MSC
    SCM --> LSC
    MSC --> SPH
    SCN --> MSC
    CAM --> SCM
    UIO --> SCM

    %% Rendering Pipeline
    subgraph "Render Loop"
        direction TB
        I["Input"]:::core
        C["Camera Update"]:::core
        U["UBO Update"]:::core
        U4 --> U
        UBO --> U
        R["Render Pass"]:::core
        SBX["Skybox Pass"]:::core
        GUI["GUI Pass"]:::core
        AUD["Audio Pass"]:::core
    end

    B --> I
    I --> C
    C --> U
    U --> R
    R --> SBX
    SBX --> GUI
    GUI --> AUD

    R -->|"bind Shader → draw Mesh"| SH
    R --> MDL
    R --> SPH
    SBX --> SBM
    GUI --> UIO
    AUD --> ASRC

    %% Assets
    subgraph "Asset Repositories"
        direction TB
        MDIRS["models/"]:::asset
        TX["textures/"]:::asset
        SB["skybox/"]:::asset
        SHD["shaders/"]:::asset
        SD["sound/"]:::asset
    end

    MDIRS --> TOL
    TX --> TL
    SB --> SBM
    SHD --> SM
    SD --> SNDM

    %% Legend
    classDef core fill:#cce5ff,stroke:#004085,color:#004085,stroke-width:1px;
    classDef resource fill:#d4edda,stroke:#155724,color:#155724,stroke-width:1px;
    classDef external fill:#fff3cd,stroke:#856404,color:#856404,stroke-width:1px,stroke-dasharray: 5 5,shape:hexagon;
    classDef asset fill:#f5c6cb,stroke:#721c24,color:#721c24,stroke-width:1px,shape:cylinder;
```
