# tis2024-fmfi/smelyzajko-gui architecture

> Architecture diagram of the GitHub repository tis2024-fmfi/smelyzajko-gui, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-04-26). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/tis2024-fmfi/smelyzajko-gui
- Repository: https://github.com/tis2024-fmfi/smelyzajko-gui

## Overview

##### Project Type and Purpose
- This is a full-stack C++ desktop application (smelyzajko-gui) whose purpose is to gather visual outputs from multiple robot modules into a single Dear ImGui window. It supports three operating modes—configuration, operation, and replay—and uses YAML config files and JSON templates.

##### File Structure
- Top‐level directories:
- src/ – application core: module management, GUI, operating modes, widgets
- templates/ – JSON files defining default layout or behavior
- config-files/ – example YAML config files
- libs/ – third-party libraries: ImGui, GLFW, yaml-cpp, JSON header
- TestModules/ – example modules (Counter, Map, Ultrasonic, Text) and their graphics variants
- Build scripts: CMakeLists.txt, setup_project.sh
- README and INSTALL.md outline usage and dependencies.

##### README Insights
- Describes three modes (--config, --operate, --replay)
- Highlights use of Dear ImGui and underlying GLFW + OpenGL context
- Notes modular design: separate modules each produce sensor or algorithmic outputs.

##### Main Components
a. Core Application
- ModuleManager
- OperatingMode, ConfigurationMode, ReplayMode
- TemplateManager and Shortcuts/ToastNotification managers
b. Module Plugins
- Sensor/algorithm modules (CounterModule, MapModule, etc.)
- Each has a “Graphics” class that knows how to render data via ImGui
c. GUI Layer
- Dear ImGui + GLFW window + custom widgets under src/widgets/
- ImGuiFileDialog for file selection
d. External Libraries
- ImGui (core, backends)
- GLFW (window, input, OpenGL context)
- yaml-cpp (parsing config YAML)
- nlohmann/json.hpp (optional JSON parsing for templates)
e. File System
- Config-files directory for user YAML
- templates directory for JSON templates
- Logs recorded in replay mode (not shown in code tree but implied)

##### Relationships and Data Flow
- On launch, the CLI parser (in main.cpp) selects a Mode.
- ConfigurationMode reads a YAML config via yaml-cpp → populates ModuleManager → GUI shows config panels.
- ReplayMode reads session logs (files) → feeds modules as if live → same rendering pipeline.
- ModuleManager controls module lifecycle; GUI pulls module graphics each frame.
- TemplateManager loads JSON layouts → GUI arranges ImGui windows accordingly.
- ShortcutsManager and ToastNotificationManager handle user interactions/events at GUI level.

##### Architectural Patterns and Principles
- Plugin‐like architecture: modules implement a common interface (Module + ModuleGraphics).
- MVC flavor: Modules = Model, Graphics + Widgets = View, ModuleManager/OperatingMode = Controller.
- Single‐window aggregate view: uses ImGui docking and custom widgets for layout flexibility.
- Separation of concerns: parsing (yaml-cpp), rendering (ImGui/GLFW), module logic.

