# slsai2003/alterior-ar-based-interior-design architecture

> Architecture diagram of the GitHub repository slsai2003/alterior-ar-based-interior-design, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-10-29). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/slsai2003/alterior-ar-based-interior-design
- Repository: https://github.com/slsai2003/alterior-ar-based-interior-design

## Overview

##### Project type and purpose
- This is a Unity-based AR prototype (“ALTERIOR – AR-Based Interior Design”) whose sole feature is placing a single 3D sofa model into a live environment.
- It uses AR Foundation, Vuforia, and Unity’s XR Plugin framework to handle device tracking, plane detection, and image-target recognition.

##### File structure
- Top-level Unity conventions:
– Assets/ contains all runtime and Editor assets (scenes, models, configurations, scripts).
– Packages/ holds manifest.json for Package Manager dependencies.
– ProjectSettings/ defines all editor and engine project settings.
- Under Assets/:
– Assets/Scenes/SampleScene.unity: the AR scene where sofa placement occurs.
– Assets/chair.glb: the 3D sofa model.
– Assets/Resources: GLTF importer settings and VuforiaConfiguration (for image-target parameters).
– Assets/StreamingAssets/Vuforia: image-target data (.dat/.xml) used at runtime by Vuforia.
– Assets/XR and Packages/ manifest.json: XR Plugin Management enabling ARCoreLoader, MockHMDLoader, SimulationLoader.
– Assets/Editor/Migration: a script that adds the Vuforia Engine package automatically in the Unity Editor.

##### README for additional insights
- Confirms it’s an early prototype, no additional features beyond sofa placement.
- Technologies: Unity (Engine + Editor), C#, AR Foundation (cross-platform AR API), Vuforia (image targets), ARCore for Android, XR Simulation for Editor testing.

##### Detail
- Both Editor-time and Runtime flows so maintainers can see how packages are injected and how AR data propagates into the final app.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Subgraph: Unity Editor & Build Pipeline
    subgraph "Unity Editor & Build Pipeline"
        direction TB
        EditorMigration["AddVuforiaEnginePackage.cs"]:::editor
        Manifest["manifest.json"]:::editor
        EditorMigration -->|injects Vuforia into| Manifest
        Manifest -->|drives| Build["Build Mobile App"]:::editor
    end

    %% Subgraph: Device Hardware
    subgraph "Device Hardware"
        direction TB
        Sensors["Sensors & Camera"]:::hardware
    end

    %% Subgraph: Runtime Application
    subgraph "Runtime Application"
        direction TB

        %% AR Foundation Layer
        subgraph "AR Foundation Layer" 
            direction TB
            ARF["AR Foundation"]:::runtime
        end

        %% XR Plugin Management
        subgraph "XR Plugin Management"
            direction TB
            ARCoreLoader["ARCoreLoader.asset"]:::runtime
            SimulationLoader["SimulationLoader.asset"]:::runtime
            MockHMDLoader["MockHMDLoader.asset"]:::runtime
            XRGeneral["XRGeneralSettingsPerBuildTarget.asset"]:::runtime
            XRCoreSettings["ARCoreSettings.asset"]:::runtime
            XRSimSettings["XRSimulationSettings.asset"]:::runtime
            MockSettings["MockHMDBuildSettings.asset"]:::runtime
            ARCoreLoader & SimulationLoader & MockHMDLoader --> XRGeneral
        end

        %% Vuforia Engine
        subgraph "Vuforia Engine"
            direction TB
            VuforiaConfig["VuforiaConfiguration.asset"]:::runtime
            VuforiaDat["Alterior.dat"]:::runtime
            VuforiaXml["Alterior.xml"]:::runtime
            VuforiaConfig -->|uses| VuforiaDat
            VuforiaConfig -->|uses| VuforiaXml
        end

        %% Assets & Resources
        subgraph "Assets & Resources"
            direction TB
            SofaModel["chair.glb"]:::assets
            GLTFSettings["UnityGLTFSettings.asset"]:::assets
        end

        %% Game Logic
        subgraph "Game Logic"
            direction TB
            SofaLogic["SofaPlacementController (C# script)"]:::runtime
        end

        %% AR Scene
        Scene["SampleScene.unity"]:::runtime
    end

    %% Data Flows
    Sensors -->|camera feed| ARF
    ARF -->|pose data| ARCoreLoader
    ARF -->|plane detected| SofaLogic
    VuforiaDat & VuforiaXml -->|image targets| VuforiaConfig
    VuforiaConfig -->|recognition callbacks| SofaLogic
    SofaLogic -->|loads model| GLTFSettings
    GLTFSettings -->|imports| SofaModel
    SofaLogic -->|instantiates| Scene
    Scene -->|"renders via AR Camera"| Sensors

    %% Click events
    click EditorMigration "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/Editor/Migration/AddVuforiaEnginePackage.cs"
    click Manifest "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Packages/manifest.json"
    click ARCoreLoader "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Loaders/ARCoreLoader.asset"
    click SimulationLoader "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Loaders/SimulationLoader.asset"
    click MockHMDLoader "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Loaders/MockHMDLoader.asset"
    click XRGeneral "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/XRGeneralSettingsPerBuildTarget.asset"
    click XRCoreSettings "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Settings/ARCoreSettings.asset"
    click XRSimSettings "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Settings/XRSimulationSettings.asset"
    click MockSettings "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/XR/Settings/MockHMDBuildSettings.asset"
    click VuforiaDat "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/StreamingAssets/Vuforia/Alterior.dat"
    click VuforiaXml "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/StreamingAssets/Vuforia/Alterior.xml"
    click VuforiaConfig "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/Resources/VuforiaConfiguration.asset"
    click GLTFSettings "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/Resources/UnityGLTFSettings.asset"
    click SofaModel "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/chair.glb"
    click Scene "https://github.com/slsai2003/alterior-ar-based-interior-design/blob/main/Assets/Scenes/SampleScene.unity"

    %% Styles
    classDef editor fill:#cccccc,stroke:#333,stroke-width:1px
    classDef runtime fill:#cce5ff,stroke:#2a6ebb,stroke-width:1px
    classDef assets fill:#d4edda,stroke:#3c763d,stroke-width:1px
    classDef hardware fill:#f9e79f,stroke:#b7950b,stroke-width:1px
```
