@faicad/sheetmetal 0.13.0

package/dist/miterFns.js

@@ -0,0 +1,128 @@
+import { ok, err, validationError, box, cut, rotate, translate, getBounds, vecSub, vecAdd, vecScale, vecCross, vecDot, vecNormalize, } from '@faicad/faijs/brepjs-compat';
+import { normalizeSolid } from './internal.js';
+/**
+ * General miter primitive: cut a sheet-metal part by a plane, removing the
+ * material on the `+normal` side. The tool is a half-space block sized to the
+ * part's bounding box, so the cut is exact regardless of part extent.
+ *
+ * @param part - the sheet metal part to cut.
+ * @param plane - the miter plane definition.
+ * @returns the updated part with the miter cut applied, or an error.
+ */
+export function miterCut(part, plane) {
+    const solid = part.solid;
+    if (solid === undefined) {
+        return err(validationError('NO_SOLID', 'miterCut: part has no folded solid to cut'));
+    }
+    const tool = halfSpaceTool(solid, plane);
+    if (!tool.ok)
+        return tool;
+    const result = cut(solid, tool.value);
+    if (!result.ok)
+        return result;
+    return ok({ ...part, solid: normalizeSolid(result.value) });
+}
+/**
+ * Auto corner-miter between two adjacent flanges. The miter plane bisects the two
+ * flanges' fold-up directions at their shared corner and is offset by half the gap,
+ * so the cut falls on the flat/flange regions and never crosses a bend patch. The
+ * single bisector cut trims both flanges to a clean mitered corner.
+ *
+ * @param part - the sheet metal part to miter.
+ * @param flangeIdA - the first flange ID.
+ * @param flangeIdB - the second flange ID.
+ * @param gap - the gap between flanges (default 0).
+ * @returns the updated part with the miter corner applied, or an error.
+ */
+export function autoMiterCorner(part, flangeIdA, flangeIdB, gap = 0) {
+    if (part.solid === undefined) {
+        return err(validationError('NO_SOLID', 'autoMiterCorner: part has no folded solid'));
+    }
+    if (!Number.isFinite(gap) || gap < 0) {
+        return err(validationError('INVALID_GAP', `miter gap must be a finite, non-negative number, got ${gap}`));
+    }
+    const bendA = part.bends.find((b) => b.id === flangeIdA);
+    const bendB = part.bends.find((b) => b.id === flangeIdB);
+    if (bendA === undefined || bendB === undefined) {
+        return err(validationError('UNKNOWN_FLANGE', `autoMiterCorner: flange '${flangeIdA}' or '${flangeIdB}' not found`));
+    }
+    const axisA = vecNormalize(bendA.axisDir);
+    const axisB = vecNormalize(bendB.axisDir);
+    const corner = cornerPoint(bendA.axisOrigin, axisA, bendB.axisOrigin, axisB);
+    // Each flange runs perpendicular to its own bend axis. The miter plane contains
+    // the corner and is spanned by the two bend axes; its normal is their bisector in
+    // the run plane, which is exactly the bisector of the two flange run directions.
+    const planeNormal = miterNormal(axisA, axisB);
+    if (planeNormal === undefined) {
+        return err(validationError('PARALLEL_FLANGES', 'autoMiterCorner: flange bend axes are parallel; no corner to miter'));
+    }
+    const origin = vecAdd(corner, vecScale(planeNormal, gap * 0.5));
+    const cutResult = miterCut(part, { origin, normal: planeNormal });
+    if (!cutResult.ok)
+        return cutResult;
+    return ok({
+        ...cutResult.value,
+        miters: [...(part.miters ?? []), { flangeA: flangeIdA, flangeB: flangeIdB, gap }],
+    });
+}
+/** Point on the line of bend A closest to the line of bend B (their shared corner). */
+function cornerPoint(originA, dirA, originB, dirB) {
+    const w0 = vecSub(originA, originB);
+    const a = vecDot(dirA, dirA);
+    const b = vecDot(dirA, dirB);
+    const c = vecDot(dirB, dirB);
+    const d = vecDot(dirA, w0);
+    const e = vecDot(dirB, w0);
+    const denom = a * c - b * b;
+    if (Math.abs(denom) < 1e-9)
+        return originA;
+    const sc = (b * e - c * d) / denom;
+    return vecAdd(originA, vecScale(dirA, sc));
+}
+/**
+ * Normal of the miter plane between two flanges whose bend axes are `dirA`/`dirB`.
+ * The plane is spanned by the two axes (it contains the corner edge of each
+ * flange); its normal is `dirA × dirB` rotated to bisect — equivalently the
+ * normalized sum of the two run directions, which both lie perpendicular to the
+ * respective axis in the part's run plane.
+ */
+function miterNormal(dirA, dirB) {
+    const cross = vecCross(dirA, dirB);
+    if (Math.hypot(cross[0], cross[1], cross[2]) < 1e-9)
+        return undefined;
+    const sum = vecAdd(dirA, dirB);
+    if (Math.hypot(sum[0], sum[1], sum[2]) < 1e-9)
+        return vecNormalize(cross);
+    return vecNormalize(sum);
+}
+const Z_AXIS = [0, 0, 1];
+function halfSpaceTool(solid, plane) {
+    const normal = vecNormalize(plane.normal);
+    if (Math.hypot(normal[0], normal[1], normal[2]) < 1e-9) {
+        return err(validationError('INVALID_PLANE', 'miter plane normal must be non-zero'));
+    }
+    const b = getBounds(solid);
+    const diag = Math.hypot(b.xMax - b.xMin, b.yMax - b.yMin, b.zMax - b.zMin);
+    const size = diag * 2 + 2;
+    // A cube whose bottom (−Z) face lies on the XY plane through the origin, extending
+    // up in +Z, then rotated so +Z maps onto the plane normal and translated onto the
+    // plane origin. After alignment its open boundary is the miter plane and its body
+    // fills the +normal half-space.
+    let tool = box(size, size, size);
+    tool = translate(tool, [-size / 2, -size / 2, 0]);
+    const aligned = alignZTo(tool, normal);
+    return ok(translate(aligned, plane.origin));
+}
+/** Rotate a shape so its local +Z axis points along `target` (about the origin). */
+function alignZTo(shape, target) {
+    const dot = vecDot(Z_AXIS, target);
+    if (dot > 1 - 1e-9)
+        return shape;
+    if (dot < -1 + 1e-9) {
+        return rotate(shape, 180, { at: [0, 0, 0], axis: [1, 0, 0] });
+    }
+    const axis = vecNormalize(vecCross(Z_AXIS, target));
+    const angleDeg = (Math.acos(Math.max(-1, Math.min(1, dot))) * 180) / Math.PI;
+    return rotate(shape, angleDeg, { at: [0, 0, 0], axis });
+}
+//# sourceMappingURL=miterFns.js.map

