# stasilo/retrace.gl architecture

> Architecture diagram of the GitHub repository stasilo/retrace.gl, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-20). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/stasilo/retrace.gl
- Repository: https://github.com/stasilo/retrace.gl

## Overview

Retrace.gl is a browser-based SDF sculpting and physically based path-tracing app. Users author or regenerate a declarative scene, choose rendering options, preview it in realtime or render it, and can export SDF geometry as an STL mesh. The graph preserves the documented geometry, material, texture, BVH, camera, and editor capabilities. Sampled source establishes the central store orchestration and several implementation links; other feature links are included only where the README documents them.

Main entry points: [`src/dtos/dynamic-scene/index.js`](https://github.com/stasilo/retrace.gl/blob/master/src/dtos/dynamic-scene/index.js) (Scene API), [`src/store/index.js`](https://github.com/stasilo/retrace.gl/blob/master/src/store/index.js) (App store), [`src/raytracer/index.js`](https://github.com/stasilo/retrace.gl/blob/master/src/raytracer/index.js) (Path tracer), [`src/sdf-exporter/index.js`](https://github.com/stasilo/retrace.gl/blob/master/src/sdf-exporter/index.js) (SDF mesh export)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_app["App interaction"]
  node_ui["Editor UI<br/>[index.js]"]
  node_editor["Source editor<br/>[index.js]"]
  node_store["App store<br/>[index.js]"]
  node_storage["Scene storage<br/>[index.js]"]
end

subgraph group_scene["Scene authoring"]
  node_scene_api["Scene API<br/>[index.js]"]
  node_scene_model["Scene model<br/>[index.js]"]
  node_camera["Camera<br/>[index.js]"]
end

subgraph group_render["Rendering"]
  node_bvh["BVH builder<br/>[index.js]"]
  node_bvh_algorithm["BVH algorithm<br/>[index.js]"]
  node_gl["WebGL context<br/>[index.js]"]
  node_raytracer["Path tracer<br/>[index.js]"]
  node_shader["Ray-tracing shader<br/>[raytracer.glsl.js]"]
  node_dynamic_shader["Dynamic texture shader"]
end

subgraph group_assets["Geometry and assets"]
  node_sdf["SDF models<br/>[index.js]"]
  node_mesh["Mesh and volume models<br/>[index.js]"]
  node_obj_encoder["OBJ encoder<br/>[index.js]"]
  node_materials["Materials<br/>[index.js]"]
  node_textures["Textures<br/>[index.js]"]
  node_volume_textures["Volume textures<br/>[index.js]"]
end

subgraph group_export["Export"]
  node_sdf_export["SDF mesh export<br/>[index.js]"]
  node_march["Cube marching<br/>[index.js]"]
  node_stl["STL exporter<br/>[index.js]"]
  node_stl_writer["STL writer<br/>[stl-writer.js]"]
end

node_user(("Artist"))

node_user -->|"edits and controls"| node_ui
node_ui -->|"reads state"| node_store
node_editor -->|"updates scene source"| node_store
node_store -->|"evaluates scene"| node_scene_api
node_store -->|"starts render"| node_raytracer
node_store -->|"starts export"| node_sdf_export
node_store -->|"uses storage"| node_storage
node_scene_api -->|"constructs scene"| node_scene_model
node_scene_api -->|"creates camera"| node_camera
node_scene_api -->|"creates SDF geometry"| node_sdf
node_scene_api -->|"creates geometry"| node_mesh
node_scene_api -->|"creates materials"| node_materials
node_scene_api -->|"creates textures"| node_textures
node_scene_api -->|"creates volume textures"| node_volume_textures
node_mesh -->|"encodes OBJ"| node_obj_encoder
node_raytracer -->|"builds acceleration data"| node_bvh
node_bvh -->|"builds hierarchy"| node_bvh_algorithm
node_raytracer -->|"gets WebGL context"| node_gl
node_raytracer -->|"creates shader"| node_shader
node_shader -->|"uses geometry layout"| node_bvh
node_textures -->|"creates GPU texture"| node_gl
node_textures -->|"renders dynamic texture"| node_dynamic_shader
node_sdf_export -->|"builds acceleration data"| node_bvh
node_sdf_export -->|"marches geometry"| node_march
node_sdf_export -->|"exports mesh"| node_stl
node_stl -->|"writes STL"| node_stl_writer

click node_ui "https://github.com/stasilo/retrace.gl/blob/master/src/ui/index.js"
click node_editor "https://github.com/stasilo/retrace.gl/blob/master/src/ui/components/editor/index.js"
click node_store "https://github.com/stasilo/retrace.gl/blob/master/src/store/index.js"
click node_storage "https://github.com/stasilo/retrace.gl/blob/master/src/scene-storage/index.js"
click node_scene_api "https://github.com/stasilo/retrace.gl/blob/master/src/dtos/dynamic-scene/index.js"
click node_scene_model "https://github.com/stasilo/retrace.gl/blob/master/src/dtos/scene/index.js"
click node_camera "https://github.com/stasilo/retrace.gl/blob/master/src/camera/index.js"
click node_sdf "https://github.com/stasilo/retrace.gl/blob/master/src/models/sdf-model/index.js"
click node_mesh "https://github.com/stasilo/retrace.gl/blob/master/src/models/obj-model/index.js"
click node_obj_encoder "https://github.com/stasilo/retrace.gl/blob/master/src/model-encoders/obj/index.js"
click node_materials "https://github.com/stasilo/retrace.gl/blob/master/src/materials/base-material/index.js"
click node_textures "https://github.com/stasilo/retrace.gl/blob/master/src/textures/texture/index.js"
click node_volume_textures "https://github.com/stasilo/retrace.gl/blob/master/src/textures/volume-texture/index.js"
click node_bvh "https://github.com/stasilo/retrace.gl/blob/master/src/bvh/index.js"
click node_bvh_algorithm "https://github.com/stasilo/retrace.gl/blob/master/src/bvh/bvh-builder/index.js"
click node_gl "https://github.com/stasilo/retrace.gl/blob/master/src/gl/index.js"
click node_raytracer "https://github.com/stasilo/retrace.gl/blob/master/src/raytracer/index.js"
click node_shader "https://github.com/stasilo/retrace.gl/blob/master/src/shaders/raytracer.glsl.js"
click node_dynamic_shader "https://github.com/stasilo/retrace.gl/blob/master/src/shaders/dynamicTexRender.glsl.js"
click node_sdf_export "https://github.com/stasilo/retrace.gl/blob/master/src/sdf-exporter/index.js"
click node_march "https://github.com/stasilo/retrace.gl/blob/master/src/cubemarch/index.js"
click node_stl "https://github.com/stasilo/retrace.gl/blob/master/src/stl-exporter/index.js"
click node_stl_writer "https://github.com/stasilo/retrace.gl/blob/master/src/stl-exporter/stl-writer.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_ui,node_editor,node_store,node_storage toneBlue
class node_scene_api,node_scene_model,node_camera toneAmber
class node_bvh,node_bvh_algorithm,node_gl,node_raytracer,node_shader,node_dynamic_shader toneMint
class node_sdf,node_mesh,node_obj_encoder,node_materials,node_textures,node_volume_textures toneRose
class node_sdf_export,node_march,node_stl,node_stl_writer,node_user toneIndigo
```

## Components

### App interaction

- [Editor UI](https://github.com/stasilo/retrace.gl/blob/master/src/ui/index.js): `src/ui/index.js`
- [Source editor](https://github.com/stasilo/retrace.gl/blob/master/src/ui/components/editor/index.js): `src/ui/components/editor/index.js`
- [App store](https://github.com/stasilo/retrace.gl/blob/master/src/store/index.js): `src/store/index.js`
- [Scene storage](https://github.com/stasilo/retrace.gl/blob/master/src/scene-storage/index.js): `src/scene-storage/index.js`

### Scene authoring

- [Scene API](https://github.com/stasilo/retrace.gl/blob/master/src/dtos/dynamic-scene/index.js): `src/dtos/dynamic-scene/index.js`
- [Scene model](https://github.com/stasilo/retrace.gl/blob/master/src/dtos/scene/index.js): `src/dtos/scene/index.js`
- [Camera](https://github.com/stasilo/retrace.gl/blob/master/src/camera/index.js): `src/camera/index.js`

### Rendering

- [BVH builder](https://github.com/stasilo/retrace.gl/blob/master/src/bvh/index.js): `src/bvh/index.js`
- [BVH algorithm](https://github.com/stasilo/retrace.gl/blob/master/src/bvh/bvh-builder/index.js): `src/bvh/bvh-builder/index.js`
- [WebGL context](https://github.com/stasilo/retrace.gl/blob/master/src/gl/index.js): `src/gl/index.js`
- [Path tracer](https://github.com/stasilo/retrace.gl/blob/master/src/raytracer/index.js): `src/raytracer/index.js`
- [Ray-tracing shader](https://github.com/stasilo/retrace.gl/blob/master/src/shaders/raytracer.glsl.js): `src/shaders/raytracer.glsl.js`
- [Dynamic texture shader](https://github.com/stasilo/retrace.gl/blob/master/src/shaders/dynamicTexRender.glsl.js): `src/shaders/dynamicTexRender.glsl.js`

### Geometry and assets

- [SDF models](https://github.com/stasilo/retrace.gl/blob/master/src/models/sdf-model/index.js): `src/models/sdf-model/index.js`
- [Mesh and volume models](https://github.com/stasilo/retrace.gl/blob/master/src/models/obj-model/index.js): `src/models/obj-model/index.js`
- [OBJ encoder](https://github.com/stasilo/retrace.gl/blob/master/src/model-encoders/obj/index.js): `src/model-encoders/obj/index.js`
- [Materials](https://github.com/stasilo/retrace.gl/blob/master/src/materials/base-material/index.js): `src/materials/base-material/index.js`
- [Textures](https://github.com/stasilo/retrace.gl/blob/master/src/textures/texture/index.js): `src/textures/texture/index.js`
- [Volume textures](https://github.com/stasilo/retrace.gl/blob/master/src/textures/volume-texture/index.js): `src/textures/volume-texture/index.js`

### Export

- [SDF mesh export](https://github.com/stasilo/retrace.gl/blob/master/src/sdf-exporter/index.js): `src/sdf-exporter/index.js`
- [Cube marching](https://github.com/stasilo/retrace.gl/blob/master/src/cubemarch/index.js): `src/cubemarch/index.js`
- [STL exporter](https://github.com/stasilo/retrace.gl/blob/master/src/stl-exporter/index.js): `src/stl-exporter/index.js`
- [STL writer](https://github.com/stasilo/retrace.gl/blob/master/src/stl-exporter/stl-writer.js): `src/stl-exporter/stl-writer.js`

### Other components

- **Artist**

## Connections

- Artist → Editor UI: edits and controls
- Editor UI → App store: reads state (evidence: `src/ui/index.js`)
- Source editor → App store: updates scene source (evidence: `src/ui/components/editor/index.js`)
- App store → Scene API: evaluates scene (evidence: `src/store/index.js`)
- App store → Path tracer: starts render (evidence: `src/store/index.js`)
- App store → SDF mesh export: starts export (evidence: `src/store/index.js`)
- App store → Scene storage: uses storage (evidence: `src/store/index.js`)
- Scene API → Scene model: constructs scene (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → Camera: creates camera (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → SDF models: creates SDF geometry (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → Mesh and volume models: creates geometry (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → Materials: creates materials (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → Textures: creates textures (evidence: `src/dtos/dynamic-scene/index.js`)
- Scene API → Volume textures: creates volume textures (evidence: `src/dtos/dynamic-scene/index.js`)
- Mesh and volume models → OBJ encoder: encodes OBJ (evidence: `src/models/obj-model/index.js`)
- Path tracer → BVH builder: builds acceleration data (evidence: `src/raytracer/index.js`)
- BVH builder → BVH algorithm: builds hierarchy (evidence: `src/bvh/index.js`)
- Path tracer → WebGL context: gets WebGL context (evidence: `src/raytracer/index.js`)
- Path tracer → Ray-tracing shader: creates shader (evidence: `src/raytracer/index.js`)
- Ray-tracing shader → BVH builder: uses geometry layout (evidence: `src/shaders/raytracer.glsl.js`)
- Textures → WebGL context: creates GPU texture (evidence: `src/textures/texture/index.js`)
- Textures → Dynamic texture shader: renders dynamic texture (evidence: `src/textures/texture/index.js`)
- SDF mesh export → BVH builder: builds acceleration data (evidence: `src/sdf-exporter/index.js`)
- SDF mesh export → Cube marching: marches geometry (evidence: `src/sdf-exporter/index.js`)
- SDF mesh export → STL exporter: exports mesh (evidence: `src/sdf-exporter/index.js`)
- STL exporter → STL writer: writes STL (evidence: `src/stl-exporter/index.js`)
