@francisdb/vpin-wasm 0.29.0 → 0.30.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@francisdb/vpin-wasm",
-  "version": "0.29.0",
+  "version": "0.30.0",
   "description": "WASM bindings for vpin, a rust library for the visual/virtual pinball ecosystem.",
   "homepage": "https://github.com/francisdb/vpin",
   "bugs": {

package/vpin.d.ts

@@ -27,6 +27,47 @@ export interface GlbExportOptions {
 
 
 
+/**
+ * Options for `export_obj`. Pass a plain object literal; every field
+ * is optional.
+ */
+export interface ObjExportOptions {
+    /**
+     * Axis convention of the written OBJ. Default:
+     * `AxisConvention.ZDownRightHanded`, vpinball's own OBJ export
+     * layout. Use `AxisConvention.YUpRightHanded` for Blender and most
+     * other tools with default import settings.
+     */
+    axes?: AxisConvention;
+    /**
+     * Unit of the written positions. Default: `ExportUnits.M`.
+     */
+    units?: ExportUnits;
+    /**
+     * Emit one `newmtl` block per distinct (material, texture) pair
+     * instead of one per `usemtl`. Default: `true`.
+     */
+    dedupMtlBlocks?: boolean;
+    /**
+     * Write the referenced textures to `images/` and reference them
+     * from the MTL. Default: `true`.
+     */
+    extractTextures?: boolean;
+    /**
+     * Include the plunger mesh. Default: `true`.
+     */
+    includePlunger?: boolean;
+}
+
+/**
+ * Result of `export_obj`: path relative to the export directory to file
+ * contents, e.g. `{ "table.obj": Uint8Array, "table.mtl": Uint8Array,
+ * "images/playfield.png": Uint8Array }`.
+ */
+export type ObjExportFileMap = Record<string, Uint8Array>;
+
+
+
 /**
  * Options for `mesh_to_glb`. Pass a plain object literal; every field
  * is optional.
@@ -108,6 +149,34 @@ export enum AxisConvention {
     YUpRightHanded = 2,
 }
 
+/**
+ * Output unit for table exports (OBJ, glTF/GLB).
+ *
+ * VPinball internally uses "VP Units" (VPU): 50 VPU = 1.0625 inches
+ * (one pinball diameter), so a standard table around 20 inches wide
+ * is roughly 950 VPU. Loaded straight into a tool that treats
+ * numbers as metres, that becomes a ~950 m table. Pick a metric
+ * variant to scale positions on the way out.
+ */
+export enum ExportUnits {
+    /**
+     * Raw VPinball Units (no scaling).
+     */
+    Vpu = 0,
+    /**
+     * Millimetres.
+     */
+    Mm = 1,
+    /**
+     * Centimetres.
+     */
+    Cm = 2,
+    /**
+     * Metres.
+     */
+    M = 3,
+}
+
 /**
  * Mesh data for a single primitive: positions, texture coordinates,
  * normals and triangle indices, packed as flat typed arrays for direct
@@ -175,6 +244,16 @@ export function assemble(files: VpxFileMap, callback?: Function | null): Uint8Ar
  */
 export function export_glb(files: VpxFileMap, options?: GlbExportOptions | null, callback?: Function | null): Uint8Array;
 
+/**
+ * Export a whole table as a Wavefront OBJ with its MTL and, by
+ * default, the referenced textures. Takes the file map produced by
+ * `extract` and returns a file map relative to the export directory:
+ * `table.obj`, `table.mtl` and `images/*`.
+ *
+ * Sound entries are ignored like in `export_glb`.
+ */
+export function export_obj(files: VpxFileMap, options?: ObjExportOptions | null, callback?: Function | null): ObjExportFileMap;
+
 export function extract(data: Uint8Array, callback?: Function | null): VpxFileMap;
 
 /**
@@ -293,6 +372,7 @@ export interface InitOutput {
     readonly __wbg_primitivemesh_free: (a: number, b: number) => void;
     readonly assemble: (a: any, b: number) => [number, number, number, number];
     readonly export_glb: (a: any, b: number, c: number) => [number, number, number, number];
+    readonly export_obj: (a: any, b: number, c: number) => [number, number, number];
     readonly extract: (a: number, b: number, c: number) => [number, number, number];
     readonly generate_builtin_primitive: (a: number, b: number) => [number, number, number];
     readonly mesh_to_glb: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => [number, number, number, number];

package/vpin.js

@@ -46,6 +46,35 @@ export const AxisConvention = Object.freeze({
     YUpRightHanded: 2, "2": "YUpRightHanded",
 });
 
+/**
+ * Output unit for table exports (OBJ, glTF/GLB).
+ *
+ * VPinball internally uses "VP Units" (VPU): 50 VPU = 1.0625 inches
+ * (one pinball diameter), so a standard table around 20 inches wide
+ * is roughly 950 VPU. Loaded straight into a tool that treats
+ * numbers as metres, that becomes a ~950 m table. Pick a metric
+ * variant to scale positions on the way out.
+ * @enum {0 | 1 | 2 | 3}
+ */
+export const ExportUnits = Object.freeze({
+    /**
+     * Raw VPinball Units (no scaling).
+     */
+    Vpu: 0, "0": "Vpu",
+    /**
+     * Millimetres.
+     */
+    Mm: 1, "1": "Mm",
+    /**
+     * Centimetres.
+     */
+    Cm: 2, "2": "Cm",
+    /**
+     * Metres.
+     */
+    M: 3, "3": "M",
+});
+
 /**
  * Mesh data for a single primitive: positions, texture coordinates,
  * normals and triangle indices, packed as flat typed arrays for direct
@@ -194,6 +223,26 @@ export function export_glb(files, options, callback) {
     return v1;
 }
 
+/**
+ * Export a whole table as a Wavefront OBJ with its MTL and, by
+ * default, the referenced textures. Takes the file map produced by
+ * `extract` and returns a file map relative to the export directory:
+ * `table.obj`, `table.mtl` and `images/*`.
+ *
+ * Sound entries are ignored like in `export_glb`.
+ * @param {VpxFileMap} files
+ * @param {ObjExportOptions | null} [options]
+ * @param {Function | null} [callback]
+ * @returns {ObjExportFileMap}
+ */
+export function export_obj(files, options, callback) {
+    const ret = wasm.export_obj(files, isLikeNone(options) ? 0 : addToExternrefTable0(options), isLikeNone(callback) ? 0 : addToExternrefTable0(callback));
+    if (ret[2]) {
+        throw takeFromExternrefTable0(ret[1]);
+    }
+    return takeFromExternrefTable0(ret[0]);
+}
+
 /**
  * @param {Uint8Array} data
  * @param {Function | null} [callback]

package/vpin_bg.wasm.d.ts

@@ -4,6 +4,7 @@ export const memory: WebAssembly.Memory;
 export const __wbg_primitivemesh_free: (a: number, b: number) => void;
 export const assemble: (a: any, b: number) => [number, number, number, number];
 export const export_glb: (a: any, b: number, c: number) => [number, number, number, number];
+export const export_obj: (a: any, b: number, c: number) => [number, number, number];
 export const extract: (a: number, b: number, c: number) => [number, number, number];
 export const generate_builtin_primitive: (a: number, b: number) => [number, number, number];
 export const mesh_to_glb: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number) => [number, number, number, number];