Library overhaul

Author: HeDo88TH

.gitignore

@@ -47,3 +47,5 @@ _deps
 *.exe
 *.out
 *.app
+
+build

CMakeLists.txt

@@ -1,22 +1,28 @@
-#export CMAKE_PREFIX_PATH=path to Qt/5.5/gcc_64/ (where you would find bin/qmake)
-cmake_minimum_required(VERSION 3.1)
-project(nexus)
+cmake_minimum_required(VERSION 3.16)
+project(nexus LANGUAGES CXX)
 
-option(BUILD_NXS_BUILD "" OFF)
-option(BUILD_NXS_EDIT "" OFF)
+option(BUILD_TESTS        "Build unit tests"           OFF)
 
-set (CMAKE_CXX_STANDARD 11)
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
 
 # enable setting options with SET cmake command
 set(CMAKE_POLICY_DEFAULT_CMP0077 NEW)
 
 set(CMAKE_WINDOWS_EXPORT_ALL_SYMBOLS ON)
 
-find_package(Qt5 COMPONENTS Core Gui REQUIRED)
+# --- vcpkg packages ---
+find_package(ZLIB       REQUIRED)
+find_package(PNG        REQUIRED)
+find_package(JPEG       REQUIRED)
+find_package(plog       CONFIG REQUIRED)
+find_package(Stb REQUIRED)
+find_path(BSHOSHANY_THREAD_POOL_INCLUDE_DIRS "BS_thread_pool.hpp")
 
 # nexus version
 if (EXISTS "${CMAKE_CURRENT_SOURCE_DIR}/NEXUS_VERSION")
-	file (READ "${CMAKE_CURRENT_SOURCE_DIR}/NEXUS_VERSION" NEXUS_VERSION)
+	file(READ "${CMAKE_CURRENT_SOURCE_DIR}/NEXUS_VERSION" NEXUS_VERSION)
+	string(STRIP "${NEXUS_VERSION}" NEXUS_VERSION)
 else()
 	message(FATAL_ERROR "NEXUS_VERSION file not found in the repository")
 endif()
@@ -52,11 +58,7 @@ add_subdirectory(src/corto EXCLUDE_FROM_ALL)
 
 add_subdirectory(src)
 
-if (BUILD_NXS_BUILD)
-	add_subdirectory(src/nxsbuild)
+if(BUILD_TESTS)
+	enable_testing()
+	add_subdirectory(tests)
 endif()
-
-if(BUILD_NXS_EDIT)
-	add_subdirectory(src/nxsedit)
-endif()
-

README.md

@@ -1,90 +1,106 @@
-# Nexus
+# libnexus
 
