@code3d/screws 0.0.1-alpha.0

package/bld/library/thread.js

@@ -0,0 +1,181 @@
+import { definePrimitive, replicad, } from '@code3d/core/replicad';
+const { Plane, draw, makeCylinder, makeHelix, makeSolid, weldShellsAndFaces } = replicad;
+const loopSteps = Array.from({ length: 21 }, (_, index) => index / 20);
+const threadBreps = new Map();
+const maximumCachedBrepCharacters = 8 * 1024 * 1024;
+let cachedBrepCharacters = 0;
+export const helicalThread = definePrimitive((options) => {
+    validateHelicalThread(options);
+    const { majorDiameter, minorDiameter, leftHanded = false, ...dimensions } = options;
+    return cachedHelicalThreadShape({
+        ...dimensions,
+        majorRadius: majorDiameter / 2,
+        minorRadius: minorDiameter / 2,
+        leftHanded,
+    });
+});
+function validateHelicalThread({ pitch, y, majorDiameter, minorDiameter, rootWidth, crestWidth, }) {
+    assertPositive('pitch', pitch);
+    assertPositive('y', y);
+    assertPositive('majorDiameter', majorDiameter);
+    assertPositive('minorDiameter', minorDiameter);
+    assertPositive('rootWidth', rootWidth);
+    assertPositive('crestWidth', crestWidth);
+    if (y < pitch) {
+        throw new Error('y must be at least one thread pitch.');
+    }
+    if (minorDiameter >= majorDiameter) {
+        throw new Error('minorDiameter must be smaller than majorDiameter.');
+    }
+    if (crestWidth >= rootWidth || rootWidth > pitch) {
+        throw new Error('The thread profile requires crestWidth < rootWidth <= pitch.');
+    }
+}
+function cachedHelicalThreadShape(options) {
+    const key = JSON.stringify([
+        options.pitch,
+        options.y,
+        options.majorRadius,
+        options.minorRadius,
+        options.rootWidth,
+        options.crestWidth,
+        options.leftHanded,
+    ]);
+    let brep = threadBreps.get(key);
+    if (brep === undefined) {
+        const shape = makeHelicalThreadShape(options);
+        try {
+            brep = shape.serialize();
+        }
+        finally {
+            shape.delete();
+        }
+        if (brep.length <= maximumCachedBrepCharacters) {
+            threadBreps.set(key, brep);
+            cachedBrepCharacters += brep.length;
+            while (cachedBrepCharacters > maximumCachedBrepCharacters) {
+                const [oldestKey, oldestBrep] = threadBreps.entries().next().value;
+                threadBreps.delete(oldestKey);
+                cachedBrepCharacters -= oldestBrep.length;
+            }
+        }
+    }
+    else {
+        threadBreps.delete(key);
+        threadBreps.set(key, brep);
+    }
+    // Cache data, not native handles or disposable models. Each invocation owns
+    // a fresh shape in the current kernel. Reading both misses and hits also
+    // applies the same B-Rep normalization before core identifies the geometry.
+    return replicad.deserializeShape(brep);
+}
+/**
+ * Builds a closed external thread around its minor-diameter core. The lofted
+ * end treatment follows the MIT-licensed replicad-threads construction by
+ * Steve Genoud, adapted here to code3d's Y-axis and geometry ownership model.
+ */
+function makeHelicalThreadShape({ pitch, y, majorRadius, minorRadius, rootWidth, crestWidth, leftHanded, }) {
+    const toothHeight = majorRadius - minorRadius;
+    const profile = threadProfile(rootWidth, crestWidth, toothHeight);
+    const teeth = fadedThread(pitch, minorRadius, y, profile, leftHanded);
+    const core = makeCylinder(minorRadius + 0.05, y);
+    const threaded = core.fuse(teeth);
+    core.delete();
+    teeth.delete();
+    return threaded.rotate(-90, [0, 0, 0], [1, 0, 0]).translate([0, -y / 2, 0]);
+}
+function threadProfile(rootWidth, crestWidth, toothHeight) {
+    const rootHalf = rootWidth / 2;
+    const crestHalf = crestWidth / 2;
+    return draw([rootHalf, -0.05])
+        .vLine(0.05)
+        .lineTo([crestHalf, toothHeight])
+        .hLineTo(-crestHalf)
+        .lineTo([-rootHalf, 0])
+        .vLine(-0.05)
+        .close();
+}
+function fadedThread(pitch, radius, length, profile, leftHanded) {
+    const bottomEnd = fadedEnd(pitch, radius, profile, true, leftHanded);
+    const totalLoops = length / pitch - 0.5;
+    const fullLoops = Math.floor(totalLoops);
+    const leftover = totalLoops - fullLoops;
+    const singleLoop = basicThreadLoop(pitch, radius, profile, 1, 'none', leftHanded);
+    const shells = Array.from({ length: fullLoops }, (_, index) => singleLoop.clone().translate([0, 0, index * pitch]));
+    singleLoop.delete();
+    if (leftover > 1e-9) {
+        shells.push(basicThreadLoop(pitch, radius, profile, leftover, 'none', leftHanded).translate([0, 0, fullLoops * pitch]));
+    }
+    const topEnd = fadedEnd(pitch, radius, profile, false, leftHanded)
+        .translate([0, 0, totalLoops * pitch])
+        .rotate(360 * leftover, [0, 0, 0], [0, 0, 1]);
+    const thread = makeSolid([bottomEnd, ...shells, topEnd]).translate([
+        0,
+        0,
+        pitch / 4,
+    ]);
+    bottomEnd.delete();
+    shells.forEach(shell => shell.delete());
+    topEnd.delete();
+    return thread;
+}
+function basicThreadLoop(pitch, radius, profile, loopFraction, includeEnd, leftHanded) {
+    const helix = makeHelix(pitch, pitch * clamp(loopFraction, 0, 1), radius, [0, 0, 0], [0, 0, 1], leftHanded);
+    const profiles = loopSteps.map(step => {
+        const position = helix.pointAt(step);
+        const tangent = helix.tangentAt(step);
+        const plane = new Plane(position, [0, 0, 1], tangent);
+        const sketch = profile.sketchOnPlane(plane);
+        plane.delete();
+        return sketch;
+    });
+    helix.delete();
+    const ends = [];
+    if (includeEnd === 'first' || includeEnd === 'both') {
+        ends.push(profiles[0].faces());
+    }
+    if (includeEnd === 'last' || includeEnd === 'both') {
+        const face = profiles.at(-1).faces();
+        face.wrapped.Reverse();
+        ends.push(face);
+    }
+    const shell = profiles[0].loftWith(profiles.slice(1), { ruled: false }, true);
+    if (ends.length === 0)
+        return shell;
+    const closed = weldShellsAndFaces([shell, ...ends]);
+    shell.delete();
+    ends.forEach(face => face.delete());
+    return closed;
+}
+function fadedEnd(pitch, radius, profile, bottom, leftHanded) {
+    const length = pitch / 4;
+    const helix = makeHelix(pitch, length, radius, [0, 0, 0], [0, 0, bottom ? -1 : 1], leftHanded);
+    const profiles = loopSteps.map((step, index) => {
+        const position = helix.pointAt(step);
+        let tangent = helix.tangentAt(step);
+        if (bottom)
+            tangent = tangent.multiply(-1);
+        const plane = new Plane(position, [0, 0, 1], tangent);
+        const sketch = profile
+            .scale((loopSteps.length - index) / loopSteps.length, [0, 0])
+            .sketchOnPlane(plane);
+        plane.delete();
+        return sketch;
+    });
+    helix.delete();
+    const endFace = profiles.at(-1).faces();
+    const shell = profiles[0].loftWith(profiles.slice(1), { ruled: false }, true);
+    const closed = weldShellsAndFaces([shell, endFace]);
+    shell.delete();
+    endFace.delete();
+    return bottom ? closed.rotate(180, [0, 0, 0], [0, 0, 1]) : closed;
+}
+function assertPositive(name, value) {
+    if (!Number.isFinite(value) || value <= 0) {
+        throw new Error(`${name} must be a positive finite number.`);
+    }
+}
+function clamp(value, minimum, maximum) {
+    return Math.min(Math.max(value, minimum), maximum);
+}
+//# sourceMappingURL=thread.js.map