package/dist/miterFns.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"miterFns.js","sourceRoot":"","sources":["../src/miterFns.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,EAAE,EACF,GAAG,EACH,eAAe,EACf,GAAG,EACH,GAAG,EACH,MAAM,EACN,SAAS,EACT,SAAS,EACT,MAAM,EACN,MAAM,EACN,QAAQ,EACR,QAAQ,EACR,MAAM,EACN,YAAY,GACb,MAAM,6BAA6B,CAAC;AAErC,OAAO,EAAE,cAAc,EAAE,MAAM,eAAe,CAAC;AAQ/C;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CAAC,IAAoB,EAAE,KAAiB;IAC9D,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC;IACzB,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QACxB,OAAO,GAAG,CAAC,eAAe,CAAC,UAAU,EAAE,2CAA2C,CAAC,CAAC,CAAC;IACvF,CAAC;IACD,MAAM,IAAI,GAAG,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IACzC,IAAI,CAAC,IAAI,CAAC,EAAE;QAAE,OAAO,IAAI,CAAC;IAE1B,MAAM,MAAM,GAAG,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;IACtC,IAAI,CAAC,MAAM,CAAC,EAAE;QAAE,OAAO,MAAM,CAAC;IAE9B,OAAO,EAAE,CAAC,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,CAAC,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;AAC9D,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,eAAe,CAC7B,IAAoB,EACpB,SAAiB,EACjB,SAAiB,EACjB,GAAG,GAAG,CAAC;IAEP,IAAI,IAAI,CAAC,KAAK,KAAK,SAAS,EAAE,CAAC;QAC7B,OAAO,GAAG,CAAC,eAAe,CAAC,UAAU,EAAE,2CAA2C,CAAC,CAAC,CAAC;IACvF,CAAC;IACD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;QACrC,OAAO,GAAG,CAAC,eAAe,CAAC,aAAa,EAAE,wDAAwD,GAAG,EAAE,CAAC,CAAC,CAAC;IAC5G,CAAC;IACD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;IACzD,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,SAAS,CAAC,CAAC;IACzD,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC/C,OAAO,GAAG,CACR,eAAe,CAAC,gBAAgB,EAAE,4BAA4B,SAAS,SAAS,SAAS,aAAa,CAAC,CACxG,CAAC;IACJ,CAAC;IAED,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;IAC1C,MAAM,MAAM,GAAG,WAAW,CAAC,KAAK,CAAC,UAAU,EAAE,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC;IAE7E,gFAAgF;IAChF,kFAAkF;IAClF,iFAAiF;IACjF,MAAM,WAAW,GAAG,WAAW,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;IAC9C,IAAI,WAAW,KAAK,SAAS,EAAE,CAAC;QAC9B,OAAO,GAAG,CACR,eAAe,CAAC,kBAAkB,EAAE,oEAAoE,CAAC,CAC1G,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,WAAW,EAAE,GAAG,GAAG,GAAG,CAAC,CAAC,CAAC;IAEhE,MAAM,SAAS,GAAG,QAAQ,CAAC,IAAI,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,WAAW,EAAE,CAAC,CAAC;IAClE,IAAI,CAAC,SAAS,CAAC,EAAE;QAAE,OAAO,SAAS,CAAC;IAEpC,OAAO,EAAE,CAAC;QACR,GAAG,SAAS,CAAC,KAAK;QAClB,MAAM,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,IAAI,EAAE,CAAC,EAAE,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,SAAS,EAAE,GAAG,EAAE,CAAC;KAClF,CAAC,CAAC;AACL,CAAC;AAED,uFAAuF;AACvF,SAAS,WAAW,CAAC,OAAa,EAAE,IAAU,EAAE,OAAa,EAAE,IAAU;IACvE,MAAM,EAAE,GAAG,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;IACpC,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC7B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3B,MAAM,CAAC,GAAG,MAAM,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC3B,MAAM,KAAK,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAC5B,IAAI,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,GAAG,IAAI;QAAE,OAAO,OAAO,CAAC;IAC3C,MAAM,EAAE,GAAG,CAAC,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,GAAG,KAAK,CAAC;IACnC,OAAO,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAAC;AAC7C,CAAC;AAED;;;;;;GAMG;AACH,SAAS,WAAW,CAAC,IAAU,EAAE,IAAU;IACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IACnC,IAAI,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;QAAE,OAAO,SAAS,CAAC;IACtE,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;IAC/B,IAAI,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI;QAAE,OAAO,YAAY,CAAC,KAAK,CAAC,CAAC;IAC1E,OAAO,YAAY,CAAC,GAAG,CAAC,CAAC;AAC3B,CAAC;AAED,MAAM,MAAM,GAAS,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC;AAE/B,SAAS,aAAa,CAAC,KAAY,EAAE,KAAiB;IACpD,MAAM,MAAM,GAAG,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;IAC1C,IAAI,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;QACvD,OAAO,GAAG,CAAC,eAAe,CAAC,eAAe,EAAE,qCAAqC,CAAC,CAAC,CAAC;IACtF,CAAC;IAED,MAAM,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAC3B,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;IAC3E,MAAM,IAAI,GAAG,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IAE1B,mFAAmF;IACnF,kFAAkF;IAClF,kFAAkF;IAClF,gCAAgC;IAChC,IAAI,IAAI,GAAU,GAAG,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC;IACxC,IAAI,GAAG,SAAS,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAElD,MAAM,OAAO,GAAG,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IACvC,OAAO,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC;AAC9C,CAAC;AAED,oFAAoF;AACpF,SAAS,QAAQ,CAAC,KAAY,EAAE,MAAY;IAC1C,MAAM,GAAG,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACnC,IAAI,GAAG,GAAG,CAAC,GAAG,IAAI;QAAE,OAAO,KAAK,CAAC;IACjC,IAAI,GAAG,GAAG,CAAC,CAAC,GAAG,IAAI,EAAE,CAAC;QACpB,OAAO,MAAM,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;IAChE,CAAC;IACD,MAAM,IAAI,GAAG,YAAY,CAAC,QAAQ,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,MAAM,QAAQ,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;IAC7E,OAAO,MAAM,CAAC,KAAK,EAAE,QAAQ,EAAE,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC,CAAC;AAC1D,CAAC","sourcesContent":["import {\n  type Result,\n  type Vec3,\n  type Solid,\n  ok,\n  err,\n  validationError,\n  box,\n  cut,\n  rotate,\n  translate,\n  getBounds,\n  vecSub,\n  vecAdd,\n  vecScale,\n  vecCross,\n  vecDot,\n  vecNormalize,\n} from '@faicad/faijs/brepjs-compat';\nimport type { SheetMetalPart } from './types.js';\nimport { normalizeSolid } from './internal.js';\n\n/** An oriented cutting plane: material on the `+normal` side is removed. */\nexport interface MiterPlane {\n  origin: Vec3;\n  normal: Vec3;\n}\n\n/**\n * General miter primitive: cut a sheet-metal part by a plane, removing the\n * material on the `+normal` side. The tool is a half-space block sized to the\n * part's bounding box, so the cut is exact regardless of part extent.\n *\n * @param part - the sheet metal part to cut.\n * @param plane - the miter plane definition.\n * @returns the updated part with the miter cut applied, or an error.\n */\nexport function miterCut(part: SheetMetalPart, plane: MiterPlane): Result<SheetMetalPart> {\n  const solid = part.solid;\n  if (solid === undefined) {\n    return err(validationError('NO_SOLID', 'miterCut: part has no folded solid to cut'));\n  }\n  const tool = halfSpaceTool(solid, plane);\n  if (!tool.ok) return tool;\n\n  const result = cut(solid, tool.value);\n  if (!result.ok) return result;\n\n  return ok({ ...part, solid: normalizeSolid(result.value) });\n}\n\n/**\n * Auto corner-miter between two adjacent flanges. The miter plane bisects the two\n * flanges' fold-up directions at their shared corner and is offset by half the gap,\n * so the cut falls on the flat/flange regions and never crosses a bend patch. The\n * single bisector cut trims both flanges to a clean mitered corner.\n *\n * @param part - the sheet metal part to miter.\n * @param flangeIdA - the first flange ID.\n * @param flangeIdB - the second flange ID.\n * @param gap - the gap between flanges (default 0).\n * @returns the updated part with the miter corner applied, or an error.\n */\nexport function autoMiterCorner(\n  part: SheetMetalPart,\n  flangeIdA: string,\n  flangeIdB: string,\n  gap = 0\n): Result<SheetMetalPart> {\n  if (part.solid === undefined) {\n    return err(validationError('NO_SOLID', 'autoMiterCorner: part has no folded solid'));\n  }\n  if (!Number.isFinite(gap) || gap < 0) {\n    return err(validationError('INVALID_GAP', `miter gap must be a finite, non-negative number, got ${gap}`));\n  }\n  const bendA = part.bends.find((b) => b.id === flangeIdA);\n  const bendB = part.bends.find((b) => b.id === flangeIdB);\n  if (bendA === undefined || bendB === undefined) {\n    return err(\n      validationError('UNKNOWN_FLANGE', `autoMiterCorner: flange '${flangeIdA}' or '${flangeIdB}' not found`)\n    );\n  }\n\n  const axisA = vecNormalize(bendA.axisDir);\n  const axisB = vecNormalize(bendB.axisDir);\n  const corner = cornerPoint(bendA.axisOrigin, axisA, bendB.axisOrigin, axisB);\n\n  // Each flange runs perpendicular to its own bend axis. The miter plane contains\n  // the corner and is spanned by the two bend axes; its normal is their bisector in\n  // the run plane, which is exactly the bisector of the two flange run directions.\n  const planeNormal = miterNormal(axisA, axisB);\n  if (planeNormal === undefined) {\n    return err(\n      validationError('PARALLEL_FLANGES', 'autoMiterCorner: flange bend axes are parallel; no corner to miter')\n    );\n  }\n  const origin = vecAdd(corner, vecScale(planeNormal, gap * 0.5));\n\n  const cutResult = miterCut(part, { origin, normal: planeNormal });\n  if (!cutResult.ok) return cutResult;\n\n  return ok({\n    ...cutResult.value,\n    miters: [...(part.miters ?? []), { flangeA: flangeIdA, flangeB: flangeIdB, gap }],\n  });\n}\n\n/** Point on the line of bend A closest to the line of bend B (their shared corner). */\nfunction cornerPoint(originA: Vec3, dirA: Vec3, originB: Vec3, dirB: Vec3): Vec3 {\n  const w0 = vecSub(originA, originB);\n  const a = vecDot(dirA, dirA);\n  const b = vecDot(dirA, dirB);\n  const c = vecDot(dirB, dirB);\n  const d = vecDot(dirA, w0);\n  const e = vecDot(dirB, w0);\n  const denom = a * c - b * b;\n  if (Math.abs(denom) < 1e-9) return originA;\n  const sc = (b * e - c * d) / denom;\n  return vecAdd(originA, vecScale(dirA, sc));\n}\n\n/**\n * Normal of the miter plane between two flanges whose bend axes are `dirA`/`dirB`.\n * The plane is spanned by the two axes (it contains the corner edge of each\n * flange); its normal is `dirA × dirB` rotated to bisect — equivalently the\n * normalized sum of the two run directions, which both lie perpendicular to the\n * respective axis in the part's run plane.\n */\nfunction miterNormal(dirA: Vec3, dirB: Vec3): Vec3 | undefined {\n  const cross = vecCross(dirA, dirB);\n  if (Math.hypot(cross[0], cross[1], cross[2]) < 1e-9) return undefined;\n  const sum = vecAdd(dirA, dirB);\n  if (Math.hypot(sum[0], sum[1], sum[2]) < 1e-9) return vecNormalize(cross);\n  return vecNormalize(sum);\n}\n\nconst Z_AXIS: Vec3 = [0, 0, 1];\n\nfunction halfSpaceTool(solid: Solid, plane: MiterPlane): Result<Solid> {\n  const normal = vecNormalize(plane.normal);\n  if (Math.hypot(normal[0], normal[1], normal[2]) < 1e-9) {\n    return err(validationError('INVALID_PLANE', 'miter plane normal must be non-zero'));\n  }\n\n  const b = getBounds(solid);\n  const diag = Math.hypot(b.xMax - b.xMin, b.yMax - b.yMin, b.zMax - b.zMin);\n  const size = diag * 2 + 2;\n\n  // A cube whose bottom (−Z) face lies on the XY plane through the origin, extending\n  // up in +Z, then rotated so +Z maps onto the plane normal and translated onto the\n  // plane origin. After alignment its open boundary is the miter plane and its body\n  // fills the +normal half-space.\n  let tool: Solid = box(size, size, size);\n  tool = translate(tool, [-size / 2, -size / 2, 0]);\n\n  const aligned = alignZTo(tool, normal);\n  return ok(translate(aligned, plane.origin));\n}\n\n/** Rotate a shape so its local +Z axis points along `target` (about the origin). */\nfunction alignZTo(shape: Solid, target: Vec3): Solid {\n  const dot = vecDot(Z_AXIS, target);\n  if (dot > 1 - 1e-9) return shape;\n  if (dot < -1 + 1e-9) {\n    return rotate(shape, 180, { at: [0, 0, 0], axis: [1, 0, 0] });\n  }\n  const axis = vecNormalize(vecCross(Z_AXIS, target));\n  const angleDeg = (Math.acos(Math.max(-1, Math.min(1, dot))) * 180) / Math.PI;\n  return rotate(shape, angleDeg, { at: [0, 0, 0], axis });\n}\n"]}

