nucleation 0.10.22 → 0.10.24

package/renderer/Voxelizer.d.ts

@@ -0,0 +1,80 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Palette } from "./Palette.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { Shape } from "./Shape.mjs"
+import type { VoxelModel } from "./VoxelModel.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Namespace for the mesh-voxelization entry points (GLB/OBJ → shapes
+ * and textured schematics).
+ */
+export class Voxelizer {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Reason the last configured model import failed; cleared on success.
+     */
+    static lastErrorDetail(): string;
+
+    /**
+     * PHP-friendly GLB input: avoids expanding every byte into a boxed
+     * integer array before copying it over FFI.
+     */
+    static loadGlbBase64(data: string): VoxelModel;
+
+    /**
+     * Parse a GLB once for axis-based size estimates and lit voxelization.
+     */
+    static loadGlb(data: Array<number>): VoxelModel;
+
+    /**
+     * Parse an OBJ once for axis-based size estimates and lit voxelization.
+     */
+    static loadObj(text: string): VoxelModel;
+
+    /**
+     * Load a binary glTF (`.glb`, embedded buffers/images) and voxelize
+     * it into a fillable Shape: the model is uniformly scaled so its
+     * largest dimension equals `target_size` voxels, centered on x/z
+     * with its base resting at y = 0. Solidity is a parity test at each
+     * voxel center (robust on closed meshes), plus — when `shell` > 0 —
+     * every voxel whose center is within `shell` blocks of the surface,
+     * which rescues thin walls and hollow vessels (0.7–1.0 closes
+     * single-voxel shells; 0 = pure parity; a *negative* `shell` is
+     * surface-only — a skin |shell| blocks thick with no interior fill,
+     * for open sheets/ribbons that dip or self-overlap). Errors with `Parse` on
+     * malformed/triangle-less GLB and `InvalidArgument` on a
+     * non-positive `target_size`.
+     */
+    static shapeFromGlb(data: Array<number>, targetSize: number, shell: number): Shape;
+
+    /**
+     * Load a Wavefront OBJ (`v`/`vt`/`f` lines; polygon faces are
+     * fan-triangulated, negative indices supported, materials ignored)
+     * and voxelize it into a fillable Shape, fitted and shelled exactly
+     * like `shape_from_glb`. Errors with `Parse` on malformed/triangle-less
+     * OBJ and `InvalidArgument` on invalid UTF-8 or a non-positive
+     * `target_size`.
+     */
+    static shapeFromObj(text: string, targetSize: number, shell: number): Shape;
+
+    /**
+     * Load a binary glTF and voxelize it directly into a textured
+     * schematic named `name`: every solid voxel becomes the `palette`
+     * block closest to its nearest-surface texture color (interior
+     * voxels inherit the nearest surface color; voxels without texture
+     * info snap to mid-gray). `shell` behaves as in `shape_from_glb` —
+     * use ~0.7 for thin-walled models. Errors with `Parse` on malformed GLB and
+     * `InvalidArgument` on invalid UTF-8 or a non-positive
+     * `target_size`.
+     */
+    static schematicFromGlbTextured(data: Array<number>, targetSize: number, shell: number, palette: Palette, name: string): Schematic;
+}

package/renderer/Voxelizer.mjs