package/bld/library/thread.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"thread.js","sourceRoot":"","sources":["../../src/library/thread.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,eAAe,EACf,QAAQ,GAKT,MAAM,uBAAuB,CAAC;AAE/B,MAAM,EAAC,KAAK,EAAE,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,kBAAkB,EAAC,GACzE,QAAQ,CAAC;AAYX,MAAM,SAAS,GAAG,KAAK,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,EAAE,EAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,EAAE,CAAC,CAAC;AACrE,MAAM,WAAW,GAAG,IAAI,GAAG,EAAkB,CAAC;AAC9C,MAAM,2BAA2B,GAAG,CAAC,GAAG,IAAI,GAAG,IAAI,CAAC;AACpD,IAAI,oBAAoB,GAAG,CAAC,CAAC;AAE7B,MAAM,CAAC,MAAM,aAAa,GAAG,eAAe,CAC1C,CAAC,OAA6B,EAAE,EAAE;IAChC,qBAAqB,CAAC,OAAO,CAAC,CAAC;IAC/B,MAAM,EACJ,aAAa,EACb,aAAa,EACb,UAAU,GAAG,KAAK,EAClB,GAAG,UAAU,EACd,GAAG,OAAO,CAAC;IACZ,OAAO,wBAAwB,CAAC;QAC9B,GAAG,UAAU;QACb,WAAW,EAAE,aAAa,GAAG,CAAC;QAC9B,WAAW,EAAE,aAAa,GAAG,CAAC;QAC9B,UAAU;KACX,CAAC,CAAC;AACL,CAAC,CACF,CAAC;AAEF,SAAS,qBAAqB,CAAC,EAC7B,KAAK,EACL,CAAC,EACD,aAAa,EACb,aAAa,EACb,SAAS,EACT,UAAU,GACW;IACrB,cAAc,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;IAC/B,cAAc,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IACvB,cAAc,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IAC/C,cAAc,CAAC,eAAe,EAAE,aAAa,CAAC,CAAC;IAC/C,cAAc,CAAC,WAAW,EAAE,SAAS,CAAC,CAAC;IACvC,cAAc,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;IACzC,IAAI,CAAC,GAAG,KAAK,EAAE,CAAC;QACd,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IACD,IAAI,aAAa,IAAI,aAAa,EAAE,CAAC;QACnC,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;IACvE,CAAC;IACD,IAAI,UAAU,IAAI,SAAS,IAAI,SAAS,GAAG,KAAK,EAAE,CAAC;QACjD,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;IACJ,CAAC;AACH,CAAC;AAYD,SAAS,wBAAwB,CAAC,OAAkC;IAClE,MAAM,GAAG,GAAG,IAAI,CAAC,SAAS,CAAC;QACzB,OAAO,CAAC,KAAK;QACb,OAAO,CAAC,CAAC;QACT,OAAO,CAAC,WAAW;QACnB,OAAO,CAAC,WAAW;QACnB,OAAO,CAAC,SAAS;QACjB,OAAO,CAAC,UAAU;QAClB,OAAO,CAAC,UAAU;KACnB,CAAC,CAAC;IACH,IAAI,IAAI,GAAG,WAAW,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAChC,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC;QAC9C,IAAI,CAAC;YACH,IAAI,GAAG,KAAK,CAAC,SAAS,EAAE,CAAC;QAC3B,CAAC;gBAAS,CAAC;YACT,KAAK,CAAC,MAAM,EAAE,CAAC;QACjB,CAAC;QACD,IAAI,IAAI,CAAC,MAAM,IAAI,2BAA2B,EAAE,CAAC;YAC/C,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;YAC3B,oBAAoB,IAAI,IAAI,CAAC,MAAM,CAAC;YACpC,OAAO,oBAAoB,GAAG,2BAA2B,EAAE,CAAC;gBAC1D,MAAM,CAAC,SAAS,EAAE,UAAU,CAAC,GAAG,WAAW,CAAC,OAAO,EAAE,CAAC,IAAI,EAAE,CAAC,KAAM,CAAC;gBACpE,WAAW,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;gBAC9B,oBAAoB,IAAI,UAAU,CAAC,MAAM,CAAC;YAC5C,CAAC;QACH,CAAC;IACH,CAAC;SAAM,CAAC;QACN,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACxB,WAAW,CAAC,GAAG,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC7B,CAAC;IACD,4EAA4E;IAC5E,yEAAyE;IACzE,4EAA4E;IAC5E,OAAO,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAY,CAAC;AACpD,CAAC;AAED;;;;GAIG;AACH,SAAS,sBAAsB,CAAC,EAC9B,KAAK,EACL,CAAC,EACD,WAAW,EACX,WAAW,EACX,SAAS,EACT,UAAU,EACV,UAAU,GACgB;IAC1B,MAAM,WAAW,GAAG,WAAW,GAAG,WAAW,CAAC;IAC9C,MAAM,OAAO,GAAG,aAAa,CAAC,SAAS,EAAE,UAAU,EAAE,WAAW,CAAC,CAAC;IAClE,MAAM,KAAK,GAAG,WAAW,CAAC,KAAK,EAAE,WAAW,EAAE,CAAC,EAAE,OAAO,EAAE,UAAU,CAAC,CAAC;IACtE,MAAM,IAAI,GAAG,YAAY,CAAC,WAAW,GAAG,IAAI,EAAE,CAAC,CAAC,CAAC;IACjD,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IAClC,IAAI,CAAC,MAAM,EAAE,CAAC;IACd,KAAK,CAAC,MAAM,EAAE,CAAC;IACf,OAAO,QAAQ,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;AAC9E,CAAC;AAED,SAAS,aAAa,CACpB,SAAiB,EACjB,UAAkB,EAClB,WAAmB;IAEnB,MAAM,QAAQ,GAAG,SAAS,GAAG,CAAC,CAAC;IAC/B,MAAM,SAAS,GAAG,UAAU,GAAG,CAAC,CAAC;IACjC,OAAO,IAAI,CAAC,CAAC,QAAQ,EAAE,CAAC,IAAI,CAAC,CAAC;SAC3B,KAAK,CAAC,IAAI,CAAC;SACX,MAAM,CAAC,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC;SAChC,OAAO,CAAC,CAAC,SAAS,CAAC;SACnB,MAAM,CAAC,CAAC,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC;SACtB,KAAK,CAAC,CAAC,IAAI,CAAC;SACZ,KAAK,EAAE,CAAC;AACb,CAAC;AAED,SAAS,WAAW,CAClB,KAAa,EACb,MAAc,EACd,MAAc,EACd,OAAgB,EAChB,UAAmB;IAEnB,MAAM,SAAS,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC;IACrE,MAAM,UAAU,GAAG,MAAM,GAAG,KAAK,GAAG,GAAG,CAAC;IACxC,MAAM,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;IACzC,MAAM,QAAQ,GAAG,UAAU,GAAG,SAAS,CAAC;IACxC,MAAM,UAAU,GAAG,eAAe,CAChC,KAAK,EACL,MAAM,EACN,OAAO,EACP,CAAC,EACD,MAAM,EACN,UAAU,CACX,CAAC;IACF,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,EAAC,MAAM,EAAE,SAAS,EAAC,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAC1D,UAAU,CAAC,KAAK,EAAE,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,KAAK,GAAG,KAAK,CAAC,CAAC,CACpD,CAAC;IACF,UAAU,CAAC,MAAM,EAAE,CAAC;IACpB,IAAI,QAAQ,GAAG,IAAI,EAAE,CAAC;QACpB,MAAM,CAAC,IAAI,CACT,eAAe,CACb,KAAK,EACL,MAAM,EACN,OAAO,EACP,QAAQ,EACR,MAAM,EACN,UAAU,CACX,CAAC,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,SAAS,GAAG,KAAK,CAAC,CAAC,CACvC,CAAC;IACJ,CAAC;IACD,MAAM,MAAM,GAAG,QAAQ,CAAC,KAAK,EAAE,MAAM,EAAE,OAAO,EAAE,KAAK,EAAE,UAAU,CAAC;SAC/D,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,UAAU,GAAG,KAAK,CAAC,CAAC;SACrC,MAAM,CAAC,GAAG,GAAG,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAChD,MAAM,MAAM,GAAG,SAAS,CAAC,CAAC,SAAS,EAAE,GAAG,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC,SAAS,CAAC;QACjE,CAAC;QACD,CAAC;QACD,KAAK,GAAG,CAAC;KACV,CAAC,CAAC;IACH,SAAS,CAAC,MAAM,EAAE,CAAC;IACnB,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,MAAM,EAAE,CAAC,CAAC;IACxC,MAAM,CAAC,MAAM,EAAE,CAAC;IAChB,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,eAAe,CACtB,KAAa,EACb,MAAc,EACd,OAAgB,EAChB,YAAoB,EACpB,UAA8C,EAC9C,UAAmB;IAEnB,MAAM,KAAK,GAAG,SAAS,CACrB,KAAK,EACL,KAAK,GAAG,KAAK,CAAC,YAAY,EAAE,CAAC,EAAE,CAAC,CAAC,EACjC,MAAM,EACN,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,UAAU,CACX,CAAC;IACF,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACpC,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,OAAO,CAAC,aAAa,CAAC,KAAK,CAAW,CAAC;QACtD,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,MAAM,EAAE,CAAC;IAEf,MAAM,IAAI,GAAW,EAAE,CAAC;IACxB,IAAI,UAAU,KAAK,OAAO,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;QACpD,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,KAAK,EAAE,CAAC,CAAC;IACjC,CAAC;IACD,IAAI,UAAU,KAAK,MAAM,IAAI,UAAU,KAAK,MAAM,EAAE,CAAC;QACnD,MAAM,IAAI,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,EAAE,CAAC;QACtC,IAAI,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;QACvB,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAClB,CAAC;IACD,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAE,IAAI,CAAC,CAAC;IAC5E,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACpC,MAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,MAAM,EAAE,CAAC;IACf,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,MAAM,EAAE,CAAC,CAAC;IACpC,OAAO,MAAM,CAAC;AAChB,CAAC;AAED,SAAS,QAAQ,CACf,KAAa,EACb,MAAc,EACd,OAAgB,EAChB,MAAe,EACf,UAAmB;IAEnB,MAAM,MAAM,GAAG,KAAK,GAAG,CAAC,CAAC;IACzB,MAAM,KAAK,GAAG,SAAS,CACrB,KAAK,EACL,MAAM,EACN,MAAM,EACN,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EACT,CAAC,CAAC,EAAE,CAAC,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,EACvB,UAAU,CACX,CAAC;IACF,MAAM,QAAQ,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;QAC7C,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC;QACrC,IAAI,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;QACpC,IAAI,MAAM;YAAE,OAAO,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,KAAK,CAAC,QAAQ,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;QACtD,MAAM,MAAM,GAAG,OAAO;aACnB,KAAK,CAAC,CAAC,SAAS,CAAC,MAAM,GAAG,KAAK,CAAC,GAAG,SAAS,CAAC,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;aAC5D,aAAa,CAAC,KAAK,CAAW,CAAC;QAClC,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IACH,KAAK,CAAC,MAAM,EAAE,CAAC;IACf,MAAM,OAAO,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAE,CAAC,KAAK,EAAE,CAAC;IACzC,MAAM,KAAK,GAAG,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,EAAC,KAAK,EAAE,KAAK,EAAC,EAAE,IAAI,CAAC,CAAC;IAC5E,MAAM,MAAM,GAAG,kBAAkB,CAAC,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC,CAAC;IACpD,KAAK,CAAC,MAAM,EAAE,CAAC;IACf,OAAO,CAAC,MAAM,EAAE,CAAC;IACjB,OAAO,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC,EAAE,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC;AACpE,CAAC;AAED,SAAS,cAAc,CAAC,IAAY,EAAE,KAAa;IACjD,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,CAAC;QAC1C,MAAM,IAAI,KAAK,CAAC,GAAG,IAAI,oCAAoC,CAAC,CAAC;IAC/D,CAAC;AACH,CAAC;AAED,SAAS,KAAK,CAAC,KAAa,EAAE,OAAe,EAAE,OAAe;IAC5D,OAAO,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE,OAAO,CAAC,CAAC;AACrD,CAAC"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@code3d/screws",
+  "version": "0.0.1-alpha.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "license": "SEE LICENSE IN LICENSE",
+  "author": "vilicvane",
+  "type": "module",
+  "scripts": {
+    "prepack": "node ../../scripts/package-license.mjs",
+    "test": "node ../../node_modules/typescript/bin/tsc --build src/library/tsconfig.json && npm run test:types && npm run test:run",
+    "test:run": "node --test \"test/*.test.ts\"",
+    "test:types": "node ../../node_modules/typescript/bin/tsc --noEmit -p test/tsconfig.json"
+  },
+  "exports": {
+    ".": {
+      "types": "./bld/library/index.d.ts",
+      "default": "./bld/library/index.js"
+    }
+  },
+  "files": [
+    "bld",
+    "README.md",
+    "src"
+  ],
+  "peerDependencies": {
+    "@code3d/core": "^0.0.1-alpha.0"
+  },
+  "devDependencies": {
+    "@code3d/core": "*"
+  }
+}