##### Essential Elements
- Every component’s label and role (e.g., “ModuleManager: lifecycle & orchestration”)
- Notes on patterns (e.g., “MVC”, “Plugin Interface”)

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Data Resources
    subgraph "Data Resources"
        direction TB
        CFG["Config-files (YAML)"]:::resource
        TMP["Template Files (JSON)"]:::resource
        LOG["Replay Log Files"]:::resource
    end

    %% Third-Party Libraries
    subgraph "Third-Party Libraries"
        direction TB
        IMGUI["Dear ImGui"]:::external
        GLFW["GLFW"]:::external
        YAMLP["yaml-cpp"]:::external
        JSONH["nlohmann/json.hpp"]:::external
    end

    %% Module Plugins
    subgraph "Module Plugins"
        direction TB
        subgraph "CounterModule"
            CM["CounterModule"]:::module
            CMG["CounterModuleGraphics"]:::module
        end
        subgraph "MapModule"
            MMOD["MapModule"]:::module
            MMG["MapModuleGraphics"]:::module
        end
        subgraph "UltrasonicModule"
            UM["UltrasonicModule"]:::module
            UMG["UltrasonicModuleGraphics"]:::module
        end
        subgraph "TextModule"
            TMOD["TextModule"]:::module
            TMG["TextModuleGraphics"]:::module
        end
    end

    %% GUI Layer
    subgraph "GUI Layer"
        direction TB
        GUIENT["GUI Entrypoint"]:::core
        subgraph Widgets
            direction TB
            WIDGETS["Custom Widgets"]:::widget
            SCROLL["Scrollbar Widget"]:::widget
            TEXTA["TextArea Widget"]:::widget
            FILED["ImGuiFileDialog"]:::external
        end
    end

    %% Application Core
    subgraph "Application Core"
        direction TB
        MAIN["main.cpp (CLI Parser)"]:::core
        MMGR["ModuleManager"]:::core
        TMGR["TemplateManager"]:::core
        SMGR["ShortcutsManager"]:::core
        TFMGR["ToastNotificationManager"]:::core
        subgraph "Operating Modes"
            direction TB
            OPM["OperatingMode"]:::core
            CFGM["ConfigurationMode"]:::core
            RPM["ReplayMode"]:::core
        end
    end

    %% Connections
    CFG -->|"YAML → ConfigData"| CFGM
    CFG -->|"YAML → ConfigData"| MAIN
    TMP -->|"JSON → TemplateData"| TMGR
    LOG -->|"Log → SessionData"| RPM

    MAIN -->|"selects mode"| CFGM
    MAIN -->|"selects mode"| OPM
    MAIN -->|"selects mode"| RPM

    CFGM -->|"populates"| MMGR
    OPM -->|"uses"| MMGR
    RPM -->|"uses"| MMGR

    TMGR -->|"provides layout"| GUIENT
    SMGR -->|"handles shortcuts"| GUIENT
    TFMGR -->|"handles notifications"| GUIENT

    MMGR -->|"instantiates"| CM
    MMGR -->|"instantiates"| MMOD
    MMGR -->|"instantiates"| UM
    MMGR -->|"instantiates"| TMOD

    CM -->|"data → render"| CMG
    MMOD -->|"data → render"| MMG
    UM -->|"data → render"| UMG
    TMOD -->|"data → render"| TMG

    GUIENT -->|"draw calls"| CMG
    GUIENT -->|"draw calls"| MMG
    GUIENT -->|"draw calls"| UMG
    GUIENT -->|"draw calls"| TMG

    GUIENT -->|"renders via ImGui/GLFW"| IMGUI
    IMGUI -->|"uses"| GLFW

    GUIENT -->|"parses YAML"| YAMLP
    TMGR -->|"parses JSON"| JSONH

    GUIENT -->|"uses widgets"| WIDGETS
    GUIENT -->|"uses scrollbar"| SCROLL
    GUIENT -->|"uses textarea"| TEXTA
    GUIENT -->|"file selection"| FILED

    %% Click Events
    click MMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ModuleManager.h"
    click MMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ModuleManager.cpp"
    click OPM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/OperatingMode.h"
    click OPM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/OperatingMode.cpp"
    click CFGM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ConfigurationMode.h"
    click CFGM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ConfigurationMode.cpp"
    click RPM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ReplayMode.h"
    click RPM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ReplayMode.cpp"
    click TMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/TemplateManager.h"
    click TMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/TemplateManager.cpp"
    click SMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ShortcutsManager.h"
    click SMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ShortcutsManager.cpp"
    click TFMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ToastNotificationManager.h"
    click TFMGR "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/ToastNotificationManager.cpp"
    click GUIENT "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/GUI.h"
    click GUIENT "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/GUI.cpp"
    click MAIN "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/main.cpp"
    click CM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/CounterModule.h"
    click CM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/CounterModule.cpp"
    click CMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/CounterModuleGraphics.h"
    click CMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/CounterModuleGraphics.cpp"
    click MMOD "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/MapModule.h"
    click MMOD "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/MapModule.cpp"
    click MMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/MapModuleGraphics.h"
    click MMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/MapModuleGraphics.cpp"
    click UM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/UltrasonicModule.h"
    click UM "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/UltrasonicModule.cpp"
    click UMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/UltrasonicModuleGraphics.h"
    click UMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/UltrasonicModuleGraphics.cpp"
    click TMOD "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/TextModule.h"
    click TMOD "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/TextModule.cpp"
    click TMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/TextModuleGraphics.h"
    click TMG "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/TestModules/TextModuleGraphics.cpp"
    click WIDGETS "https://github.com/tis2024-fmfi/smelyzajko-gui/tree/main/src/widgets/"
    click SCROLL "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/Scrollbar.h"
    click SCROLL "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/Scrollbar.cpp"
    click TEXTA "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/TextArea.h"
    click TEXTA "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/src/TextArea.cpp"
    click FILED "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/libs/ImGuiFileDialog/ImGuiFileDialog.h"
    click FILED "https://github.com/tis2024-fmfi/smelyzajko-gui/blob/main/libs/ImGuiFileDialog/ImGuiFileDialog.cpp"

    %% Styles
    classDef core fill:#D0E4FF,stroke:#036,stroke-width:1px
    classDef resource fill:#E0F2E0,stroke:#070,stroke-width:1px
    classDef module fill:#FFE4C4,stroke:#C65,stroke-width:1px,stroke-dasharray: 5 5
    classDef external fill:#F2F2F2,stroke:#666,stroke-width:1px
    classDef widget fill:#FFEDCA,stroke:#CA8500,stroke-width:1px,stroke-dasharray: 2 2
```
