nucleation 0.10.21 → 0.10.23

package/renderer/RedstoneGraph.mjs

@@ -0,0 +1,242 @@
+// generated by diplomat-tool
+import { NucleationError } from "./NucleationError.mjs"
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+const RedstoneGraph_box_destroy_registry = new FinalizationRegistry((ptr) => {
+    wasm.RedstoneGraph_destroy(ptr);
+});
+
+/**
+ * An extracted redstone logic graph. Wraps
+ * {@link crate::simulation::graph::RedstoneGraph}.
+ */
+export class RedstoneGraph {
+    // 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("RedstoneGraph 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) {
+            RedstoneGraph_box_destroy_registry.register(this, this.#ptr);
+        }
+
+        return this;
+    }
+    /** @internal */
+    get ffiValue() {
+        return this.#ptr;
+    }
+
+
+    /**
+     * Number of nodes in the graph.
+     */
+    nodeCount() {
+
+        const result = wasm.RedstoneGraph_node_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * Total number of directed edges in the graph.
+     */
+    edgeCount() {
+
+        const result = wasm.RedstoneGraph_edge_count(this.ffiValue);
+
+        try {
+            return result;
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+        }
+    }
+
+    /**
+     * The nodes as a JSON array string.
+     */
+    nodesJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.RedstoneGraph_nodes_json(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * The directed edges as a JSON array string.
+     */
+    edgesJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.RedstoneGraph_edges_json(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Computed graph features as a JSON object string.
+     */
+    featuresJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.RedstoneGraph_features_json(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Fingerprint (hex string) for `preset` ("structural" | "functional" |
+     * "exact"; empty defaults to "structural").
+     */
+    fingerprint(preset) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const presetSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, preset)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.RedstoneGraph_fingerprint(diplomatReceive.buffer, this.ffiValue, presetSlice.ptr, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            functionCleanupArena.free();
+
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Serialize the whole graph to JSON.
+     */
+    toJson() {
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+        const write = new diplomatRuntime.DiplomatWriteBuf(wasm);
+
+
+        const result = wasm.RedstoneGraph_to_json(diplomatReceive.buffer, this.ffiValue, write.buffer);
+
+        try {
+            if (!diplomatReceive.resultFlag) {
+                const cause = new NucleationError(diplomatRuntime.internalConstructor, diplomatRuntime.enumDiscriminant(wasm, diplomatReceive.buffer));
+                throw new globalThis.Error('NucleationError.' + cause.value, { cause });
+            }
+            return write.readString8();
+        }
+
+        finally {
+            diplomatRuntime.FUNCTION_PARAM_ALLOC.clean();
+            diplomatReceive.free();
+            write.free();
+        }
+    }
+
+    /**
+     * Deserialize a graph from a JSON string.
+     */
+    static fromJson(json) {
+        let functionCleanupArena = new diplomatRuntime.CleanupArena();
+
+        const jsonSlice = functionCleanupArena.alloc(diplomatRuntime.DiplomatBuf.sliceWrapper(wasm, diplomatRuntime.DiplomatBuf.str8(wasm, json)));
+        const diplomatReceive = new diplomatRuntime.DiplomatReceiveBuf(wasm, 5, 4, true);
+
+
+        const result = wasm.RedstoneGraph_from_json(diplomatReceive.buffer, jsonSlice.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 RedstoneGraph(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/RegionBounds.d.mts

@@ -0,0 +1,41 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type RegionBounds_obj = {
+    minX: number;
+    minY: number;
+    minZ: number;
+    maxX: number;
+    maxY: number;
+    maxZ: number;
+};
+
+
+
+/**
+ * An inclusive block-coordinate box (a definition region is a union of
+ * these).
+ */
+export class RegionBounds {
+    get minX(): number;
+    set minX(value: number);
+    get minY(): number;
+    set minY(value: number);
+    get minZ(): number;
+    set minZ(value: number);
+    get maxX(): number;
+    set maxX(value: number);
+    get maxY(): number;
+    set maxY(value: number);
+    get maxZ(): number;
+    set maxZ(value: number);
+    /** @internal */
+    static fromFields(structObj : RegionBounds_obj) : RegionBounds;
+
+    /**
+    * Create `RegionBounds` from an object that contains all of `RegionBounds`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: RegionBounds_obj);
+
+}

package/renderer/RegionBounds.d.ts

@@ -0,0 +1,41 @@
+// generated by diplomat-tool
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+export type RegionBounds_obj = {
+    minX: number;
+    minY: number;
+    minZ: number;
+    maxX: number;
+    maxY: number;
+    maxZ: number;
+};
+
+
+
+/**
+ * An inclusive block-coordinate box (a definition region is a union of
+ * these).
+ */
+export class RegionBounds {
+    get minX(): number;
+    set minX(value: number);
+    get minY(): number;
+    set minY(value: number);
+    get minZ(): number;
+    set minZ(value: number);
+    get maxX(): number;
+    set maxX(value: number);
+    get maxY(): number;
+    set maxY(value: number);
+    get maxZ(): number;
+    set maxZ(value: number);
+    /** @internal */
+    static fromFields(structObj : RegionBounds_obj) : RegionBounds;
+
+    /**
+    * Create `RegionBounds` from an object that contains all of `RegionBounds`s fields.
+    * Optional fields do not need to be included in the provided object.
+    */
+    constructor(structObj: RegionBounds_obj);
+
+}

package/renderer/RegionBounds.mjs

@@ -0,0 +1,182 @@
+// generated by diplomat-tool
+import wasm from "./diplomat-wasm.mjs";
+import * as diplomatRuntime from "./diplomat-runtime.mjs";
+
+
+
+/**
+ * An inclusive block-coordinate box (a definition region is a union of
+ * these).
+ */
+export class RegionBounds {
+    #minX;
+    get minX() {
+        return this.#minX;
+    }
+    set minX(value){
+        this.#minX = value;
+    }
+    #minY;
+    get minY() {
+        return this.#minY;
+    }
+    set minY(value){
+        this.#minY = value;
+    }
+    #minZ;
+    get minZ() {
+        return this.#minZ;
+    }
+    set minZ(value){
+        this.#minZ = value;
+    }
+    #maxX;
+    get maxX() {
+        return this.#maxX;
+    }
+    set maxX(value){
+        this.#maxX = value;
+    }
+    #maxY;
+    get maxY() {
+        return this.#maxY;
+    }
+    set maxY(value){
+        this.#maxY = value;
+    }
+    #maxZ;
+    get maxZ() {
+        return this.#maxZ;
+    }
+    set maxZ(value){
+        this.#maxZ = value;
+    }
+    /** @internal */
+    static fromFields(structObj) {
+        return new RegionBounds(structObj);
+    }
+
+    #internalConstructor(structObj) {
+        if (typeof structObj !== "object") {
+            throw new Error("RegionBounds's constructor takes an object of RegionBounds's fields.");
+        }
+
+        if ("minX" in structObj) {
+            this.#minX = structObj.minX;
+        } else {
+            throw new Error("Missing required field minX.");
+        }
+
+        if ("minY" in structObj) {
+            this.#minY = structObj.minY;
+        } else {
+            throw new Error("Missing required field minY.");
+        }
+
+        if ("minZ" in structObj) {
+            this.#minZ = structObj.minZ;
+        } else {
+            throw new Error("Missing required field minZ.");
+        }
+
+        if ("maxX" in structObj) {
+            this.#maxX = structObj.maxX;
+        } else {
+            throw new Error("Missing required field maxX.");
+        }
+
+        if ("maxY" in structObj) {
+            this.#maxY = structObj.maxY;
+        } else {
+            throw new Error("Missing required field maxY.");
+        }
+
+        if ("maxZ" in structObj) {
+            this.#maxZ = structObj.maxZ;
+        } else {
+            throw new Error("Missing required field maxZ.");
+        }
+
+        return this;
+    }
+
+    // Return this struct in FFI function friendly format.
+    // Returns an array that can be expanded with spread syntax (...)
+    _intoFFI(
+        dst,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+
+        this._writeToArrayBuffer(wasm.memory.buffer, dst, functionCleanupArena, appendArrayMap);
+
+        return dst;
+    }
+
+    static get _sizeBytes() {
+        return 24;
+    }
+
+    /// Currently unused, we may want to use later on though:
+    static get _sizeAlign() {
+        return 4;
+    }
+
+    static _fromSuppliedValue(internalConstructor, obj) {
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("_fromSuppliedValue cannot be called externally.");
+        }
+
+        if (obj instanceof RegionBounds) {
+            return obj;
+        }
+
+        return RegionBounds.fromFields(obj);
+    }
+
+    _writeToArrayBuffer(
+        arrayBuffer,
+        offset,
+        functionCleanupArena,
+        appendArrayMap
+    ) {
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 0, this.#minX, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 4, this.#minY, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 8, this.#minZ, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 12, this.#maxX, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 16, this.#maxY, Int32Array);
+        diplomatRuntime.writeToArrayBuffer(arrayBuffer, offset + 20, this.#maxZ, Int32Array);
+    }
+
+    // This struct contains borrowed fields, so this takes in a list of
+    // "edges" corresponding to where each lifetime's data may have been borrowed from
+    // and passes it down to individual fields containing the borrow.
+    // This method does not attempt to handle any dependencies between lifetimes, the caller
+    // should handle this when constructing edge arrays.
+    static _fromFFI(internalConstructor, ptr) {
+        ptr >>>= 0; // unsigned wasm32 address; field values retain their signedness.
+        if (internalConstructor !== diplomatRuntime.internalConstructor) {
+            throw new Error("RegionBounds._fromFFI is not meant to be called externally. Please use the default constructor.");
+        }
+        let structObj = {};
+        const minXDeref = (new Int32Array(wasm.memory.buffer, ptr, 1))[0];
+        structObj.minX = minXDeref;
+        const minYDeref = (new Int32Array(wasm.memory.buffer, ptr + 4, 1))[0];
+        structObj.minY = minYDeref;
+        const minZDeref = (new Int32Array(wasm.memory.buffer, ptr + 8, 1))[0];
+        structObj.minZ = minZDeref;
+        const maxXDeref = (new Int32Array(wasm.memory.buffer, ptr + 12, 1))[0];
+        structObj.maxX = maxXDeref;
+        const maxYDeref = (new Int32Array(wasm.memory.buffer, ptr + 16, 1))[0];
+        structObj.maxY = maxYDeref;
+        const maxZDeref = (new Int32Array(wasm.memory.buffer, ptr + 20, 1))[0];
+        structObj.maxZ = maxZDeref;
+
+        return new RegionBounds(structObj);
+    }
+
+
+    constructor(structObj) {
+        return this.#internalConstructor(...arguments)
+    }
+}

package/renderer/RenderConfig.d.mts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Camera / output configuration for rendering.
+ */
+export class RenderConfig {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a config with the given output size in pixels. Camera starts
+     * at the defaults: yaw 45°, pitch 30°, zoom 1.0, fov 45°, perspective
+     * projection, default sky background.
+     */
+    static create(width: number, height: number): RenderConfig;
+
+    /**
+     * Set the camera yaw (horizontal orbit angle) in degrees. Default: 45.
+     */
+    setYaw(yaw: number): void;
+
+    /**
+     * Set the camera pitch (downward tilt) in degrees. Default: 30.
+     */
+    setPitch(pitch: number): void;
+
+    /**
+     * Set the zoom factor applied to the auto-fitted framing
+     * (1.0 = frame the whole model; 2.0 = twice as close; 0.5 = twice
+     * as far). Default: 1.0.
+     */
+    setZoom(zoom: number): void;
+
+    /**
+     * Fit the camera to the model's bounding sphere instead of its
+     * yaw-dependent silhouette. The sphere is rotation invariant, so
+     * orbiting cameras (turntables) keep a constant distance instead
+     * of pulsing as the silhouette changes. Frames slightly looser
+     * than the default fit. Default: false.
+     */
+    setSphereFit(sphereFit: boolean): void;
+
+    /**
+     * Set the vertical field of view in degrees (perspective projection
+     * only). Default: 45.
+     */
+    setFov(fov: number): void;
+
+    /**
+     * Set the world-space directional light and its non-negative intensity.
+     */
+    setDirectionalLight(x: number, y: number, z: number, intensity: number): void;
+
+    /**
+     * Set the unlit floor for non-HDRI rendering, in `0..=1`.
+     */
+    setAmbientLight(ambient: number): void;
+
+    /**
+     * Set a solid RGBA clear color (linear 0.0–1.0). Alpha < 1.0 yields a
+     * transparent PNG. Ignored when HDRI is enabled.
+     */
+    setBackground(r: number, g: number, b: number, a: number): void;
+
+    /**
+     * Clear the custom background — revert to default sky / HDRI.
+     */
+    clearBackground(): void;
+
+    /**
+     * Configure a one-block world grid. Models are centred on integer
+     * schematic coordinates, so grid lines are placed on half-integer
+     * block boundaries automatically.
+     */
+    setGrid(halfExtent: number, spacing: number, planeY: number, showAxes: boolean, red: number, green: number, blue: number, alpha: number): void;
+
+    /**
+     * Configure a compact grid fitted to half-integer block boundaries.
+     */
+    setFittedGrid(margin: number, spacing: number, planeY: number, showAxes: boolean, red: number, green: number, blue: number, alpha: number): void;
+
+    clearGrid(): void;
+
+    /**
+     * Enable (`true`) or disable orthographic projection.
+     */
+    setOrthographic(orthographic: boolean): void;
+
+    /**
+     * Configure a true isometric view: orthographic at yaw 45° /
+     * pitch ≈35.264° (preserves the current width/height).
+     */
+    setIsometric(): void;
+}

package/renderer/RenderConfig.d.ts

@@ -0,0 +1,101 @@
+// generated by diplomat-tool
+import type { NucleationError } from "./NucleationError.mjs"
+import type { pointer, codepoint } from "./diplomat-runtime.d.ts";
+
+
+
+/**
+ * Camera / output configuration for rendering.
+ */
+export class RenderConfig {
+    /** @internal */
+    get ffiValue(): pointer;
+    /** @internal */
+    constructor();
+
+
+    /**
+     * Create a config with the given output size in pixels. Camera starts
+     * at the defaults: yaw 45°, pitch 30°, zoom 1.0, fov 45°, perspective
+     * projection, default sky background.
+     */
+    static create(width: number, height: number): RenderConfig;
+
+    /**
+     * Set the camera yaw (horizontal orbit angle) in degrees. Default: 45.
+     */
+    setYaw(yaw: number): void;
+
+    /**
+     * Set the camera pitch (downward tilt) in degrees. Default: 30.
+     */
+    setPitch(pitch: number): void;
+
+    /**
+     * Set the zoom factor applied to the auto-fitted framing
+     * (1.0 = frame the whole model; 2.0 = twice as close; 0.5 = twice
+     * as far). Default: 1.0.
+     */
+    setZoom(zoom: number): void;
+
+    /**
+     * Fit the camera to the model's bounding sphere instead of its
+     * yaw-dependent silhouette. The sphere is rotation invariant, so
+     * orbiting cameras (turntables) keep a constant distance instead
+     * of pulsing as the silhouette changes. Frames slightly looser
+     * than the default fit. Default: false.
+     */
+    setSphereFit(sphereFit: boolean): void;
+
+    /**
+     * Set the vertical field of view in degrees (perspective projection
+     * only). Default: 45.
+     */
+    setFov(fov: number): void;
+
+    /**
+     * Set the world-space directional light and its non-negative intensity.
+     */
+    setDirectionalLight(x: number, y: number, z: number, intensity: number): void;
+
+    /**
+     * Set the unlit floor for non-HDRI rendering, in `0..=1`.
+     */
+    setAmbientLight(ambient: number): void;
+
+    /**
+     * Set a solid RGBA clear color (linear 0.0–1.0). Alpha < 1.0 yields a
+     * transparent PNG. Ignored when HDRI is enabled.
+     */
+    setBackground(r: number, g: number, b: number, a: number): void;
+
+    /**
+     * Clear the custom background — revert to default sky / HDRI.
+     */
+    clearBackground(): void;
+
+    /**
+     * Configure a one-block world grid. Models are centred on integer
+     * schematic coordinates, so grid lines are placed on half-integer
+     * block boundaries automatically.
+     */
+    setGrid(halfExtent: number, spacing: number, planeY: number, showAxes: boolean, red: number, green: number, blue: number, alpha: number): void;
+
+    /**
+     * Configure a compact grid fitted to half-integer block boundaries.
+     */
+    setFittedGrid(margin: number, spacing: number, planeY: number, showAxes: boolean, red: number, green: number, blue: number, alpha: number): void;
+
+    clearGrid(): void;
+
+    /**
+     * Enable (`true`) or disable orthographic projection.
+     */
+    setOrthographic(orthographic: boolean): void;
+
+    /**
+     * Configure a true isometric view: orthographic at yaw 45° /
+     * pitch ≈35.264° (preserves the current width/height).
+     */
+    setIsometric(): void;
+}