package/dist/nestFns.d.ts

@@ -0,0 +1,116 @@
+import { type Result } from '@faicad/faijs/brepjs-compat';
+import type { FlatPattern, SheetMetalWarning } from './types.js';
+import { type DxfOptions } from './dxfFns.js';
+/** Stock sheet the parts are packed onto (the gross blank, before margin). */
+export interface SheetSpec {
+    width: number;
+    height: number;
+}
+/** Nesting options: the stock sheet plus optional margin, spacing, rotation and strategy. */
+export interface NestOptions {
+    sheet: SheetSpec;
+    /** Clear border kept empty around the sheet edge (per side). Default `0`. */
+    margin?: number | undefined;
+    /** Minimum clear gap between any two placed parts (and the bbox padding used
+     * for the non-overlap test). Default `0`. */
+    spacing?: number | undefined;
+    /** Try a 90° rotation per part and keep whichever orientation fits/packs better. */
+    allowRotation?: boolean | undefined;
+    /**
+     * Packing strategy. Default `"bbox"`: each part is packed as its axis-aligned
+     * bounding box (the original {@link nest} behavior — fast, parts never interlock).
+     * `"nfp"` is true-shape / no-fit-polygon nesting: the actual outline polygons are
+     * packed so concave (L-shaped) parts interlock for higher material utilization.
+     * The NFP packer is a HEURISTIC (bottom-left-fill, largest-first) — not provably
+     * optimal — but it never overlaps parts and never drops a part silently.
+     */
+    strategy?: 'bbox' | 'nfp' | undefined;
+}
+/**
+ * Where a single pattern lands on a sheet. For the bbox strategy `rotationDeg` is
+ * `0` or `90`; the true-shape (nfp) strategy may also emit `180` or `270`. `(x, y)`
+ * is the lower-left of the part's transformed bounding box in sheet coordinates.
+ */
+export interface Placement {
+    /** Index into the `patterns` array passed to {@link nest}. */
+    patternIndex: number;
+    /** Lower-left x of the part's (rotated) bounding box, in sheet coordinates. */
+    x: number;
+    /** Lower-left y of the part's (rotated) bounding box, in sheet coordinates. */
+    y: number;
+    rotationDeg: number;
+}
+/** One populated sheet produced by {@link nest}: where each pattern landed and how full it is. */
+export interface NestSheet {
+    placements: Placement[];
+    /**
+     * Σ placed part areas ÷ usable-sheet area, in `(0, 1]`. "Usable" =
+     * `(width − 2·margin) × (height − 2·margin)`. For the `"bbox"` strategy the part
+     * area is its BOUNDING-BOX area (intra-bbox waste of a non-rectangular part is not
+     * credited — a conservative measure). For the `"nfp"` true-shape strategy it is the
+     * actual OUTLINE-POLYGON area, so an L-shaped part credits only its true material,
+     * making the two strategies' utilizations directly comparable on the same parts.
+     */
+    utilization: number;
+}
+/** Outcome of {@link nest}: the placed sheets, any unplaced patterns, and warnings. */
+export interface NestResult {
+    sheets: NestSheet[];
+    /** Indices of patterns too large for the usable sheet even rotated. */
+    unplaced: number[];
+    warnings: SheetMetalWarning[];
+}
+/** Axis-aligned bounding box of one pattern outline, in developed-plane coords. */
+export interface Bbox {
+    minX: number;
+    minY: number;
+    width: number;
+    height: number;
+}
+/**
+ * Bounding-box nest: arrange developed flat patterns onto stock sheets to reduce
+ * waste. This is BOUNDING-BOX nesting — each part is packed as its axis-aligned
+ * outline bounding box, so parts never interlock and concave parts leave their
+ * bounding-box waste unused. True-shape (no-fit-polygon) nesting is a follow-up.
+ *
+ * Algorithm: a shelf (level) packing heuristic. Parts are sorted largest-first by
+ * bbox height then area, then placed left-to-right into horizontal shelves; a new
+ * shelf opens below when the current row is full, and a NEW sheet opens when the
+ * next shelf would overflow the usable height. With `allowRotation`, each part is
+ * tried both at 0° and 90° and the orientation that fits the current shelf (or,
+ * failing that, fits at all) is kept. A part larger than the usable sheet even
+ * rotated is reported in `unplaced` with a warning — never dropped silently, never
+ * retried in an infinite loop.
+ *
+ * @param patterns - developed flat patterns to place onto the sheets.
+ * @param options - sheet dimensions plus margin, spacing, rotation and strategy.
+ * @returns `Result<NestResult>` - the populated sheets plus any unplaced patterns and
+ *   warnings, or an error for invalid sheet/options or an unmeasurable outline.
+ */
+export declare function nest(patterns: FlatPattern[], options: NestOptions): Result<NestResult>;
+/**
+ * Axis-aligned bounding box of a pattern's OUTER outline wire, read from the wire
+ * vertices (each edge start point) — the same 2D-coordinate read the DXF/SVG writers
+ * use. Only the outer outline is packed; holes ride inside it.
+ *
+ * @param pattern - the flat pattern whose outer outline is measured.
+ * @returns `Result<Bbox>` - the axis-aligned bounding box of the outer outline, or an
+ *   error if the outline is empty or degenerate.
+ */
+export declare function patternBbox(pattern: FlatPattern): Result<Bbox>;
+/**
+ * Emit one fabrication-ready DXF for a single nested sheet: every pattern placed on
+ * `result.sheets[sheetIndex]` is translated and rotated onto the sheet (via the same
+ * bounding boxes the packer used) and written through {@link multiPatternToDXF}.
+ * `patterns` must be the SAME array passed to {@link nest} (placements index into it).
+ *
+ * @param result - the {@link NestResult} returned by {@link nest}.
+ * @param patterns - the same `FlatPattern[]` array that was passed to {@link nest}.
+ * @param sheetIndex - index into `result.sheets` of the sheet to emit.
+ * @param options - optional DXF options forwarded to {@link multiPatternToDXF}.
+ * @returns `Result<string>` - the DXF text for the selected sheet, or an error if the
+ *   sheet index is invalid, a placement references a missing pattern, or a pattern
+ *   outline cannot be measured.
+ */
+export declare function nestToDXF(result: NestResult, patterns: FlatPattern[], sheetIndex: number, options?: DxfOptions): Result<string>;
+//# sourceMappingURL=nestFns.d.ts.map