@@ -0,0 +1,261 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import { Palette } from "./Palette.mjs"
+import { Schematic } from "./Schematic.mjs"
+import { Shape } from "./Shape.mjs"
+import { VoxelModel } from "./VoxelModel.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const Voxelizer_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.Voxelizer_destroy(ptr);
+});
+
+/**
+ * Namespace for the mesh-voxelization entry points (GLB/OBJ → shapes
+ * and textured schematics).
+ */
+export class Voxelizer {
+    // Internal ptr reference:
+    #ptr = null;
+
+    // Lifetimes are only to keep dependencies alive.
+    // Since JS won't garbage collect until there are no incoming edges.
+    #selfEdge = [];
+
+    #internalConstructor(symbol, ptr, selfEdge) {
+        if (symbol !== diplomatRuntime.internalConstructor) {
+            console.error("Voxelizer is an Opaque type. You cannot call its constructor.");
+            return;
+        }
+        this.#ptr = ptr;
+        this.#selfEdge = selfEdge;
+
+        // Are we being borrowed? If not, we can register.
+        if (this.#selfEdge.length === 0) {
+            Voxelizer_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Reason the last configured model import failed; cleared on success.
+     */
+    static lastErrorDetail() {
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+    wasm.Voxelizer_last_error_detail(write.buffer);
+
+        try {
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            write.free();
+        }
+    }
+
+    /**
+     * PHP-friendly GLB input: avoids expanding every byte into a boxed
+     * integer array before copying it over FFI.
+     */
+    static loadGlbBase64(data) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const dataSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, data)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_load_glb_base64(diplomatReceive.buffer, dataSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new VoxelModel(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Parse a GLB once for axis-based size estimates and lit voxelization.
+     */
+    static loadGlb(data) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const dataSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, data, "u8")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_load_glb(diplomatReceive.buffer, dataSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new VoxelModel(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Parse an OBJ once for axis-based size estimates and lit voxelization.
+     */
+    static loadObj(text) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const textSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, text)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_load_obj(diplomatReceive.buffer, textSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new VoxelModel(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Load a binary glTF (`.glb`, embedded buffers/images) and voxelize
+     * it into a fillable Shape: the model is uniformly scaled so its
+     * largest dimension equals `target_size` voxels, centered on x/z
+     * with its base resting at y = 0. Solidity is a parity test at each
+     * voxel center (robust on closed meshes), plus — when `shell` > 0 —
+     * every voxel whose center is within `shell` blocks of the surface,
+     * which rescues thin walls and hollow vessels (0.7–1.0 closes
+     * single-voxel shells; 0 = pure parity; a *negative* `shell` is
+     * surface-only — a skin |shell| blocks thick with no interior fill,
+     * for open sheets/ribbons that dip or self-overlap). Errors with `Parse` on
+     * malformed/triangle-less GLB and `InvalidArgument` on a
+     * non-positive `target_size`.
+     */
+    static shapeFromGlb(data, targetSize, shell) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const dataSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, data, "u8")));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_shape_from_glb(diplomatReceive.buffer, dataSlice.ptr, targetSize, shell);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new Shape(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Load a Wavefront OBJ (`v`/`vt`/`f` lines; polygon faces are
+     * fan-triangulated, negative indices supported, materials ignored)
+     * and voxelize it into a fillable Shape, fitted and shelled exactly
+     * like `shape_from_glb`. Errors with `Parse` on malformed/triangle-less
+     * OBJ and `InvalidArgument` on invalid UTF-8 or a non-positive
+     * `target_size`.
+     */
+    static shapeFromObj(text, targetSize, shell) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const textSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, text)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_shape_from_obj(diplomatReceive.buffer, textSlice.ptr, targetSize, shell);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new Shape(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    /**
+     * Load a binary glTF and voxelize it directly into a textured
+     * schematic named `name`: every solid voxel becomes the `palette`
+     * block closest to its nearest-surface texture color (interior
+     * voxels inherit the nearest surface color; voxels without texture
+     * info snap to mid-gray). `shell` behaves as in `shape_from_glb` —
+     * use ~0.7 for thin-walled models. Errors with `Parse` on malformed GLB and
+     * `InvalidArgument` on invalid UTF-8 or a non-positive
+     * `target_size`.
+     */
+    static schematicFromGlbTextured(data, targetSize, shell, palette, name) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const dataSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.slice(wasm, data, "u8")));
+        const nameSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, name)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.Voxelizer_schematic_from_glb_textured(diplomatReceive.buffer, dataSlice.ptr, targetSize, shell, palette.ffiValue, nameSlice.ptr);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return new Schematic(diplomatRuntime.internalConstructor, diplomatRuntime.ptrRead(wasm, diplomatReceive.buffer), []);
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+        }
+    }
+
+    constructor(symbol, ptr, selfEdge) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/WorldChunkView.d.mts

