@mylasertools/kerfscript 0.3.0 → 0.4.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Changelog
 
+## 0.4.0 (2026-10-30)
+
+- Assembly: `part()` takes `at` and `rotate` to place a part in 3D, rotated
+  first and then moved, like OpenSCAD. `render()` returns the placed parts as
+  `assembly` (outline, thickness and a 4 × 4 matrix per copy) so apps can show
+  the design put together, and warns when two placed parts collide, which is
+  how a wrong finger edge shows up. Overlaps under about 1 mm³ are ignored.
+  Parts without a placement lie flat beside the assembly, marked
+  `placed: false`, so a divider added to a `box()` still shows.
+  `box()` from `kerf/box` places its own panels.
+- Copies of a part that share one placement are drawn in the same place and
+  get one warning that says so, instead of a collision warning for every pair.
+- The collision check stops after `maxCollisionPairs` pairs of touching parts
+  (20,000 by default) with a warning, so a program that places thousands of
+  parts cannot hold up the render. It also skips parts far apart on x before
+  comparing them, so large assemblies check faster.
+- `kerfscript.wasm` returns `assembly` in its render response.
+
 ## 0.3.0 (2026-10-30)
 
 - `kerfscript.wasm`: a WASI module that runs KerfScript from Python, Rust,

package/LANGUAGE.md

@@ -198,8 +198,12 @@ material(thickness = 4, kerf = 0.12, name = "birch") {
 }
 ```
 
-- `part(name, qty = 1) { ... }` makes a named part. It records `$thickness`,
-  `$kerf` and `$material` where it is called.
+- `part(name, qty = 1, at, rotate) { ... }` makes a named part. It records
+  `$thickness`, `$kerf` and `$material` where it is called. `at = [x, y, z]`
+  and `rotate = [x, y, z]` (degrees) place the part in the assembled view:
+  rotated first, then moved, with its thickness along +Z. A part with copies
+  takes one placement or a list with one per copy. `render()` returns the
+  placed parts as `assembly` and warns when two of them collide.
 - Shapes outside any part form one part named `part`.
 - `material(thickness, kerf, name) { ... }` sets those special variables for
   its children.
@@ -407,16 +411,17 @@ Exceeding a limit stops evaluation with an error.
 
 Programs are also limited in how much memory they can ask for:
 
-| Limit             | Default   | What it counts                                                                                                             |
-| ----------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
-| `maxParts`        | 10,000    | copies of all parts, adding up every `qty`                                                                                 |
-| `maxSegments`     | 10,000    | segments in one circle, ellipse or arc, and corners in one polygon                                                         |
-| `maxListLength`   | 1,000,000 | items in one list or range, or characters in one string, including the text `echo()` writes in one call                    |
-| `maxListItems`    | 3,000,000 | items in all lists the program builds, plus 4 for each list, one for every 8 characters of the strings it builds or echoes |
-| `maxTextLength`   | 2,000     | characters in one `text()`                                                                                                 |
-| `maxPoints`       | 2,000,000 | points in all shapes the modules make, plus 100 for each shape                                                             |
-| `maxOutputPoints` | 1,000,000 | points in the exported files, counting every copy                                                                          |
-| `maxSheets`       | 200       | sheets in the layout                                                                                                       |
+| Limit               | Default   | What it counts                                                                                                             |
+| ------------------- | --------- | -------------------------------------------------------------------------------------------------------------------------- |
+| `maxParts`          | 10,000    | copies of all parts, adding up every `qty`                                                                                 |
+| `maxSegments`       | 10,000    | segments in one circle, ellipse or arc, and corners in one polygon                                                         |
+| `maxListLength`     | 1,000,000 | items in one list or range, or characters in one string, including the text `echo()` writes in one call                    |
+| `maxListItems`      | 3,000,000 | items in all lists the program builds, plus 4 for each list, one for every 8 characters of the strings it builds or echoes |
+| `maxTextLength`     | 2,000     | characters in one `text()`                                                                                                 |
+| `maxPoints`         | 2,000,000 | points in all shapes the modules make, plus 100 for each shape                                                             |
+| `maxOutputPoints`   | 1,000,000 | points in the exported files, counting every copy                                                                          |
+| `maxSheets`         | 200       | sheets in the layout                                                                                                       |
+| `maxCollisionPairs` | 20,000    | pairs of touching placed parts checked for collisions; past it the check stops with a warning                              |
 
 Applications can change them with the `limits` render option.
 

package/dist/assembly.d.cts

@@ -0,0 +1,20 @@
+import type { Poly } from './geometry.cjs';
+export type Vec3 = [number, number, number];
+export interface Placement {
+    at: Vec3;
+    rotate: Vec3;
+}
+export interface AssemblyPart {
+    name: string;
+    copy: number;
+    thickness: number;
+    matrix: number[];
+    outline: Poly[];
+    placed: boolean;
+}
+export declare function placementMatrix(p: Placement): number[];
+export declare function besideAssembly(placed: AssemblyPart[], loose: AssemblyPart[], gap?: number): AssemblyPart[];
+export declare function collisions(parts: AssemblyPart[], maxPairs?: number, eps?: number, pitch?: number, volume?: number): {
+    found: [AssemblyPart, AssemblyPart][];
+    complete: boolean;
+};

package/dist/assembly.d.ts

@@ -0,0 +1,20 @@
+import type { Poly } from './geometry.js';
+export type Vec3 = [number, number, number];
+export interface Placement {
+    at: Vec3;
+    rotate: Vec3;
+}
+export interface AssemblyPart {
+    name: string;
+    copy: number;
+    thickness: number;
+    matrix: number[];
+    outline: Poly[];
+    placed: boolean;
+}
+export declare function placementMatrix(p: Placement): number[];
+export declare function besideAssembly(placed: AssemblyPart[], loose: AssemblyPart[], gap?: number): AssemblyPart[];
+export declare function collisions(parts: AssemblyPart[], maxPairs?: number, eps?: number, pitch?: number, volume?: number): {
+    found: [AssemblyPart, AssemblyPart][];
+    complete: boolean;
+};