@taulabs/openrscad-engine 0.11.0-beta.0

package/pkg/node/openrscad_bg.wasm.d.ts

@@ -0,0 +1,56 @@
+/* tslint:disable */
+/* eslint-disable */
+export const memory: WebAssembly.Memory;
+export const version: () => [number, number];
+export const __wbg_renderresult_free: (a: number, b: number) => void;
+export const renderresult_positions: (a: number) => [number, number];
+export const renderresult_normals: (a: number) => [number, number];
+export const renderresult_echo: (a: number) => [number, number];
+export const renderresult_warnings: (a: number) => [number, number];
+export const renderresult_error: (a: number) => [number, number];
+export const renderresult_ok: (a: number) => number;
+export const renderresult_geom_errors: (a: number) => [number, number];
+export const renderresult_diagnostics: (a: number) => [number, number];
+export const renderresult_preview_positions: (a: number) => [number, number];
+export const renderresult_preview_normals: (a: number) => [number, number];
+export const renderresult_groups: (a: number) => [number, number];
+export const renderresult_provenance_positions: (a: number) => [number, number];
+export const renderresult_provenance_normals: (a: number) => [number, number];
+export const renderresult_provenance: (a: number) => [number, number];
+export const renderresult_viewport: (a: number) => [number, number];
+export const renderresult_triangle_count: (a: number) => number;
+export const renderresult_vertex_count: (a: number) => number;
+export const renderresult_is_2d: (a: number) => number;
+export const __wbg_exportshape3dresult_free: (a: number, b: number) => void;
+export const exportshape3dresult_take_bytes: (a: number) => [number, number];
+export const exportshape3dresult_format: (a: number) => [number, number];
+export const exportshape3dresult_ok: (a: number) => number;
+export const exportshape3dresult_error: (a: number) => [number, number];
+export const exportshape3dresult_echo: (a: number) => [number, number];
+export const exportshape3dresult_warnings: (a: number) => [number, number];
+export const exportshape3dresult_geom_errors: (a: number) => [number, number];
+export const exportshape3dresult_diagnostics: (a: number) => [number, number];
+export const exportshape3dresult_viewport: (a: number) => [number, number];
+export const exportshape3dresult_triangle_count: (a: number) => number;
+export const exportshape3dresult_vertex_count: (a: number) => number;
+export const exportshape3dresult_volume: (a: number) => number;
+export const exportshape3dresult_area: (a: number) => number;
+export const exportshape3dresult_is_2d: (a: number) => number;
+export const export_3d: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number, u: number, v: number) => number;
+export const render_to_glb: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number) => number;
+export const export_2d: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number) => [number, number];
+export const parameters: (a: number, b: number) => [number, number];
+export const render: (a: number, b: number) => number;
+export const render_with_params: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+export const render_with_files: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number) => number;
+export const render_preview_with_files: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number) => number;
+export const start: () => void;
+export const clear_cache: () => void;
+export const renderresult_volume: (a: number) => number;
+export const renderresult_area: (a: number) => number;
+export const __wbindgen_malloc: (a: number, b: number) => number;
+export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+export const __wbindgen_free: (a: number, b: number, c: number) => void;
+export const __wbindgen_externrefs: WebAssembly.Table;
+export const __externref_table_alloc: () => number;
+export const __wbindgen_start: () => void;

package/pkg/node/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "openrscad-wasm",
+  "version": "0.11.0-beta.0",
+  "license": "Apache-2.0 OR MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/matthova/openrscad"
+  },
+  "files": [
+    "openrscad_bg.wasm",
+    "openrscad.js",
+    "openrscad.d.ts"
+  ],
+  "main": "openrscad.js",
+  "types": "openrscad.d.ts"
+}

package/pkg/web/openrscad.d.ts

