# blitzar-tech/egui_graphs architecture

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

- Interactive diagram: https://gitdiagram.com/blitzar-tech/egui_graphs
- Repository: https://github.com/blitzar-tech/egui_graphs

## Overview

##### Project type and purpose
- This is a Rust library workspace (“egui_graphs”) for interactive graph visualization. It publishes a core crate (`crates/egui_graphs`) and provides two non-published demo crates:
- `crates/demo-core` (shared logic for native demos via eframe)
- `crates/demo-web` (WASM web demo via trunk).
- The primary goal is to offer an egui `GraphView` widget that you drop into your UI to render and interact with a `petgraph::Graph`.

##### File structure
- Top-level workspace files: `Cargo.toml`, `.cargo/config.toml`, GitHub workflows.
- `crates/egui_graphs`: library code broken into modules:
- `graph.rs`, `graph_view.rs` (the core widget)
- `layouts/` (random, hierarchical, force-directed + extras)
- `elements/`, `events/`, `settings.rs`, `metadata.rs`
- `crates/demo-core`: shares application logic and assets (JSON graph specs), offering tabs, overlays, UI controls.
- `crates/demo-web`: minimal web wrapper: `index.html`, WASM build, uses the core demo logic.
- Config files (`build.rs`, `trunk.toml` via `.cargo/config.toml`, GitHub Actions) orchestrate builds (native, WASM).

##### README insights
- Emphasizes the `GraphView` widget as the primary API: `ui.add(&mut GraphView::new(&mut graph))`.
- Highlights pluggable `Layout` trait, styling hooks, optional `events` feature.
- Demonstrates native vs. WASM demo running via `eframe` or `trunk`.

