# hagorman/island_builder architecture

> Architecture diagram of the GitHub repository hagorman/island_builder, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2024-12-28). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/hagorman/island_builder
- Repository: https://github.com/hagorman/island_builder

## Overview

##### Core Modules (Top Level)
- Generator Module
- Island Module
- Visualizer Module
- IO Module
- Pathfinder Module

##### Data Flow Architecture
- Generator -> IO -> Island -> IO -> Visualizer
With Pathfinder being used by the Island module for city connections.

##### Main Components per Module

Generator Module:
- Mesh Generation
- Grid Mesh Generator
- Irregular Mesh Generator
- Delaunay Triangulation

Island Module:
- Island Generation
- Circle
- Hexagon
- Elevation Systems
- Plains
- Volcano
- Water Systems
- Lakes
- Rivers
- Aquifers
- Biomes
- Arctic
- Warm Temperate
- City Systems
- Capital City
- Road Networks

Pathfinder Module:
- Path Finding
- Graph Representation
- Nodes
- Edges
- Algorithms
- Dijkstra's

Visualizer Module:
- Visualization
- SVG Generation
- Debug Renderer
- Normal Renderer

Design Guidelines:

##### Component Relationships
- Double lines for data transformation flows

##### Interfaces
- MeshFactory (IO)
- IslandShape
- PathFinding
- Renderer

##### Data Models
- Mesh Structure (Vertices, Segments, Polygons)
- Property Management System
- Graph Representation

##### External Dependencies
- Maven Build System
- Protocol Buffers (for mesh serialization)
- SVG Generation Libraries

Important Architectural Patterns to Highlight:

##### Template Method Pattern (for mesh generation)

Additional Considerations:

## Diagram (Mermaid)

```mermaid
graph TB
    classDef core fill:#f4f4f4,stroke:#333,stroke-width:2px
    classDef water fill:#b3e0ff,stroke:#333
    classDef terrain fill:#90EE90,stroke:#333
    classDef city fill:#ffb3b3,stroke:#333
    classDef io fill:#d3d3d3,stroke:#333
    classDef viz fill:#ffe6cc,stroke:#333
    
    subgraph CLI["Command Line Interface"]
        UserInput[User Input]
    end

    subgraph Core["Core Modules"]
        Generator["Generator Module"]:::core
        Island["Island Module"]:::core
        Visualizer["Visualizer Module"]:::core
        IO["IO Module"]:::io
        Pathfinder["Pathfinder Module"]:::core
    end

    subgraph GenComponents["Generator Components"]
        GridMesh["Grid Mesh"]:::core
        IrregularMesh["Irregular Mesh"]:::core
        Delaunay["Delaunay Triangulation"]:::core
    end

    subgraph IslandComponents["Island Components"]
        Shapes["Shape Generation"]:::terrain
        Elevation["Elevation Systems"]:::terrain
        WaterSys["Water Systems"]:::water
        Biomes["Biomes"]:::terrain
        Cities["City Systems"]:::city
    end

    subgraph PathComponents["Pathfinder Components"]
        Graph["Graph Representation"]:::core
        Dijkstra["Dijkstra's Algorithm"]:::core
    end

    subgraph VizComponents["Visualizer Components"]
        SVG["SVG Generation"]:::viz
        DebugRender["Debug Renderer"]:::viz
        NormalRender["Normal Renderer"]:::viz
    end

    UserInput --> Generator
    Generator --> IO
    IO --> Island
    Island --> IO
    IO --> Visualizer
    Island --> Pathfinder
    Pathfinder --> Island

    Generator --> GenComponents
    Island --> IslandComponents
    Pathfinder --> PathComponents
    Visualizer --> VizComponents

    %% Click events for component mapping
    click Generator "https://github.com/HagOrMan/Island_Builder/tree/main/generator/src/main/java/ca/mcmaster/cas/se2aa4/a2/generator/"
    click GridMesh "https://github.com/HagOrMan/Island_Builder/blob/main/generator/src/main/java/ca/mcmaster/cas/se2aa4/a2/generator/GridMesh.java"
    click IrregularMesh "https://github.com/HagOrMan/Island_Builder/blob/main/generator/src/main/java/ca/mcmaster/cas/se2aa4/a2/generator/IrregularMesh.java"
    click Delaunay "https://github.com/HagOrMan/Island_Builder/blob/main/generator/src/main/java/ca/mcmaster/cas/se2aa4/a2/generator/DelaunayTriangulation.java"
    
    click Island "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/"
    click Shapes "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/IslandShapes/"
    click Elevation "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/Elevation/"
    click WaterSys "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/FreshWater/"
    click Biomes "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/Whittaker/"
    click Cities "https://github.com/HagOrMan/Island_Builder/tree/main/island/src/main/java/ca/mcmaster/cas/se2aa4/a3/island/Cities/"
    
    click Pathfinder "https://github.com/HagOrMan/Island_Builder/tree/main/pathfinder/src/main/java/ca/mcmaster/cas/se2aa4/a4/pathfinder/"
    click Graph "https://github.com/HagOrMan/Island_Builder/blob/main/pathfinder/src/main/java/ca/mcmaster/cas/se2aa4/a4/pathfinder/Graph.java"
    click Dijkstra "https://github.com/HagOrMan/Island_Builder/blob/main/pathfinder/src/main/java/ca/mcmaster/cas/se2aa4/a4/pathfinder/algorithms/ShortestPathDijkstra.java"
    
    click Visualizer "https://github.com/HagOrMan/Island_Builder/tree/main/visualizer/src/main/java/ca/mcmaster/cas/se2aa4/a2/visualizer/"
    click DebugRender "https://github.com/HagOrMan/Island_Builder/blob/main/visualizer/src/main/java/ca/mcmaster/cas/se2aa4/a2/visualizer/DebugRenderer.java"
    click NormalRender "https://github.com/HagOrMan/Island_Builder/blob/main/visualizer/src/main/java/ca/mcmaster/cas/se2aa4/a2/visualizer/NormalRender.java"
    click SVG "https://github.com/HagOrMan/Island_Builder/blob/main/visualizer/src/main/java/ca/mcmaster/cas/se2aa4/a2/visualizer/SVGCanvas.java"
    
    click IO "https://github.com/HagOrMan/Island_Builder/tree/main/io/src/main/java/ca/mcmaster/cas/se2aa4/a2/io/"

    %% Legend
    subgraph Legend
        L1[Core Components]:::core
        L2[Water Systems]:::water
        L3[Terrain Systems]:::terrain
        L4[City Systems]:::city
        L5[IO Systems]:::io
        L6[Visualization]:::viz
    end
```
