# imengx/wiremage architecture

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

- Interactive diagram: https://gitdiagram.com/imengx/wiremage
- Repository: https://github.com/imengx/wiremage

## Overview

##### Main Components
a. External Swift Packages (found under the “Package/” folder)
– Controls
– CustomAlert
– Flow
– PadControl
– PartitionKit
– Popovers
– PopupView
– SwiftNodeEditor
– SwiftUIPager
b. WireMage Application
– App Entry & Document Layer
- WireMageApp.swift
- WireMageDocument.swift (UIDocument-based storage)
– Model Layer
- Model/Codable.swift, Define.swift
- WMNode.swift + subclasses (ProcessingNode, TerminalNode, ViewNode)
– Node Creation
- NodeCreate/NodeCreate.swift, NodeTemplate.swift
– Pipeline Engine
- Pipeline/Pipeline.swift (executes data/process flow between nodes)
– Workspace & UI Layer
- WorkSpace/WorkSpace.swift, ControlPanel.swift
- Shared SwiftUI demo views (ArcKnobDemoView.swift, etc.)

##### Relationships & Data Flows
– The App Entry initializes the Document and Workspace UI.
– The Workspace UI uses SwiftNodeEditor (from the Swift Package) to render and interact with the node graph.
– NodeCreate modules provide factory templates to add new nodes into the graph.
– The Pipeline component orchestrates execution: it traverses WMNode subclasses, passing data between ProcessingNodes and TerminalNodes.
– Model/Codable.swift handles serialization/deserialization of the node graph in WireMageDocument.
– Shared demo views and control packages supply custom knobs, sliders, and controls embedded in the Workspace UI.