@@ -0,0 +1,75 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A single decoded chunk (or a from-scratch chunk under construction).
+ */
+export class WorldChunkView {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an empty chunk view at the given chunk coordinates — the
+     * starting point for generating worlds from scratch. Sections are
+     * created on demand by `set_block`. Serialized with
+     * `status = "minecraft:full"` (Minecraft will not regenerate over it)
+     * and the default data version.
+     */
+    static create(cx: number, cz: number): WorldChunkView;
+
+    /**
+     * The chunk X coordinate (in chunk units).
+     */
+    cx(): number;
+
+    /**
+     * The chunk Z coordinate (in chunk units).
+     */
+    cz(): number;
+
+    /**
+     * Convert the chunk view to a standalone schematic.
+     */
+    toSchematic(): Schematic;
+
+    /**
+     * Build a chunk view at (`cx`, `cz`) from a schematic — every non-air
+     * block whose world (x, z) falls in this chunk is copied in, the rest
+     * ignored. The write-side twin of `to_schematic`: this is how the
+     * schematic building tools become a *world generator*. Fill a schematic
+     * with any shape, SDF, brush, or footprint (intersect it with the
+     * chunk's cuboid to keep memory flat), then hand it here per chunk and
+     * `WorldSink.write_chunk` it. Also the transform step of a world filter:
+     * `to_schematic` a streamed chunk, edit it, rebuild with this.
+     */
+    static fromSchematic(schematic: Schematic, cx: number, cz: number): WorldChunkView;
+
+    /**
+     * Set a block at absolute world coordinates inside this chunk view.
+     * `block_name` must be a valid Minecraft block identifier (e.g.
+     * `minecraft:stone`). Errors with `InvalidArgument` if (x, z) is outside
+     * this chunk's column.
+     */
+    setBlock(x: number, y: number, z: number, blockName: string): void;
+
+    /**
+     * Overwrite the biome of every currently-present section of the chunk
+     * view with `biome_name` (e.g. `minecraft:desert`). Sections are created
+     * lazily by `set_block`, so call this AFTER placing blocks.
+     */
+    setBiome(biomeName: string): void;
+
+    /**
+     * Deduped union of all sections' biome palette entries, in order of
+     * first appearance, written as a JSON array string (`[]` if no section
+     * carries biome data).
+     */
+    biomePaletteJson(): string;
+}

package/renderer/WorldChunkView.d.ts

@@ -0,0 +1,75 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { Schematic } from "./Schematic.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * A single decoded chunk (or a from-scratch chunk under construction).
+ */
+export class WorldChunkView {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create an empty chunk view at the given chunk coordinates — the
+     * starting point for generating worlds from scratch. Sections are
+     * created on demand by `set_block`. Serialized with
+     * `status = "minecraft:full"` (Minecraft will not regenerate over it)
+     * and the default data version.
+     */
+    static create(cx: number, cz: number): WorldChunkView;
+
+    /**
+     * The chunk X coordinate (in chunk units).
+     */
+    cx(): number;
+
+    /**
+     * The chunk Z coordinate (in chunk units).
+     */
+    cz(): number;
+
+    /**
+     * Convert the chunk view to a standalone schematic.
+     */
+    toSchematic(): Schematic;
+
+    /**
+     * Build a chunk view at (`cx`, `cz`) from a schematic — every non-air
+     * block whose world (x, z) falls in this chunk is copied in, the rest
+     * ignored. The write-side twin of `to_schematic`: this is how the
+     * schematic building tools become a *world generator*. Fill a schematic
+     * with any shape, SDF, brush, or footprint (intersect it with the
+     * chunk's cuboid to keep memory flat), then hand it here per chunk and
+     * `WorldSink.write_chunk` it. Also the transform step of a world filter:
+     * `to_schematic` a streamed chunk, edit it, rebuild with this.
+     */
+    static fromSchematic(schematic: Schematic, cx: number, cz: number): WorldChunkView;
+
+    /**
+     * Set a block at absolute world coordinates inside this chunk view.
+     * `block_name` must be a valid Minecraft block identifier (e.g.
+     * `minecraft:stone`). Errors with `InvalidArgument` if (x, z) is outside
+     * this chunk's column.
+     */
+    setBlock(x: number, y: number, z: number, blockName: string): void;
+
+    /**
+     * Overwrite the biome of every currently-present section of the chunk
+     * view with `biome_name` (e.g. `minecraft:desert`). Sections are created
+     * lazily by `set_block`, so call this AFTER placing blocks.
+     */
+    setBiome(biomeName: string): void;
+
+    /**
+     * Deduped union of all sections' biome palette entries, in order of
+     * first appearance, written as a JSON array string (`[]` if no section
+     * carries biome data).
+     */
+    biomePaletteJson(): string;
+}