# ufbx/ufbx architecture

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

- Interactive diagram: https://gitdiagram.com/ufbx/ufbx
- Repository: https://github.com/ufbx/ufbx

## Overview

##### Main Components

- Parser Layer
- FBX Binary Parser
- FBX ASCII Parser
- OBJ/MTL Parser
- XML/MCX Parser
- Core Processing Layer
- Scene Graph Builder
- Memory Management
- Data Sanitization
- Feature Processing Layer
- Animation System
- Geometry Processing
- Material System
- Utility Layer
- Triangulation
- Skinning
- NURBS Evaluation
- Subdivision Surface

##### Data Flow

- Input Files → Parser Layer → Core Processing → Feature Processing → Scene Data

##### Component Details

For each major component, include:
- Input/Output formats
- Key responsibilities
- Dependencies on other components

##### The optional nature of utility functions

Key Relationships to Show:

**Parser Layer**
- ↓
**Memory Management ← → Scene Graph Builder**
- ↓
**Feature Processors**
- ↓
**Utility Functions**

- Double lines: Data ownership transfer

##### The utility function architecture

This will give developers a clear understanding of both the high-level architecture and the detailed implementation structure while maintaining the library's emphasis on simplicity and safety.

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph "Input Files"
        FBX[FBX Files]
        OBJ[OBJ/MTL Files]
        XML[XML/MCX Files]
    end

    subgraph "Parser Layer"
        FBXBin["FBX Binary Parser"]
        FBXAsc["FBX ASCII Parser"]
        OBJParse["OBJ/MTL Parser"]
        XMLParse["XML/MCX Parser"]
    end

    subgraph "Core Processing Layer"
        SceneGraph["Scene Graph Builder"]
        MemMgmt["Memory Management"]:::memclass
        DataSan["Data Sanitization"]
    end

    subgraph "Feature Processing Layer"
        AnimSys["Animation System"]:::featclass
        GeomProc["Geometry Processing"]:::featclass
        MatSys["Material System"]:::featclass
    end

    subgraph "Utility Layer"
        Triang["Triangulation"]:::utilclass
        Skin["Skinning"]:::utilclass
        NURBS["NURBS Evaluation"]:::utilclass
        SubDiv["Subdivision Surface"]:::utilclass
    end

    subgraph "Examples"
        Viewer["Viewer"]:::example
        RayTracer["Ray Tracer"]:::example
    end

    %% Data Flow
    FBX --> FBXBin & FBXAsc
    OBJ --> OBJParse
    XML --> XMLParse

    FBXBin & FBXAsc & OBJParse & XMLParse --> MemMgmt
    MemMgmt <--> SceneGraph
    SceneGraph --> DataSan

    DataSan --> AnimSys & GeomProc & MatSys
    AnimSys & GeomProc & MatSys --> Triang & Skin & NURBS & SubDiv
    
    Triang & Skin & NURBS & SubDiv --> Viewer & RayTracer

    %% Styling
    classDef core fill:#a8d1f0
    classDef feat fill:#90EE90
    classDef util fill:#FFB366
    classDef mem fill:#E6E6E6
    classDef example fill:#D8BFD8

    class FBXBin,FBXAsc,OBJParse,XMLParse core
    class AnimSys,GeomProc,MatSys feat
    class Triang,Skin,NURBS,SubDiv util
    class MemMgmt mem
    class Viewer,RayTracer example

    %% Click Events
    click FBXBin,FBXAsc,OBJParse,XMLParse "https://github.com/ufbx/ufbx/blob/master/ufbx.c"
    click SceneGraph,MemMgmt,DataSan "https://github.com/ufbx/ufbx/blob/master/ufbx.h"
    click AnimSys "https://github.com/ufbx/ufbx/blob/master/test/test_animation.h"
    click MatSys "https://github.com/ufbx/ufbx/blob/master/test/test_material.h"
    click GeomProc "https://github.com/ufbx/ufbx/blob/master/test/test_mesh.h"
    click Triang "https://github.com/ufbx/ufbx/blob/master/test/test_triangulate.h"
    click Skin "https://github.com/ufbx/ufbx/blob/master/test/test_skin.h"
    click NURBS "https://github.com/ufbx/ufbx/blob/master/test/test_nurbs.h"
    click MemMgmt "https://github.com/ufbx/ufbx/blob/master/extra/ufbx_libc.h"
    click Viewer "https://github.com/ufbx/ufbx/blob/master/examples/viewer/viewer.c"
    click RayTracer "https://github.com/ufbx/ufbx/blob/master/examples/picort/picort.cpp"

    %% Legend
    subgraph Legend
        L1["Core Components"]:::core
        L2["Feature Processing"]:::feat
        L3["Utility Functions"]:::util
        L4["Memory Management"]:::mem
        L5["Example Applications"]:::example
    end
```