##### Architectural Patterns
– Document-based MVVM: SwiftUI Views ↔ ViewModels (Workspace, Node graph) ↔ Model (WMNode graph).
– Modular design via Swift Packages: reusable UI controls, node editor, pager, flow controller.
– Node graph computing pattern: nodes implement a common interface (WMNode) and are linked in a pipeline.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% External Swift Packages
    subgraph "External Swift Packages"
        direction TB
        Controls["Controls"]:::external
        CustomAlert["CustomAlert"]:::external
        FlowPkg["Flow"]:::external
        PadControl["PadControl"]:::external
        PartitionKit["PartitionKit"]:::external
        Popovers["Popovers"]:::external
        PopupView["PopupView"]:::external
        SwiftNodeEditor["SwiftNodeEditor"]:::external
        SwiftUIPager["SwiftUIPager"]:::external
    end

    %% WireMage Application
    subgraph "WireMage App"
        direction TB

        subgraph "App Entry & Document Layer"
            direction TB
            App["WireMageApp.swift"]:::doc
            Doc["WireMageDocument.swift"]:::doc
        end

        subgraph "Model Layer"
            direction TB
            Codable["Codable.swift"]:::model
            Define["Define.swift"]:::model
            WMNode["WMNode.swift"]:::model

            subgraph "ProcessingNode"
                direction TB
                ProcNode["ProcessingNode.swift"]:::model
                ConvertNode["ConvertNode.swift"]:::model
            end

            subgraph "TerminalNode"
                direction TB
                CarControlNode["CarControlNode.swift"]:::model
            end

            subgraph "ViewNode"
                direction TB
                ViewNodeNode["ViewNode.swift"]:::model
                ControlView["ControlView.swift"]:::model
                VCNode["ViewComponentNode.swift"]:::model
                VCNodeCopy["ViewComponentNode_副本.swift"]:::model
            end
        end

        subgraph "Node Creation Module"
            direction TB
            NodeCreate["NodeCreate.swift"]:::model
            NodeTemplate["NodeTemplate.swift"]:::model
        end

        Pipeline["Pipeline.swift"]:::model

        subgraph "Workspace & UI Layer"
            direction TB
            WorkSpace["WorkSpace.swift"]:::ui
            ControlPanel["ControlPanel.swift"]:::ui

            subgraph "Shared SwiftUI Demo Views"
                direction TB
                ArcKnob["ArcKnobDemoView.swift"]:::ui
                Content1["ContentView1.swift"]:::ui
                ControlsDemoApp["ControlsDemoApp.swift"]:::ui
                IndexedSlider["IndexedSliderDemoView.swift"]:::ui
                Joystick["JoystickDemoView.swift"]:::ui
                Keyboard["KeyboardDemoView.swift"]:::ui
                PitchModWheel["PitchModWheelDemoView.swift"]:::ui
                Ribbon["RibbonDemoView.swift"]:::ui
                SmallKnob["SmallKnobDemoView.swift"]:::ui
                XYPad["XYPadDemoView.swift"]:::ui
            end
        end
    end

    %% Relationships
    App -->|"launch"| Doc
    Doc -->|"loads/saves"| Codable
    Doc -->|"loads/saves"| Define
    Doc -->|"manages graph"| WMNode

    Doc --> WorkSpace
    WorkSpace -->|"render()/interact()"| SwiftNodeEditor
    WorkSpace -->|"uses controls"| Controls
    WorkSpace -->|"uses controls"| CustomAlert
    WorkSpace -->|"uses controls"| PadControl
    WorkSpace -->|"uses popovers"| Popovers
    WorkSpace -->|"uses popups"| PopupView
    WorkSpace -->|"uses pager"| SwiftUIPager

    WorkSpace --> NodeCreate
    NodeCreate --> WMNode

    WorkSpace --> Pipeline
    Pipeline --> WMNode
    Pipeline --> ConvertNode
    Pipeline --> CarControlNode
    Pipeline -->|"drives UI widgets"| FlowPkg

    WorkSpace --> ControlPanel
    WorkSpace --> ArcKnob
    WorkSpace --> Content1
    WorkSpace --> ControlsDemoApp
    WorkSpace --> IndexedSlider
    WorkSpace --> Joystick
    WorkSpace --> Keyboard
    WorkSpace --> PitchModWheel
    WorkSpace --> Ribbon
    WorkSpace --> SmallKnob
    WorkSpace --> XYPad

    %% Click Events for Component Mapping
    click Controls "https://github.com/imengx/wiremage/tree/main/Package/Controls"
    click CustomAlert "https://github.com/imengx/wiremage/tree/main/Package/CustomAlert"
    click FlowPkg "https://github.com/imengx/wiremage/tree/main/Package/Flow"
    click PadControl "https://github.com/imengx/wiremage/tree/main/Package/PadControl"
    click PartitionKit "https://github.com/imengx/wiremage/tree/main/Package/PartitionKit"
    click Popovers "https://github.com/imengx/wiremage/tree/main/Package/Popovers"
    click PopupView "https://github.com/imengx/wiremage/tree/main/Package/PopupView"
    click SwiftNodeEditor "https://github.com/imengx/wiremage/tree/main/Package/SwiftNodeEditor"
    click SwiftUIPager "https://github.com/imengx/wiremage/tree/main/Package/SwiftUIPager"

    click App "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/WireMageApp.swift"
    click Doc "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/WireMageDocument.swift"

    click Codable "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Model/Codable.swift"
    click Define "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Model/Define.swift"
    click WMNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/WMNode.swift"

    click ProcNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ProcessingNode/ProcessingNode.swift"
    click ConvertNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ProcessingNode/ConvertNode.swift"

    click CarControlNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/TerminalNode/CarControlNode.swift"

    click ViewNodeNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ViewNode/ViewNode.swift"
    click ControlView "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ViewNode/ControlView.swift"
    click VCNode "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ViewNode/ViewComponentNode.swift"
    click VCNodeCopy "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Node/ViewNode/ViewComponentNode_副本.swift"

    click NodeCreate "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/NodeCreate/NodeCreate.swift"
    click NodeTemplate "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/NodeCreate/NodeTemplate.swift"

    click Pipeline "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Pipeline/Pipeline.swift"

    click WorkSpace "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/WorkSpace/WorkSpace.swift"
    click ControlPanel "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/WorkSpace/ControlPanel.swift"

    click ArcKnob "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/ArcKnobDemoView.swift"
    click Content1 "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/ContentView1.swift"
    click ControlsDemoApp "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/ControlsDemoApp.swift"
    click IndexedSlider "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/IndexedSliderDemoView.swift"
    click Joystick "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/JoystickDemoView.swift"
    click Keyboard "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/KeyboardDemoView.swift"
    click PitchModWheel "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/PitchModWheelDemoView.swift"
    click Ribbon "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/RibbonDemoView.swift"
    click SmallKnob "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/SmallKnobDemoView.swift"
    click XYPad "https://github.com/imengx/wiremage/blob/main/WireMage/WireMage/Shared/XYPadDemoView.swift"

    %% Styles
    classDef external fill:#E0F7FA,stroke:#00838F,stroke-dasharray: 5 5
    classDef model fill:#E8F5E9,stroke:#2E7D32
    classDef ui fill:#FFF3E0,stroke:#EF6C00
    classDef doc fill:#ECEFF1,stroke:#546E7A,stroke-dasharray: 2 2
```