-Nexus is a c++/javascript library for creation and visualization of a batched multiresolution 3D model structure.
+**Fork of [cnr-isti-vclab/nexus](https://github.com/cnr-isti-vclab/nexus)** — restructured as a **C++ static library** (`libnexus`) for programmatic creation and compression of batched multiresolution 3D models.
 
-[Nexus](http://vcg.isti.cnr.it/nexus/) by [Visual Computing Laboratory](http://vcg.isti.cnr.it) - ISTI - CNR
+All command-line executables (`nxsbuild`, `nxscompress`, `nxsview`, `nxsedit`) and Qt dependencies have been removed. The library exposes a clean C API for integration into any C/C++ application.
 
-Contact me @ federico.ponchio@isti.cnr.it 
+## Entry Points
 
-See [INSTALL.MD](INSTALL.md) for compilation instructions.
+The public API is defined in [`src/common/nxs.h`](src/common/nxs.h):
 
-### Main features
+```c
+#include "common/nxs.h"
 
-* Multiresolution
-* Large models
-* Textures or color per vertex
-* Streaming
-* Compression
-* WebGL
+// Simple build: input mesh → output .nxs or .nxz
+NXSErr nexusBuild(const char *input,
+                  const char *output,
+                  char *errorMessage,
+                  int errorMessageSize);
 
-### Basic usage
+// Extended build with full control over all parameters
+NXSErr nexusBuildEx(const char *input,
+                    const char *output,
+                    const NexusBuildOptions &options,
+                    char *errorMessage,
+                    int errorMessageSize);
+```
 
-Starting from a 3D model (.ply), drag and drop it on the **nxsbuild** executable, and it will be converted into a multiresolution nexus model (.nxs). Drag the multiresolution nexus model (.nxs) onto the **nxscompress** executable to compress it, and the result will be a compressed multiresolution nexus model (.nxz). 
+**Return codes** (`NXSErr`):
+| Value | Meaning |
+|-------|---------|
+| `NXSERR_NONE` (0) | Success |
+| `NXSERR_EXCEPTION` (1) | Internal error |
+| `NXSERR_INVALID_INPUT` (2) | Invalid input file or parameters |
 
-gargo.ply --> **nxsbuild** --> gargo.nxs --> **nxscompress.exe** --> gargo.nxz
+**`NexusBuildOptions`** controls geometry build (node size, scaling, texture quality, point cloud mode, normals/colors/texcoords toggling) and compression (corto/meco codec, quantization bits for coordinates, normals, colors, textures).
 
-Drag and drop either .nxs or .nxz files on **nxsview** to interactively inspect the generated 3D multiresolution model.
+If the output filename ends with `.nxz`, the library automatically performs compression after the build step.
 
------------------------------------------------------------------------------------------
+## Building
 
-### Create the .nxs model
+### Prerequisites
 
-Use [nxsbuild](doc/nxsbuild.md) to create a multiresolution nexus model (.nxs) out of your 3D model (.ply):
+- CMake ≥ 3.16
+- C++17 compiler
+- [vcpkg](https://github.com/microsoft/vcpkg) with the following packages:
+  `zlib`, `libpng`, `libjpeg-turbo`, `stb`, `plog`, `bshoshany-thread-pool`
+- [VCGLib](https://github.com/cnr-isti-vclab/vcglib) (auto-detected from `../vcglib` or pass `-DVCGDIR=...`)
 
-	$ nxsbuild gargo.ply
+### Windows (PowerShell)
 
-The result will be gargo.nxs. For large files this may take quite some time. See the [man](doc/nxsbuild.md) page for all the options, supported input files etc.
+```powershell
+./build.ps1                 # Release build
+./build.ps1 -WithTests      # Include unit tests
+./build.ps1 -Debug           # Debug build
+```
 
-### Compress the multiresolution model
+### Linux / macOS
 
-The model can be compressed, saving aroung 90% of the size. This is most useful for streaming applications:
+```bash
+./build.sh                  # Release build
+./build.sh --with-tests     # Include unit tests
+./build.sh --debug          # Debug build
+```
 
-	$ nxcompress gargo.nxs
+### Manual CMake
 
-The result will be gargo.nxz.
-Detailed information about the compression parameters can be found in the [man](doc/nxcompress.md) page.
+```bash
+cmake -B build \
+  -DCMAKE_TOOLCHAIN_FILE=$VCPKG_ROOT/scripts/buildsystems/vcpkg.cmake \
+  -DCMAKE_BUILD_TYPE=Release \
+  -DBUILD_TESTS=ON
 
+cmake --build build --config Release
+```
 
-### Edit, Info and Simplify
+Output: `build/src/Release/libnexus.lib` (Windows) or `build/src/liblibnexus.a` (Linux/macOS).
 
-[Nxsedit](doc/nxsedit.md) can be used for many editing operations on the multiresolution model.
-For instance, you can get some statistics on the created model (bounding sphere, list of patches, etc.):
+## Tests
 
-	$ nxsedit gargo.nxs -i
+Unit tests use [Google Test](https://github.com/google/googletest) and require additional vcpkg packages: `gtest`, `cpr`, `minizip-ng`.
 
-Or also, you can simplify the .nxs file (pruning the lowest level of the multiresolution tree):
+```bash
+cmake -B build -DBUILD_TESTS=ON
+cmake --build build
+ctest --test-dir build -C Release --output-on-failure
+```
 
-	$ nxsedit gargo.nxs -l -o simplified_gargo.nxs
+## Project Structure
 
-Detailed information about the editing parameters can be found in the [man](doc/nxedit.md) page.
+```
+src/
+  common/        Core library: file I/O, image, data structures, nxs API
+  nxsbuild/      Mesh loading, KD-tree, multiresolution builder
+  nxsedit/       Extraction / compression
+  nxszip/        Low-level mesh encoding/decoding (corto/meco)
+  corto/         Corto compression library (submodule)
+  cmake/         CMake packaging helpers
+tests/           Google Test unit tests
+```
 
-### Inspect your model.
-
-[Nxsview](doc/nxsview.md) is a simple program for inspecting a .nxs file:
-
-	$ nxsview gargo.nxs 
-
-You can tune various parameters through the interface, but be sure to read the available options in the [man](doc/nxsview.md) page.
-
-
-### WebGL
-
-The easiest way to publish the model on the web is to use [3DHOP](http://3dhop.net) interface.
-Alternatively you can use Three.js: there is a minimal example in the HTML directory of the GitHub [Nexus repository](https://github.com/cnr-isti-vclab/nexus).
-It is strongly recommended to use compression for the models (nxscompress).
-
-
-### Library
-
-The visualization algorithm can be easily used as library inside your engine, both in C++ or in JavaScript,
-basically the algorithm job is to send geometry to the GPU.
-
-
-### Dependencies and Licenses
-
-All C++ Nexus software is free and released under the GPL license (it depends on Qt and VCG lib).
-All Javascript Nexus software is free and release under the MIT license.
+## Original Project
 
+Based on [Nexus](http://vcg.isti.cnr.it/nexus/) by [Visual Computing Laboratory](http://vcg.isti.cnr.it) - ISTI - CNR.
 
 ### Publications
 
@@ -94,35 +110,14 @@ Graphical Models, Volume 88, pp. 1-11, November 2016
 
 [Fast decompression for web-based view-dependent 3D rendering](http://vcg.isti.cnr.it/Publications/2015/PD15/Ponchio_Compressed.pdf)
 Federico Ponchio, Matteo Dellepiane
-Web3D 2015. Proceedings of the 20th International Conference on 3D Web Technology , pp. 199-207, June 2015
+Web3D 2015. Proceedings of the 20th International Conference on 3D Web Technology, pp. 199-207, June 2015
 
 [Multiresolution structures for interactive visualization of very large 3D datasets](http://vcg.isti.cnr.it/~ponchio/download/ponchio_phd.pdf)
-Federico Ponchio
-Phd Thesis
-
-[Interactive Rendering of Dynamic Geometry](http://vcg.isti.cnr.it/Publications/2008/PH08/dynamic.pdf)
-F. Ponchio, K. Hormann
-IEEE Transaction on Visualization and Computer Graphics, Volume 14, Number 4, pp. 914-925, July 2008
-
-[Batched Multi Triangulation](http://vcg.isti.cnr.it/Publications/2005/CGGMPS05/BatchedMT_Vis05.pdf)
-Paolo Cignoni, Fabio Ganovelli, Enrico Gobbetti, Fabio Marton, Federico Ponchio, Roberto Scopigno
-Proceedings IEEE Visualization, pp. 207-214, October 2005
-
-[Adaptive TetraPuzzles: Efficient Out-of-Core Construction and Visualization of Gigantic Multiresolution Polygonal Models](http://vcg.isti.cnr.it/publications/papers/vbdam_sig04.pdf)
-P. Cignoni, F. Ganovelli, E. Gobbetti, F. Marton, F. Ponchio, R. Scopigno
-ACM Trans. on Graphics, vol. 23(3), pp. 796-803, August 2004 (Siggraph '04)
-
-[BDAM: Batched Dynamic Adaptive Meshes for High Performance Terrain Visualization](http://vcg.isti.cnr.it/publications/papers/bdam.pdf)
-P.Cignoni, F.Ganovelli, E. Gobbetti, F.Marton, F. Ponchio, R. Scopigno
-Computer Graphics Forum, 22(3), pp. 505-514, September 2003
-
-### Feedback
-
-For documented and repeatable bugs, feature requests, etc., please use the [GitHub issues](https://github.com/cnr-isti-vclab/nexus/issues).
+Federico Ponchio, PhD Thesis
 
-### Support and thanks
+## License
 
-Thanks, support: VCL Informatic department in TU Clausthal, 3D-COFORM. Also to Kai Hormann for having me write the thesis :)
+GPL — see [src/LICENSE](src/LICENSE).
 
 
 

build.ps1

@@ -0,0 +1,125 @@
+# ============================================================
+#  libnexus - Build Script for Windows (PowerShell)
+# ============================================================
+[CmdletBinding()]
+param(
+    [switch]$DebugBuild,
+    [switch]$Release,
+    [string]$BuildDir = "build",
+    [switch]$WithTests,
+    [string]$VcpkgRoot = "",
+    [string]$Generator = "",
+    [int]$Jobs = 0,
+    [switch]$Help
+)
+
+Set-StrictMode -Version Latest
+$ErrorActionPreference = "Stop"
+
+if ($Help) {
+    Write-Host @"
+
+ Usage: ./build.ps1 [OPTIONS]
+
+ Options:
+   -DebugBuild          Build in Debug mode
+   -Release            Build in Release mode (default)
+   -BuildDir <dir>     Output build directory (default: build)
+   -WithTests          Enable unit tests (BUILD_TESTS=ON)
+   -VcpkgRoot <path>   Path to vcpkg root (auto-detected if not set)
+   -Generator <name>   CMake generator (e.g. "Ninja", "Visual Studio 17 2022")
+   -Jobs <n>           Parallel build jobs
+   -Help               Show this help message
+
+"@
+    exit 0
+}
+
+# --- Determine build type ---
+$BuildType = if ($DebugBuild) { "Debug" } else { "Release" }
+
+Write-Host ""
+Write-Host "============================================================"
+Write-Host " libnexus Build Script (Windows PowerShell)"
+Write-Host " Configuration : $BuildType"
+Write-Host " Build dir     : $BuildDir"
+Write-Host " Tests         : $($WithTests.IsPresent)"
+Write-Host "============================================================"
+Write-Host ""
+
+# --- Detect vcpkg ---
+if (-not $VcpkgRoot) {
+    if ($env:VCPKG_ROOT) {
+        $VcpkgRoot = $env:VCPKG_ROOT
+    } elseif (Test-Path "$env:USERPROFILE\vcpkg\vcpkg.exe") {
+        $VcpkgRoot = "$env:USERPROFILE\vcpkg"
+    } elseif (Test-Path "C:\vcpkg\vcpkg.exe") {
+        $VcpkgRoot = "C:\vcpkg"
+    } elseif (Test-Path "C:\dev\vcpkg\vcpkg.exe") {
+        $VcpkgRoot = "C:\dev\vcpkg"
+    }
+}
+
+$VcpkgToolchain = ""
+if ($VcpkgRoot) {
+    $VcpkgToolchain = "-DCMAKE_TOOLCHAIN_FILE=$VcpkgRoot\scripts\buildsystems\vcpkg.cmake"
+    Write-Host "[INFO] Using vcpkg at: $VcpkgRoot"
+} else {
+    Write-Host "[WARNING] vcpkg not found. Set -VcpkgRoot or VCPKG_ROOT environment variable."
+    Write-Host "          Proceeding without vcpkg toolchain."
+}
+
+# --- Generator flag ---
+$GeneratorFlag = @()
+if ($Generator) {
+    $GeneratorFlag = @("-G", $Generator)
+}
+
+# --- CMake options ---
+$TestsFlag = if ($WithTests) { "ON" } else { "OFF" }
+
+# --- Configure ---
+Write-Host "[INFO] Running CMake configure..."
+$cmakeArgs = @("-B", $BuildDir) + $GeneratorFlag
+if ($VcpkgToolchain) { $cmakeArgs += $VcpkgToolchain }
+$cmakeArgs += @(
+    "-DCMAKE_BUILD_TYPE=$BuildType",
+    "-DBUILD_TESTS=$TestsFlag"
+)
+& cmake @cmakeArgs
+if ($LASTEXITCODE -ne 0) {
+    Write-Host ""
+    Write-Host "[ERROR] CMake configure failed." -ForegroundColor Red
+    exit $LASTEXITCODE
+}
+
+# --- Build ---
+Write-Host ""
+Write-Host "[INFO] Building..."
+$buildArgs = @("--build", $BuildDir, "--config", $BuildType)
+if ($Jobs -gt 0) {
+    $buildArgs += @("--", "/maxcpucount:$Jobs")
+}
+& cmake @buildArgs
+if ($LASTEXITCODE -ne 0) {
+    Write-Host ""
+    Write-Host "[ERROR] Build failed." -ForegroundColor Red
+    exit $LASTEXITCODE
+}
+
+# --- Tests ---
+if ($WithTests) {
+    Write-Host ""
+    Write-Host "[INFO] Running tests..."
+    & ctest --test-dir $BuildDir -C $BuildType --output-on-failure
+    if ($LASTEXITCODE -ne 0) {
+        Write-Host ""
+        Write-Host "[ERROR] Some tests failed." -ForegroundColor Red
+        exit $LASTEXITCODE
+    }
+}
+
+Write-Host ""
+Write-Host "[SUCCESS] Build completed successfully." -ForegroundColor Green
+Write-Host "          Output in: $BuildDir\"
+Write-Host ""