# bradleyseymoursae/ue5_simplegroomexporter architecture

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

- Interactive diagram: https://gitdiagram.com/bradleyseymoursae/ue5_simplegroomexporter
- Repository: https://github.com/bradleyseymoursae/ue5_simplegroomexporter

## Overview

##### Project Type and Purpose
- The project is an Unreal Engine 5 plugin designed to export groom assets to Alembic files.
- Its main purpose is to integrate into the Unreal Editor – via a context menu “right click” action on the groom asset – and then perform a very basic export of hair base curves (with room for future extension like adding hair attributes).

##### File Structure
- The top-level structure contains configuration files (.gitignore, Config/FilterPlugin.ini) and a plugin descriptor (SimpleGroomExporter.uplugin).
- The Source directory follows a typical Unreal Engine module layout with separate Public (interface definitions) and Private (implementation details) subdirectories.
- The Build configuration file (SimpleGroomExporter.Build.cs) indicates that the Unreal Build Tool is used to compile the plugin.
- This clear separation aligns with Unreal’s module-based architecture, which suggests the system is organized as a single plugin rather than a full-stack system.

##### Key Components
a. Unreal Engine 5 Editor:
- Acts as the host environment.
- Provides the UI (asset context menu) to trigger the export.
b. SimpleGroomExporter Plugin (Core Module):
- Contains the module initialization code (e.g., SimpleGroomExporterModule.cpp and its header in Public).
- Encapsulates both editor integration and the export functionality.
c. Groom Asset Export Mechanism:
- The logic implemented within files like SimpleGroomExporter.cpp handles the export operation.
- Processes groom assets and extracts details (currently only base curves).
d. Configuration:
- Config/FilterPlugin.ini for configuring plugin behavior or export options (if applicable).
e. Build System:
- SimpleGroomExporter.Build.cs ensuring the module compiles correctly with Unreal’s build system.
f. External Interfaces:
- The exported file itself (Alembic file) representing an external artifact.
- Optionally, integration with external services (such as for binaries on Discord) although these are more peripheral.

##### Determining Relationships and Interactions
- Within the plugin module, include a breakdown into subcomponents – one handling asset extraction (processing of the groom asset) and one managing file I/O (writing out the Alembic file).
- How configuration settings (via the FilterPlugin.ini) might influence the export logic.
- Dependency between the plugin module and the Unreal Engine runtime APIs.

## Diagram (Mermaid)

```mermaid
graph TD
    Editor["Unreal Engine 5 Editor"]:::unreal

    subgraph "SimpleGroomExporter Plugin Module"
        ModuleImpl["Module Implementation"]:::plugin
        ModuleHeader["Module Interface"]:::plugin
    end

    subgraph "Groom Asset Export Mechanism"
        GroomImpl["Export Implementation"]:::groom
        GroomHeader["Export Interface"]:::groom
    end

    Config["Configuration (FilterPlugin.ini)"]:::config
    Build["Build System (SimpleGroomExporter.Build.cs)"]:::build
    Output["Alembic File Output"]:::external

    Editor -->|"trigger"| ModuleImpl
    ModuleHeader -->|"integratesWith"| Editor
    ModuleImpl -->|"calls"| GroomImpl
    GroomImpl -->|"writesAlembic"| Output
    Config -->|"configures"| ModuleImpl
    Build -->|"compiles"| ModuleImpl

    click ModuleImpl "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Source/SimpleGroomExporter/Private/SimpleGroomExporterModule.cpp"
    click ModuleHeader "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Source/SimpleGroomExporter/Public/SimpleGroomExporterModule.h"
    click GroomImpl "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Source/SimpleGroomExporter/Private/SimpleGroomExporter.cpp"
    click GroomHeader "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Source/SimpleGroomExporter/Private/SimpleGroomExporter.h"
    click Config "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Config/FilterPlugin.ini"
    click Build "https://github.com/bradleyseymoursae/ue5_simplegroomexporter/blob/master/Source/SimpleGroomExporter/SimpleGroomExporter.Build.cs"

    classDef unreal fill:#F9E79F,stroke:#D4AC0D,stroke-width:2px;
    classDef plugin fill:#D5F5E3,stroke:#28B463,stroke-width:2px;
    classDef groom fill:#FCF3CF,stroke:#F1C40F,stroke-width:2px;
    classDef config fill:#D6EAF8,stroke:#2E86C1,stroke-width:2px;
    classDef build fill:#FADBD8,stroke:#E74C3C,stroke-width:2px;
    classDef external fill:#E8DAEF,stroke:#8E44AD,stroke-width:2px;
```