package/src/library/index.ts

@@ -0,0 +1 @@
+export * as ISO4762 from './iso-4762.js';

package/src/library/iso-4762.ts

@@ -0,0 +1,372 @@
+import {
+  cylinder,
+  cut,
+  frustum,
+  regularPrism,
+  union,
+  type CanonicalElements,
+  type Bound,
+  type LineAnchor,
+  type SolidModel,
+} from '@code3d/core';
+import {helicalThread} from './thread.js';
+
+export type ClearanceFit = 'close' | 'normal' | 'loose';
+
+export type Specification = Readonly<{
+  designation: string;
+  nominalDiameter: number;
+  pitch: number;
+  headDiameter: number;
+  headHeight: number;
+  hexSocketWidth: number;
+  hexSocketDepth: number;
+  underHeadRadius: number;
+  clearance: Readonly<Record<ClearanceFit, number>>;
+  counterboreDiameter: number;
+}>;
+
+// ISO 4762 coarse-thread socket-head cap screws; millimetres.
+// Clearance series follow ISO 273. Counterbores follow DIN 974-1 normal series.
+export const specifications = {
+  M3: {
+    designation: 'M3',
+    nominalDiameter: 3,
+    pitch: 0.5,
+    headDiameter: 5.5,
+    headHeight: 3,
+    hexSocketWidth: 2.5,
+    hexSocketDepth: 1.3,
+    underHeadRadius: 0.1,
+    clearance: {close: 3.2, normal: 3.4, loose: 3.6},
+    counterboreDiameter: 6,
+  },
+  M4: {
+    designation: 'M4',
+    nominalDiameter: 4,
+    pitch: 0.7,
+    headDiameter: 7,
+    headHeight: 4,
+    hexSocketWidth: 3,
+    hexSocketDepth: 2,
+    underHeadRadius: 0.2,
+    clearance: {close: 4.3, normal: 4.5, loose: 4.8},
+    counterboreDiameter: 8,
+  },
+  M5: {
+    designation: 'M5',
+    nominalDiameter: 5,
+    pitch: 0.8,
+    headDiameter: 8.5,
+    headHeight: 5,
+    hexSocketWidth: 4,
+    hexSocketDepth: 2.5,
+    underHeadRadius: 0.2,
+    clearance: {close: 5.3, normal: 5.5, loose: 5.8},
+    counterboreDiameter: 10,
+  },
+  M6: {
+    designation: 'M6',
+    nominalDiameter: 6,
+    pitch: 1,
+    headDiameter: 10,
+    headHeight: 6,
+    hexSocketWidth: 5,
+    hexSocketDepth: 3,
+    underHeadRadius: 0.25,
+    clearance: {close: 6.4, normal: 6.6, loose: 7},
+    counterboreDiameter: 11,
+  },
+  M8: {
+    designation: 'M8',
+    nominalDiameter: 8,
+    pitch: 1.25,
+    headDiameter: 13,
+    headHeight: 8,
+    hexSocketWidth: 6,
+    hexSocketDepth: 4,
+    underHeadRadius: 0.4,
+    clearance: {close: 8.4, normal: 9, loose: 10},
+    counterboreDiameter: 15,
+  },
+  M10: {
+    designation: 'M10',
+    nominalDiameter: 10,
+    pitch: 1.5,
+    headDiameter: 16,
+    headHeight: 10,
+    hexSocketWidth: 8,
+    hexSocketDepth: 5,
+    underHeadRadius: 0.4,
+    clearance: {close: 10.5, normal: 11, loose: 12},
+    counterboreDiameter: 18,
+  },
+  M12: {
+    designation: 'M12',
+    nominalDiameter: 12,
+    pitch: 1.75,
+    headDiameter: 18,
+    headHeight: 12,
+    hexSocketWidth: 10,
+    hexSocketDepth: 6,
+    underHeadRadius: 0.6,
+    clearance: {close: 13, normal: 13.5, loose: 14.5},
+    counterboreDiameter: 20,
+  },
+} as const satisfies Readonly<Record<string, Specification>>;
+
+export type Size = keyof typeof specifications;
+export type ScrewInput = Size | Specification;
+
+export type CounterboreOptions = Readonly<{
+  diameter?: number;
+  depth?: number;
+  axialClearance?: number;
+}>;
+
+export type ClearanceHoleOptions = Readonly<{
+  depth: number;
+  fit?: ClearanceFit;
+  diameter?: number;
+  counterbore?: boolean | CounterboreOptions;
+}>;
+
+export type PlainClearanceHoleOptions = ClearanceHoleOptions &
+  Readonly<{
+    counterbore: false;
+  }>;
+
+export type CounterboredHoleOptions = Omit<
+  ClearanceHoleOptions,
+  'counterbore'
+> &
+  Readonly<{
+    counterbore?: true | CounterboreOptions;
+  }>;
+
+export type SocketCapScrewElements = CanonicalElements &
+  Readonly<{
+    headTop: Bound;
+    headBottom: Bound;
+    shankTop: Bound;
+    shankBottom: Bound;
+    shankAxis: LineAnchor;
+  }>;
+
+export type SocketCapHoleElements = CanonicalElements &
+  Readonly<{
+    shaftTop: Bound;
+    shaftBottom: Bound;
+    shaftAxis: LineAnchor;
+  }>;
+
+export type CounterboredSocketCapHoleElements = SocketCapHoleElements &
+  Readonly<{
+    counterboreTop: Bound;
+    counterboreBottom: Bound;
+  }>;
+
+export type Screw = SolidModel<SocketCapScrewElements>;
+export type ClearanceHole = SolidModel<SocketCapHoleElements>;
+export type CounterboredHole = SolidModel<CounterboredSocketCapHoleElements>;
+
+/**
+ * @code3d.arguments ['M6', 18]
+ * @code3d.arguments ['M8', 30]
+ * @code3d.param length {kind: 'length'}
+ */
+export function screw(input: ScrewInput, length: number): Screw {
+  const spec = resolveSpecification(input);
+  validateSpec(spec);
+  if (!Number.isFinite(length) || length <= spec.pitch + spec.underHeadRadius) {
+    throw new Error(
+      'Screw length must leave room for at least one full thread pitch.',
+    );
+  }
+
+  const headChamfer = Math.min(spec.pitch / 2, spec.headHeight * 0.12);
+  const headBarrel = cylinder(
+    spec.headDiameter / 2,
+    spec.headHeight - headChamfer,
+  );
+  const headTop = frustum(
+    spec.headDiameter / 2,
+    spec.headDiameter / 2 - headChamfer,
+    headChamfer,
+  ).relate(top => top.on(headBarrel.up));
+  const headBlank = union([headBarrel, headTop]);
+
+  const socketToolY = spec.hexSocketDepth + 0.2;
+  const socketTool = regularPrism(
+    spec.hexSocketWidth / Math.sqrt(3),
+    socketToolY,
+    6,
+    30,
+  ).relate(tool =>
+    tool.center.on(headBlank.up).offset(0, -spec.hexSocketDepth / 2 + 0.1, 0),
+  );
+  const head = cut(headBlank, [socketTool]);
+
+  const transition = frustum(
+    spec.nominalDiameter / 2,
+    spec.nominalDiameter / 2 + spec.underHeadRadius,
+    spec.underHeadRadius,
+  ).relate(part => part.on(head.down));
+  const bodyLength = length - spec.underHeadRadius;
+  const threadedLength = Math.min(bodyLength, threadLength(spec, length));
+  const plainLength = bodyLength - threadedLength;
+  const overlap = Math.min(0.08, spec.pitch / 10);
+  const parts = [head, transition];
+  let previous = transition;
+
+  if (plainLength > overlap) {
+    const shank = cylinder(
+      spec.nominalDiameter / 2,
+      plainLength + overlap,
+    ).relate(part => part.on(previous.down).offset(0, -overlap, 0));
+    parts.push(shank);
+    previous = shank;
+  }
+
+  const fundamentalHeight = (Math.sqrt(3) / 2) * spec.pitch;
+  const minorDiameter =
+    spec.nominalDiameter - 2 * ((5 / 8) * fundamentalHeight);
+  const thread = helicalThread({
+    pitch: spec.pitch,
+    y: threadedLength + overlap,
+    majorDiameter: spec.nominalDiameter,
+    minorDiameter,
+    rootWidth: (3 / 4) * spec.pitch,
+    crestWidth: (1 / 8) * spec.pitch,
+  }).relate(part => part.on(previous.down).offset(0, -overlap, 0));
+  parts.push(thread);
+
+  return union(parts).expose({
+    headTop: head.up,
+    headBottom: head.down,
+    shankTop: transition.up,
+    shankBottom: thread.down,
+    shankAxis: thread.axis,
+  });
+}
+
+/**
+ * @code3d.arguments ['M6', 10]
+ * @code3d.arguments ['M6', {depth: 10, counterbore: false}]
+ * @code3d.param depth {kind: 'length', constraints: {exclusiveMin: 0}}
+ */
+export function clearanceHole(
+  input: ScrewInput,
+  depth: number,
+): CounterboredHole;
+export function clearanceHole(
+  input: ScrewInput,
+  options: PlainClearanceHoleOptions,
+): ClearanceHole;
+export function clearanceHole(
+  input: ScrewInput,
+  options: CounterboredHoleOptions,
+): CounterboredHole;
+export function clearanceHole(
+  input: ScrewInput,
+  options: ClearanceHoleOptions,
+): ClearanceHole | CounterboredHole;
+export function clearanceHole(
+  input: ScrewInput,
+  optionsOrDepth: ClearanceHoleOptions | number,
+): ClearanceHole | CounterboredHole {
+  const options: ClearanceHoleOptions =
+    typeof optionsOrDepth === 'number'
+      ? {depth: optionsOrDepth}
+      : optionsOrDepth;
+  const spec = resolveSpecification(input);
+  validateSpec(spec);
+  if (!Number.isFinite(options.depth) || options.depth <= 0) {
+    throw new Error('Hole depth must be a positive finite number.');
+  }
+  const fit = options.fit ?? 'normal';
+  const diameter = options.diameter ?? spec.clearance[fit];
+  if (!Number.isFinite(diameter) || diameter <= spec.nominalDiameter) {
+    throw new Error(
+      'Clearance-hole diameter must exceed the nominal screw diameter.',
+    );
+  }
+  const shaft = cylinder(diameter / 2, options.depth);
+  const counterboreOption = options.counterbore ?? true;
+  if (counterboreOption === false) {
+    return shaft.expose({
+      shaftTop: shaft.up,
+      shaftBottom: shaft.down,
+      shaftAxis: shaft.axis,
+    });
+  }
+
+  const counterbore = counterboreOption === true ? {} : counterboreOption;
+  const axialClearance = counterbore.axialClearance ?? 0.5;
+  const counterboreDepth =
+    counterbore.depth ?? spec.headHeight + axialClearance;
+  const counterboreDiameter = counterbore.diameter ?? spec.counterboreDiameter;
+  if (
+    !Number.isFinite(counterboreDepth) ||
+    counterboreDepth <= 0 ||
+    counterboreDepth > options.depth
+  ) {
+    throw new Error('Counterbore depth must be within the total hole depth.');
+  }
+  if (
+    !Number.isFinite(counterboreDiameter) ||
+    counterboreDiameter < spec.headDiameter
+  ) {
+    throw new Error('Counterbore diameter must accommodate the screw head.');
+  }
+  const recess = cylinder(
+    counterboreDiameter / 2,
+    counterboreDepth + 0.2,
+  ).relate(tool =>
+    tool.center.on(shaft.up).offset(0, -counterboreDepth / 2 + 0.1, 0),
+  );
+  return union([shaft, recess]).expose({
+    shaftTop: shaft.up,
+    shaftBottom: shaft.down,
+    shaftAxis: shaft.axis,
+    counterboreTop: recess.up,
+    counterboreBottom: recess.down,
+  });
+}
+
+export function resolveSpecification(input: ScrewInput): Specification {
+  return typeof input === 'string' ? specifications[input] : input;
+}
+
+export function threadLength(spec: Specification, length: number): number {
+  if (length <= 125) return 2 * spec.nominalDiameter + 12;
+  if (length <= 200) return 2 * spec.nominalDiameter + 18;
+  return 2 * spec.nominalDiameter + 31;
+}
+
+function validateSpec(spec: Specification): void {
+  const values = [
+    spec.nominalDiameter,
+    spec.pitch,
+    spec.headDiameter,
+    spec.headHeight,
+    spec.hexSocketWidth,
+    spec.hexSocketDepth,
+    spec.underHeadRadius,
+    spec.clearance.close,
+    spec.clearance.normal,
+    spec.clearance.loose,
+    spec.counterboreDiameter,
+  ];
+  if (values.some(value => !Number.isFinite(value) || value <= 0)) {
+    throw new Error(
+      'Fastener specifications must contain positive finite dimensions.',
+    );
+  }
+  if (spec.headDiameter <= spec.nominalDiameter) {
+    throw new Error('Head diameter must exceed the nominal thread diameter.');
+  }
+  if (spec.hexSocketDepth >= spec.headHeight) {
+    throw new Error('Hex socket depth must be smaller than the head height.');
+  }
+}