# m0o0scar/looking-gloves architecture

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

- Interactive diagram: https://gitdiagram.com/m0o0scar/looking-gloves
- Repository: https://github.com/m0o0scar/looking-gloves

## Overview

##### Main Components
- Frontend UI Layer – This is the Next.js client-side part that handles the user interface.
- Pages (in the “pages” directory) serve as entry points (e.g., index, images, luma, quilt, rgbd, video) and API endpoints (e.g., pages/api/luma/getInfo.tsx).
- Components are organized into several subcategories:
▪ Blocks: Components for external API integrations or authentication (e.g., LoginToBlocksButton, PublishToBlocksButton, blocksAuthClient, useBlocksAPI).
▪ Common: General reusable UI components (e.g., Cropper, ExternalLink, IconButton, ProgressBar, etc.).
▪ Editor: Components that help the user create quilt images and manage steps and progress (e.g., QuiltImageCreator, QuiltImageCreatorSteps, useCurrentStep, useProgress).
▪ Processors: Components handling various processing tasks like extracting frames from videos, image sequence processing, light field cropping, and focus adjustment (e.g., ImageSequenceProcessor, QuiltFramesExtractor, VideoFramesExtractor, LightFieldCropEditor).
▪ Quilt: Components specifically for quilt image viewing, previewing, saving, and interfacing with the actual device (e.g., QuiltImage, QuiltImagePreview, QuiltImageSaveButton).

- Backend / API Layer – Built using Next.js API routes that expose server-side endpoints (see “pages/api”).
- Luma API endpoints provide info and potentially process data for handling “luma” operations.

- Public / Asset Layer – Static files and additional scripts.
- “public/assets” holds media files like “how-to-cross-eyes.mp4.”
- “public/pyscripts” contains Python scripts (e.g., quiltDetector.py) that might be invoked through a backend process or locally through a service.
- “public/sw-quilt.js” suggests support for a service worker or client-side processing.

- Utility/Helper Services – Various functions used across the application.
- The “utils” folder includes modules for handling canvas operations, clipboard, DOM interactions, downloads, image and video processing and service worker functions.

##### Relationships and Interactions
- The Next.js pages use the various UI components to build interactive workflows for creating holograms.
- Editor components interact with the processing components to transform user inputs (or image sequences) into quilt images suitable for holographic display.
- API routes act as bridges for more complex operations (such as “luma” processing), potentially invoking Python scripts or other processing logic.
- Utility functions support various modules at both UI and backend levels for common tasks (e.g., image transformation, fetching data).

##### Architectural Patterns and Design Principles
- Modular Component Architecture: The project distinguishes components by domain (blocks, common, editor, processors, quilt), indicating separation of concerns.
- MVC-like Structure: Pages (controllers) manage high-level flows and integrate with lower-level UI components (views) and processing modules (models/business logic).
- API Layer in Next.js: Clearly separated API routes suggest a backend service component, streamlining the front-to-back communication.
- Integration with External Scripts/Services: The presence of Python scripts and a service worker shows cross-technology integration, which must be noted in the system design.

##### Relevant Technologies and Frameworks
- Next.js (React) is the core framework for both pages and UI components.
- Tailwind CSS (configured via tailwind.config.js) for styling.
- ESLint, Prettier for code quality.
- TypeScript throughout (evident by .ts and .tsx files) for static typing and rigorous development.
- Possibly Python for specialized image processing (via public/pyscripts).
- Light Field libraries or custom logic in processing modules (e.g., LightFieldFocusViewer, LightFieldMaterial).