@@ -0,0 +1,255 @@
+/* tslint:disable */
+/* eslint-disable */
+
+/**
+ * One owned native 3D artifact plus the operational metadata needed by hosts.
+ */
+export class ExportShape3DResult {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    /**
+     * Transfer artifact ownership to JavaScript. A second call returns empty.
+     */
+    take_bytes(): Uint8Array;
+    readonly area: number;
+    readonly diagnostics: string;
+    readonly echo: string;
+    readonly error: string;
+    readonly format: string;
+    readonly geom_errors: string;
+    readonly is_2d: boolean;
+    readonly ok: boolean;
+    readonly triangle_count: number;
+    readonly vertex_count: number;
+    readonly viewport: string;
+    readonly volume: number;
+    readonly warnings: string;
+}
+
+/**
+ * The result of rendering a `.scad` source string.
+ *
+ * Mesh data is a non-indexed triangle soup with flat (per-face) normals:
+ * `positions` and `normals` both hold 9 floats per triangle.
+ */
+export class RenderResult {
+    private constructor();
+    free(): void;
+    [Symbol.dispose](): void;
+    readonly area: number;
+    /**
+     * Structured diagnostics as a JSON array (`[{severity,message,start,end}]`),
+     * where start/end are byte offsets into the source, or -1 when unknown.
+     */
+    readonly diagnostics: string;
+    /**
+     * Newline-joined `ECHO:` output.
+     */
+    readonly echo: string;
+    /**
+     * Error message, or empty string if the render succeeded.
+     */
+    readonly error: string;
+    /**
+     * Newline-joined recoverable geometry errors (degraded render), or empty
+     * when the geometry is exact. See the field docs on `geom_errors`.
+     */
+    readonly geom_errors: string;
+    /**
+     * Per-group ranges/colors as JSON (`[{start,count,color,mode}]`); empty `[]`
+     * when the model uses no display attributes.
+     */
+    readonly groups: string;
+    /**
+     * Whether the model is a 2D object (exportable to DXF/SVG) vs a 3D solid.
+     */
+    readonly is_2d: boolean;
+    /**
+     * Per-face normals (9 f32 per triangle) as a `Float32Array`.
+     */
+    readonly normals: Float32Array;
+    /**
+     * Whether the render succeeded (no error).
+     */
+    readonly ok: boolean;
+    /**
+     * Triangle-soup vertex positions (9 f32 per triangle) as a `Float32Array`.
+     */
+    readonly positions: Float32Array;
+    readonly preview_normals: Float32Array;
+    /**
+     * Preview triangle soup (concatenated colored groups); empty when the model
+     * uses no color/`#`/`%` (the viewer then uses `positions`).
+     */
+    readonly preview_positions: Float32Array;
+    /**
+     * Per-group provenance ranges/span-stacks as JSON (`[{start,count,spans}]`);
+     * empty when the model has no pickable geometry.
+     */
+    readonly provenance: string;
+    readonly provenance_normals: Float32Array;
+    /**
+     * Provenance triangle soup (concatenated per-statement groups); empty only
+     * for models with no geometry.
+     */
+    readonly provenance_positions: Float32Array;
+    readonly triangle_count: number;
+    readonly vertex_count: number;
+    /**
+     * `$vp*` viewport variables as JSON, or empty when the source has no `$vp`.
+     */
+    readonly viewport: string;
+    readonly volume: number;
+    /**
+     * Newline-joined warnings.
+     */
+    readonly warnings: string;
+}
+
+/**
+ * Drop the persistent geometry cache (e.g. when loading a new document).
+ */
+export function clear_cache(): void;
+
+/**
+ * Render a 2D model and serialize it to DXF or SVG text. Returns an empty
+ * string if the model isn't 2D or fails to evaluate (the caller checks
+ * `RenderResult.is_2d` first). `format` is "dxf" or "svg".
+ */
+export function export_2d(source: string, names: string[], values: string[], file_names: string[], file_contents: string[], bin_names: string[], bin_data: string[], font_blobs: string[], format: string): string;
+
+/**
+ * Evaluate a 3D source and serialize it natively to one owned artifact.
+ */
+export function export_3d(source: string, names: string[], values: string[], file_names: string[], file_contents: string[], bin_names: string[], bin_data: string[], font_blobs: string[], format: string, include_edges: boolean, source_unit_to_meters: number, coordinate_system: string): ExportShape3DResult;
+
+/**
+ * The customizer parameter schema for a source string, as a JSON string
+ * (`{"params":[…]}`). The playground renders a control panel from this.
+ */
+export function parameters(source: string): string;
+
+/**
+ * Run the full pipeline on a source string.
+ */
+export function render(source: string): RenderResult;
+
+/**
+ * Like [`render_with_files`], but renders the fast, **non-watertight** preview
+ * (see `openrscad_geom::render_preview_cached_diag`): unions are concatenated rather
+ * than run through the CSG kernel. Suitable for opaque on-screen display only —
+ * stats and export still use the exact path. Differences/intersections/hulls
+ * still resolve exactly, so holes and clips look correct.
+ */
+export function render_preview_with_files(source: string, names: string[], values: string[], file_names: string[], file_contents: string[], bin_names: string[], bin_data: string[], font_blobs: string[]): RenderResult;
+
+/**
+ * Render a preview-semantics GLB for interactive viewers.
+ */
+export function render_to_glb(source: string, names: string[], values: string[], file_names: string[], file_contents: string[], bin_names: string[], bin_data: string[], font_blobs: string[], include_edges: boolean): ExportShape3DResult;
+
+/**
+ * Like [`render_with_params`], but `include`/`use` resolve against an in-memory
+ * set of files (`file_names[i]` → `file_contents[i]`) — the playground's other
+ * files and/or a bundled library.
+ */
+export function render_with_files(source: string, names: string[], values: string[], file_names: string[], file_contents: string[], bin_names: string[], bin_data: string[], font_blobs: string[]): RenderResult;
+
+/**
+ * Like [`render`], but with customizer overrides supplied as parallel arrays:
+ * `names[i]` is a top-level parameter and `values[i]` its new value as a
+ * literal string (`"30"`, `"true"`, `"\"hi\""`, `"[1,2,3]"`).
+ */
+export function render_with_params(source: string, names: string[], values: string[]): RenderResult;
+
+/**
+ * Initialize panic hook for readable errors in the browser console.
+ */
+export function start(): void;
+
+/**
+ * Engine version string.
+ */
+export function version(): string;
+
+export type InitInput = RequestInfo | URL | Response | BufferSource | WebAssembly.Module;
+
+export interface InitOutput {
+    readonly memory: WebAssembly.Memory;
+    readonly version: () => [number, number];
+    readonly __wbg_renderresult_free: (a: number, b: number) => void;
+    readonly renderresult_positions: (a: number) => [number, number];
+    readonly renderresult_normals: (a: number) => [number, number];
+    readonly renderresult_echo: (a: number) => [number, number];
+    readonly renderresult_warnings: (a: number) => [number, number];
+    readonly renderresult_error: (a: number) => [number, number];
+    readonly renderresult_ok: (a: number) => number;
+    readonly renderresult_geom_errors: (a: number) => [number, number];
+    readonly renderresult_diagnostics: (a: number) => [number, number];
+    readonly renderresult_preview_positions: (a: number) => [number, number];
+    readonly renderresult_preview_normals: (a: number) => [number, number];
+    readonly renderresult_groups: (a: number) => [number, number];
+    readonly renderresult_provenance_positions: (a: number) => [number, number];
+    readonly renderresult_provenance_normals: (a: number) => [number, number];
+    readonly renderresult_provenance: (a: number) => [number, number];
+    readonly renderresult_viewport: (a: number) => [number, number];
+    readonly renderresult_triangle_count: (a: number) => number;
+    readonly renderresult_vertex_count: (a: number) => number;
+    readonly renderresult_is_2d: (a: number) => number;
+    readonly __wbg_exportshape3dresult_free: (a: number, b: number) => void;
+    readonly exportshape3dresult_take_bytes: (a: number) => [number, number];
+    readonly exportshape3dresult_format: (a: number) => [number, number];
+    readonly exportshape3dresult_ok: (a: number) => number;
+    readonly exportshape3dresult_error: (a: number) => [number, number];
+    readonly exportshape3dresult_echo: (a: number) => [number, number];
+    readonly exportshape3dresult_warnings: (a: number) => [number, number];
+    readonly exportshape3dresult_geom_errors: (a: number) => [number, number];
+    readonly exportshape3dresult_diagnostics: (a: number) => [number, number];
+    readonly exportshape3dresult_viewport: (a: number) => [number, number];
+    readonly exportshape3dresult_triangle_count: (a: number) => number;
+    readonly exportshape3dresult_vertex_count: (a: number) => number;
+    readonly exportshape3dresult_volume: (a: number) => number;
+    readonly exportshape3dresult_area: (a: number) => number;
+    readonly exportshape3dresult_is_2d: (a: number) => number;
+    readonly export_3d: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number, u: number, v: number) => number;
+    readonly render_to_glb: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number) => number;
+    readonly export_2d: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number) => [number, number];
+    readonly parameters: (a: number, b: number) => [number, number];
+    readonly render: (a: number, b: number) => number;
+    readonly render_with_params: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
+    readonly render_with_files: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number) => number;
+    readonly render_preview_with_files: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number) => number;
+    readonly start: () => void;
+    readonly clear_cache: () => void;
+    readonly renderresult_volume: (a: number) => number;
+    readonly renderresult_area: (a: number) => number;
+    readonly __wbindgen_malloc: (a: number, b: number) => number;
+    readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
+    readonly __wbindgen_free: (a: number, b: number, c: number) => void;
+    readonly __wbindgen_externrefs: WebAssembly.Table;
+    readonly __externref_table_alloc: () => number;
+    readonly __wbindgen_start: () => void;
+}
+
+export type SyncInitInput = BufferSource | WebAssembly.Module;
+
+/**
+ * Instantiates the given `module`, which can either be bytes or
+ * a precompiled `WebAssembly.Module`.
+ *
+ * @param {{ module: SyncInitInput }} module - Passing `SyncInitInput` directly is deprecated.
+ *
+ * @returns {InitOutput}
+ */
+export function initSync(module: { module: SyncInitInput } | SyncInitInput): InitOutput;
+
+/**
+ * If `module_or_path` is {RequestInfo} or {URL}, makes a request and
+ * for everything else, calls `WebAssembly.instantiate` directly.
+ *
+ * @param {{ module_or_path: InitInput | Promise<InitInput> }} module_or_path - Passing `InitInput` directly is deprecated.
+ *
+ * @returns {Promise<InitOutput>}
+ */
+export default function __wbg_init (module_or_path?: { module_or_path: InitInput | Promise<InitInput> } | InitInput | Promise<InitInput>): Promise<InitOutput>;