package/dist/nestFns.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"nestFns.d.ts","sourceRoot":"","sources":["../src/nestFns.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAuD,MAAM,6BAA6B,CAAC;AAC/G,OAAO,KAAK,EAAE,WAAW,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AACjE,OAAO,EAAqB,KAAK,UAAU,EAAuC,MAAM,aAAa,CAAC;AAUtG,8EAA8E;AAC9E,MAAM,WAAW,SAAS;IACxB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,6FAA6F;AAC7F,MAAM,WAAW,WAAW;IAC1B,KAAK,EAAE,SAAS,CAAC;IACjB,6EAA6E;IAC7E,MAAM,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC5B;iDAC6C;IAC7C,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC7B,oFAAoF;IACpF,aAAa,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACpC;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,KAAK,GAAG,SAAS,CAAC;CACvC;AAED;;;;GAIG;AACH,MAAM,WAAW,SAAS;IACxB,8DAA8D;IAC9D,YAAY,EAAE,MAAM,CAAC;IACrB,+EAA+E;IAC/E,CAAC,EAAE,MAAM,CAAC;IACV,+EAA+E;IAC/E,CAAC,EAAE,MAAM,CAAC;IACV,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,kGAAkG;AAClG,MAAM,WAAW,SAAS;IACxB,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB;;;;;;;OAOG;IACH,WAAW,EAAE,MAAM,CAAC;CACrB;AAED,uFAAuF;AACvF,MAAM,WAAW,UAAU;IACzB,MAAM,EAAE,SAAS,EAAE,CAAC;IACpB,uEAAuE;IACvE,QAAQ,EAAE,MAAM,EAAE,CAAC;IACnB,QAAQ,EAAE,iBAAiB,EAAE,CAAC;CAC/B;AAED,mFAAmF;AACnF,MAAM,WAAW,IAAI;IACnB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;CAChB;AAID;;;;;;;;;;;;;;;;;;;GAmBG;AACH,wBAAgB,IAAI,CAAC,QAAQ,EAAE,WAAW,EAAE,EAAE,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,UAAU,CAAC,CA4EtF;AAsYD;;;;;;;;GAQG;AACH,wBAAgB,WAAW,CAAC,OAAO,EAAE,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,CAsB9D;AAoDD;;;;;;;;;;;;;GAaG;AACH,wBAAgB,SAAS,CACvB,MAAM,EAAE,UAAU,EAClB,QAAQ,EAAE,WAAW,EAAE,EACvB,UAAU,EAAE,MAAM,EAClB,OAAO,CAAC,EAAE,UAAU,GACnB,MAAM,CAAC,MAAM,CAAC,CAgBhB"}