- Frontend Layer:
- Pages (e.g., Index, Images, Luma, Quilt, RGBD, Video)
- UI Components:
▪ Blocks (external service integration)
▪ Common (reusable UI controls)
▪ Editor (workflow management for quilt creation)
▪ Processors (handling transformation of image sequences and videos)
▪ Quilt (final display and device interfacing)
- API/Backend Layer:
- Next.js API routes (e.g., luma/getInfo)
- Integration with Python scripts (quiltDetector)
- Asset and Utility Layer:
- Public media and scripts (video assets, pyscripts, service workers)
- Utilities (canvas, image, video processing, and helper functions)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend Layer"
        %% Pages Subgraph
        subgraph "Pages"
            A1["Index"]:::pages
            A2["Images"]:::pages
            A3["Luma"]:::pages
            A4["Quilt"]:::pages
            A5["RGBD"]:::pages
            A6["Video"]:::pages
            A7["API: Luma GetInfo"]:::api
        end

        %% UI Components Subgraph
        subgraph "UI Components"
            %% Blocks
            subgraph "Blocks"
                B1["LoginToBlocksButton"]:::ui
                B2["PublishToBlocksButton"]:::ui
                B3["blocksAuthClient"]:::ui
                B4["useBlocksAPI"]:::ui
            end
            %% Common
            subgraph "Common"
                C1["Cropper"]:::ui
                C2["ExternalLink"]:::ui
                C3["HomeBtn"]:::ui
                C4["IconButton"]:::ui
                C5["ImageSequenceAnimation"]:::ui
                C6["LightFieldFocusViewer"]:::ui
                C7["LightFieldMaterial"]:::ui
                C8["PageCard"]:::ui
                C9["PageContainer"]:::ui
                C10["ProgressBar"]:::ui
            end
            %% Editor
            subgraph "Editor"
                D1["QuiltImageCreator"]:::ui
                D2["QuiltImageCreatorSteps"]:::ui
                D3["useCurrentStep"]:::ui
                D4["useProgress"]:::ui
                D5["useSequence"]:::ui
                D6["useSource"]:::ui
            end
            %% Processors
            subgraph "Processors"
                E1["ImageSequenceProcessor"]:::ui
                E2["LightFieldCropEditor"]:::ui
                E3["LightFieldFocusEditor"]:::ui
                E4["LumaLightfieldDownloader"]:::ui
                E5["LumaLightfieldRangeSelector"]:::ui
                E6["QuiltFramesExtractor"]:::ui
                E7["VideoFramesExtractor"]:::ui
                E8["types"]:::ui
            end
            %% Quilt
            subgraph "Quilt"
                F1["QuiltImage"]:::ui
                F2["QuiltImageFlipOrderButton"]:::ui
                F3["QuiltImagePreview"]:::ui
                F4["QuiltImageSaveButton"]:::ui
                F5["QuiltImageViewOnDeviceButton"]:::ui
            end
        end
    end

    %% Public / Asset Layer
    subgraph "Public / Asset Layer"
        subgraph "Static Assets"
            PA1["how-to-cross-eyes.mp4"]:::asset
        end
        subgraph "Python Scripts"
            PA2["quiltDetector.py"]:::asset
        end
        subgraph "Service Worker"
            PA3["sw-quilt.js"]:::asset
        end
    end

    %% Utility / Helper Services
    subgraph "Utility / Helper Services"
        U1["canvas.ts"]:::util
        U2["clipboard.ts"]:::util
        U3["constant.ts"]:::util
        U4["dom.ts"]:::util
        U5["download.ts"]:::util
        U6["fetch.ts"]:::util
        U7["holoplay.js"]:::util
        U8["image.ts"]:::util
        U9["pyscript.ts"]:::util
        U10["rgbd.ts"]:::util
        U11["serviceWorker.ts"]:::util
        U12["time.ts"]:::util
        U13["useOnce.ts"]:::util
        U14["useOpen.ts"]:::util
        U15["utils.ts"]:::util
        U16["video.ts"]:::util
    end

    %% Relationships
    A1 -->|"renders"| B1
    D1 -->|"triggers"| E1
    B1 -->|"callsAPI"| A7
    A7 -->|"invokes"| PA2
    A1 -->|"usesAsset"| PA1
    A1 -->|"usesUtil"| U15
    D3 -->|"leverages"| U13
    C4 -->|"usesHelper"| U4
    A1 -->|"registersSW"| PA3
    PA3 -->|"utilizes"| U11

    %% Styles
    classDef pages fill:#AEDFF7,stroke:#333,stroke-width:2px;
    classDef ui fill:#C8FACC,stroke:#333,stroke-width:2px;
    classDef api fill:#F7D6AE,stroke:#333,stroke-width:2px;
    classDef asset fill:#F7A8A8,stroke:#333,stroke-width:2px;
    classDef util fill:#E2D1F9,stroke:#333,stroke-width:2px;

    %% Click Events for Pages
    click A1 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/index.tsx"
    click A2 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/images.tsx"
    click A3 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/luma.tsx"
    click A4 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/quilt.tsx"
    click A5 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/rgbd.tsx"
    click A6 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/video.tsx"
    click A7 "https://github.com/m0o0scar/looking-gloves/blob/main/pages/api/luma/getInfo.tsx"

    %% Click Events for Blocks Components
    click B1 "https://github.com/m0o0scar/looking-gloves/blob/main/components/blocks/LoginToBlocksButton.tsx"
    click B2 "https://github.com/m0o0scar/looking-gloves/blob/main/components/blocks/PublishToBlocksButton.tsx"
    click B3 "https://github.com/m0o0scar/looking-gloves/blob/main/components/blocks/blocksAuthClient.ts"
    click B4 "https://github.com/m0o0scar/looking-gloves/blob/main/components/blocks/useBlocksAPI.ts"

    %% Click Events for Common Components
    click C1 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/Cropper.tsx"
    click C2 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/ExternalLink.tsx"
    click C3 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/HomeBtn.tsx"
    click C4 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/IconButton.tsx"
    click C5 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/ImageSequenceAnimation.tsx"
    click C6 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/LightFieldFocusViewer.tsx"
    click C7 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/LightFieldMaterial.tsx"
    click C8 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/PageCard.tsx"
    click C9 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/PageContainer.tsx"
    click C10 "https://github.com/m0o0scar/looking-gloves/blob/main/components/common/ProgressBar.tsx"

    %% Click Events for Editor Components
    click D1 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/QuiltImageCreator.tsx"
    click D2 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/QuiltImageCreatorSteps.tsx"
    click D3 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/useCurrentStep.ts"
    click D4 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/useProgress.ts"
    click D5 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/useSequence.ts"
    click D6 "https://github.com/m0o0scar/looking-gloves/blob/main/components/editor/useSource.ts"

    %% Click Events for Processors Components
    click E1 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/ImageSequenceProcessor.tsx"
    click E2 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/LightFieldCropEditor.tsx"
    click E3 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/LightFieldFocusEditor.tsx"
    click E4 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/LumaLightfieldDownloader.tsx"
    click E5 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/LumaLightfieldRangeSelector.tsx"
    click E6 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/QuiltFramesExtractor.tsx"
    click E7 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/VideoFramesExtractor.tsx"
    click E8 "https://github.com/m0o0scar/looking-gloves/blob/main/components/processors/types.ts"

    %% Click Events for Quilt Components
    click F1 "https://github.com/m0o0scar/looking-gloves/blob/main/components/quilt/QuiltImage.tsx"
    click F2 "https://github.com/m0o0scar/looking-gloves/blob/main/components/quilt/QuiltImageFlipOrderButton.tsx"
    click F3 "https://github.com/m0o0scar/looking-gloves/blob/main/components/quilt/QuiltImagePreview.tsx"
    click F4 "https://github.com/m0o0scar/looking-gloves/blob/main/components/quilt/QuiltImageSaveButton.tsx"
    click F5 "https://github.com/m0o0scar/looking-gloves/blob/main/components/quilt/QuiltImageViewOnDeviceButton.tsx"

    %% Click Events for Public/Asset Layer
    click PA1 "https://github.com/m0o0scar/looking-gloves/blob/main/public/assets/how-to-cross-eyes.mp4"
    click PA2 "https://github.com/m0o0scar/looking-gloves/blob/main/public/pyscripts/quiltDetector.py"
    click PA3 "https://github.com/m0o0scar/looking-gloves/blob/main/public/sw-quilt.js"

    %% Click Events for Utility/Helper Services
    click U1 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/canvas.ts"
    click U2 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/clipboard.ts"
    click U3 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/constant.ts"
    click U4 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/dom.ts"
    click U5 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/download.ts"
    click U6 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/fetch.ts"
    click U7 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/holoplay.js"
    click U8 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/image.ts"
    click U9 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/pyscript.ts"
    click U10 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/rgbd.ts"
    click U11 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/serviceWorker.ts"
    click U12 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/time.ts"
    click U13 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/useOnce.ts"
    click U14 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/useOpen.ts"
    click U15 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/utils.ts"
    click U16 "https://github.com/m0o0scar/looking-gloves/blob/main/utils/video.ts"
```
