# czechbluebear/noneuclidean architecture

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

- Interactive diagram: https://gitdiagram.com/czechbluebear/noneuclidean
- Repository: https://github.com/czechbluebear/noneuclidean

## Overview

##### Project type and purpose
- NonEuclidean is a native C++ Windows demo application and rendering engine built on OpenGL.
- It provides a “non-Euclidean” demo environment where the user can move around and switch between rooms, featuring a platform abstraction layer (SDL2 or Win32), rendering, input, physics, scene management, and a resource loader.

##### File structure
- Top-level files:
- NonEuclidean.sln / Makefile – build system for Visual Studio or make.
- README.md / .gitignore / LICENSE.
- NonEuclidean/ folder breakdown:
- Platform layer: Engine_SDL2.{cpp,h}, Engine_Win32.{cpp,h}
- Core engine and main loop: Engine.{cpp,h}, Main.cpp, GameHeader.h, Timer.h, FrameBuffer.{cpp,h}
- Input subsystem: Input.{cpp,h}
- Resource loading: Resources.{cpp,h}, Mesh.{cpp,h}, Texture.{cpp,h}
- Shaders: Shaders/*.vert & .frag
- Scene & levels: Scene.h, Level1–Level6.{cpp,h}, Floorplan.h, House.h, Tunnel.h, PillarRoom.h, etc.
- Physics & collision: Physical.{cpp,h}, Collider.{cpp,h}
- Camera and rendering support: Camera.{cpp,h}, Shader.{cpp,h}
- Assets on disk: Meshes/*.obj, Textures/*.bmp

##### Key insights from the README
- Written in C++ with OpenGL, expects GLEW in the root directory.
- Uses mouse & keyboard for navigation and room switching demos.

##### Final advice
- Essential architectural elements: platform abstraction, main loop, subsystems, asset flow, and rendering pipeline.
- Avoid over-splitting; show each major function as its own component and connect them clearly.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Platform Layer
    subgraph "Platform Abstraction Layer"
        style Platform fill:#cce5ff,stroke:#004085
        Platform_SDL["Engine_SDL2 (SDL2)"]:::software
        Platform_Win32["Engine_Win32 (Win32)"]:::software
    end

    %% Engine Core
    subgraph "Engine Core"
        style EngineCore fill:#cce5ff,stroke:#004085
        CoreEngine["Core Engine & Main Loop"]:::software
        Input["Input Subsystem"]:::software
        Resources["Resource Manager"]:::software
        Scene["Scene Manager / Level Loader"]:::software
        Physics["Physics & Collision"]:::software
        Render["Rendering Subsystem"]:::software
    end

    %% Assets
    subgraph "On-Disk Assets"
        style Assets fill:#d4edda,stroke:#155724
        MeshAssets["Meshes (*.obj)"]:::assets
        TexAssets["Textures (*.bmp)"]:::assets
        ShaderAssets["Shaders (*.vert/.frag)"]:::assets
    end

    %% Hardware & OS
    GPU["GPU / Graphics Driver"]:::gpu
    FB["FrameBuffer"]:::software
    OSWin["OS Window / Display"]:::software

    %% Main Loop flow
    CoreEngine -->|bootstraps| Platform_SDL
    CoreEngine -->|bootstraps| Platform_Win32
    CoreEngine -->|"poll events"| Input
    CoreEngine -->|"load assets"| Resources
    CoreEngine -->|"init levels"| Scene
    CoreEngine -->|"update collisions"| Physics
    CoreEngine -->|"render frame"| Render

    %% Asset flow
    MeshAssets -->|"load .obj"| Resources
    TexAssets -->|"load .bmp"| Resources
    ShaderAssets -->|"load GLSL"| Resources

    %% Subsystem dependencies
    Resources -->|"provide meshes/textures/shaders"| Render
    Resources -->|"provide scene data"| Scene
    Resources -->|"provide collision meshes"| Physics

    %% Render pipeline
    Render -->|"draw calls"| GPU
    GPU --> FB
    FB --> OSWin

    %% Optional path dashed
    Platform_SDL -.->|optional| Platform_Win32

    %% Click Events
    click Platform_SDL "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine_SDL2.cpp"
    click Platform_SDL "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine_SDL2.h"
    click Platform_Win32 "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine_Win32.cpp"
    click Platform_Win32 "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine_Win32.h"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine.cpp"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Engine.h"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Main.cpp"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/GameHeader.h"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Timer.h"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/FrameBuffer.cpp"
    click CoreEngine "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/FrameBuffer.h"
    click Input "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Input.cpp"
    click Input "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Input.h"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Mesh.cpp"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Mesh.h"
    click MeshAssets "https://github.com/czechbluebear/noneuclidean/tree/master/NonEuclidean/Meshes/"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Texture.cpp"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Texture.h"
    click TexAssets "https://github.com/czechbluebear/noneuclidean/tree/master/NonEuclidean/Textures/"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Shader.cpp"
    click Resources "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Shader.h"
    click ShaderAssets "https://github.com/czechbluebear/noneuclidean/tree/master/NonEuclidean/Shaders/"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Scene.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level1.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level1.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level2.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level2.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level3.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level3.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level4.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level4.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level5.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level5.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level6.cpp"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Level6.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Floorplan.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/House.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Tunnel.h"
    click Scene "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/PillarRoom.h"
    click Physics "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Physical.cpp"
    click Physics "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Physical.h"
    click Physics "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Collider.cpp"
    click Physics "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Collider.h"
    click Render "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Camera.cpp"
    click Render "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Camera.h"
    click Render "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Object.cpp"
    click Render "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean/Object.h"
    click OSWin "https://github.com/czechbluebear/noneuclidean/blob/master/NonEuclidean.sln"
    click OSWin "https://github.com/czechbluebear/noneuclidean/tree/master/NonEuclidean/Makefile"
    click OSWin "https://github.com/czechbluebear/noneuclidean/blob/master/README.md"
    click OSWin "https://github.com/czechbluebear/noneuclidean/blob/master/.gitignore"
    click OSWin "https://github.com/czechbluebear/noneuclidean/tree/master/LICENSE"

    %% Styles
    classDef software fill:#cce5ff,stroke:#004085,color:#004085
    classDef assets fill:#d4edda,stroke:#155724,color:#155724
    classDef gpu fill:#ffe5b4,stroke:#cc8400,color:#cc8400
    classDef optional stroke-dasharray: 5 5
```