##### Demonstrate the role of GraphView
- It as “Widget: orchestrates layout calculation, drawing, and user interactions.”
- Generic parameters: `<Graph, Layout, State>` enabling pluggable behavior.
- `petgraph::Graph` (reads/writes node/edge data)
- `Layout` trait implementations (invokes `layout.apply(&mut model, &mut state)`)
- `Drawers` (calls into `display.draw_node()`, `display.draw_edge()`)
- `egui::Context` (issues painting commands and receives input events)
- `SettingsStyle` hooks (for dynamic stroke styling)
- Optional `events` emitter (sends events back to the host app)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Dependencies
    subgraph "External Libraries" 
        direction TB
        PET["petgraph::Graph"]:::external
        EGUI["egui::Context / eframe"]:::external
        WASM["wasm32-unknown-unknown & trunk"]:::external
    end

    %% Core Crate
    subgraph "Core Crate: egui_graphs" 
        direction TB
        GM["Graph Model Adapter"]:::core
        GV["GraphView Widget"]:::core
        subgraph "Layout Engine"
            direction TB
            LR["Random Layout"]:::core
            LH["Hierarchical Layout"]:::core
            LF["Force-Directed Layout"]:::core
            LE["Force Extras"]:::core
            LI["Force Implementations"]:::core
        end
        subgraph "Drawer Subsystem"
            direction TB
            DD["Drawer Trait"]:::core
            DM["Drawer Module"]:::core
            DDI["Display Implementations"]:::core
            DDF["Default Displays"]:::core
        end
        SS["Styling & Hooks"]:::core
        EE["Event Emitter"]:::core
        EEN["Event Definitions"]:::core
        MD["Metadata Definitions"]:::core
    end

    %% Demo Core
    subgraph "Demo Core"
        direction TB
        DCL["App Shell"]:::demo
        DCT["UI Controls & Tabs"]:::demo
        DCI["Drawers Integration"]:::demo
        DCF["Event Filters"]:::demo
        DCO["Graph Ops & Import"]:::demo
        DCI2["Import Logic"]:::demo
        DCA["Asset Specifications"]:::demo
    end

    %% Demo Web
    subgraph "Demo Web"
        direction TB
        DWH["WASM Host (index.html)"]:::demo
        DWB["Web Demo Library"]:::demo
    end

    %% Build & CI
    subgraph "Build & CI"
        direction TB
        WB["Workspace Config"]:::build
        BLD["Build Script"]:::build
        CI1["GitHub Actions - Rust"]:::build
        CI2["GitHub Actions - Pages"]:::build
    end

    %% Connections: Model to Core
    PET -->|"wraps data"| GM
    GM -->|"provides model"| GV

    %% GraphView orchestration
    GV -->|"uses layout"| LR
    GV -->|"uses layout"| LH
    GV -->|"uses layout"| LF
    LF -->|"includes extras"| LE
    LF -->|"uses impls"| LI

    GV -->|"invokes drawer"| DD
    DD -->|"defined in"| DM
    DM -->|"draws via"| DDI
    DDI -->|"defaults in"| DDF

    GV -->|"applies styles via"| SS
    GV -->|"emits events to"| EE
    EE -->|"defines events in"| EEN
    GV -->|"uses metadata"| MD
    GV -->|"renders to"| EGUI
    EGUI -->|"input events"| GV

    %% Demo usage
    DCL -->|"calls widget"| GV
    DCL -->|"loads assets"| DCA
    DCT -->|"configures UI"| DCL
    DCI -->|"integrates drawer"| DCL
    DCF -->|"filters events"| DCL
    DCO -->|"manages graph logic"| DCL
    DCI2 -->|"imports graphs"| DCL

    DWH -->|"hosts demo"| DWB
    DWB -->|"uses core demo"| DCL
    WASM -->|"builds/serves"| DWH

    %% Build and CI relationships
    WB -->|"configures workspace"| BLD
    BLD -->|"builds demo"| DCL
    CI1 -->|"runs tests/builds"| WB
    CI2 -->|"deploys docs"| WASM

    %% External to core
    PET --- EGUI

    %% Click Events
    click GM "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/graph.rs"
    click GV "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/graph_view.rs"
    click LR "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/layouts/random/layout.rs"
    click LR "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/layouts/random/mod.rs"
    click LH "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/layouts/hierarchical/layout.rs"
    click LH "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/layouts/hierarchical/mod.rs"
    click LF "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/layouts/force_directed/layout.rs"
    click LE "https://github.com/blitzar-tech/egui_graphs/tree/main/crates/egui_graphs/src/layouts/force_directed/extras"
    click LI "https://github.com/blitzar-tech/egui_graphs/tree/main/crates/egui_graphs/src/layouts/force_directed/implementations"
    click DD "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/draw/drawer.rs"
    click DM "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/draw/mod.rs"
    click DDI "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/draw/displays.rs"
    click DDF "https://github.com/blitzar-tech/egui_graphs/tree/main/crates/egui_graphs/src/draw/displays_default/**"
    click SS "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/settings.rs"
    click EE "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/events/mod.rs"
    click EEN "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/events/event.rs"
    click MD "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/egui_graphs/src/metadata.rs"
    click DCL "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/src/lib.rs"
    click DCT "https://github.com/blitzar-tech/egui_graphs/tree/main/crates/demo-core/src/tabs/**"
    click DCI "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/src/drawers.rs"
    click DCF "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/src/event_filters.rs"
    click DCO "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/src/graph_ops.rs"
    click DCI2 "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/src/import.rs"
    click DCA "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/assets/*.json"
    click DWH "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-web/index.html"
    click DWB "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-web/src/lib.rs"
    click WB "https://github.com/blitzar-tech/egui_graphs/blob/main/.cargo/config.toml"
    click BLD "https://github.com/blitzar-tech/egui_graphs/blob/main/crates/demo-core/build.rs"
    click CI1 "https://github.com/blitzar-tech/egui_graphs/blob/main/.github/workflows/rust.yml"
    click CI2 "https://github.com/blitzar-tech/egui_graphs/blob/main/.github/workflows/pages.yml"

    %% Styles
    classDef core fill:#D0E1FF,stroke:#0366d6,stroke-width:1px
    classDef external fill:#DFFFE0,stroke:#228B22,stroke-width:1px
    classDef demo fill:#FFEFD5,stroke:#FF8C00,stroke-width:1px
    classDef build fill:#F0F0F0,stroke:#696969,stroke-width:1px
```
