Состояние на момент заведения репозитория. C++ приложение (src/, shaders/, tests/) — минимальный редактор 3D-моделей на Vulkan 1.3: орбитальная камера, три опорные сетки через начало координат, загрузка .obj с режимами отображения. Весь Vulkan изолирован в src/vk/. Исследование (docs/) — оригинальные статьи по KBC (docs/origins) и Python-решатель D2Q9 KBC-N1 с AMR 2x и SDF+Bouzidi (docs/theory). В решателе перед коммитом исправлены дефекты, найденные сверкой с первоисточниками: относительный порог знаменателя энтропийного стабилизатора (абсолютный вырождал KBC в LBGK на 77-99% узлов), заворот вход/выход в углах домена, диагностика средней плотности по фиктивным узлам тела, зашитый refine=2. Подробности — docs/theory/solver_2x_sdf/README.md. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
62 lines
1.8 KiB
Markdown
62 lines
1.8 KiB
Markdown
# SimVulcan
|
|
|
|
A minimal Vulkan 1.3 / C++20 **3D model editor**: an orbit camera over three
|
|
reference grid planes through the origin, with `.obj` model loading and display.
|
|
|
|
## Features
|
|
|
|
* Orbit camera — drag to rotate around the centre, wheel to zoom, and Front / Top
|
|
/ Side buttons to align the view to the principal planes.
|
|
* A 3D editor space: three grid planes (XY, XZ, YZ) and coloured X/Y/Z axes meeting
|
|
at the origin.
|
|
* `.obj` loading with three display modes — solid (flat-shaded), wireframe, and
|
|
solid + wireframe overlay.
|
|
* ImGui interface (Viewport controls + Mesh load panel).
|
|
|
|
All Vulkan code is isolated in `src/vk/`; the rest of the app is Vulkan-free.
|
|
|
|
## Targets
|
|
|
|
* Windows x64 (MSVC / clang-cl)
|
|
* Linux x64 (gcc / clang)
|
|
* macOS arm64 (Apple Silicon, via MoltenVK)
|
|
|
|
## Prerequisites
|
|
|
|
* Vulkan SDK 1.3.290+ (`https://vulkan.lunarg.com/`)
|
|
* CMake 3.26+
|
|
* Ninja
|
|
* C++20 compiler (MSVC 19.36+, gcc 11+, clang 14+)
|
|
|
|
## Build
|
|
|
|
```sh
|
|
cmake --preset windows-msvc-release
|
|
cmake --build --preset windows-msvc-release
|
|
```
|
|
|
|
Run from the executable's own directory (`build/<preset>/src/app/`) so it finds
|
|
the `spirv/` and `assets/` trees copied next to it.
|
|
|
|
## Tests
|
|
|
|
```sh
|
|
cmake --build --preset windows-msvc-debug --target simv_tests
|
|
ctest --preset windows-msvc-debug
|
|
```
|
|
|
|
## Layout
|
|
|
|
```
|
|
src/
|
|
core/ Logger, Window, App (orchestration, Vulkan-free)
|
|
vk/ All Vulkan: Context, Swapchain, Buffer, Image, Shader, GpuMesh,
|
|
Renderer (frame loop + depth + ImGui), MeshRenderer, GridRenderer
|
|
mesh/ CPU mesh: tinyobjloader + welding (no Vulkan)
|
|
editor/ Camera, mouse input, EditorUI + MeshLoadPanel (ImGui, no Vulkan)
|
|
app/ main.cpp
|
|
shaders/
|
|
editor/ mesh + grid vertex/fragment shaders (GLSL → SPIR-V at build time)
|
|
tests/ Catch2 unit tests (mesh math)
|
|
```
|