forgecad 0.9.15 → 0.10.0

package/dist/docs-raw/generated/legacy.md

@@ -0,0 +1,162 @@
+<!-- AUTO-GENERATED by scripts/gen-api-docs.mjs. Do not edit by hand. -->
+<!-- BUILD GUARD: no skill-group frontmatter, ever — this file is a lookup table for
+     agents editing old models, not taught context. Banned from the skill bundle via
+     BUNDLE_BANNED_DOCS in scripts/build-forgecad-skill.mjs. -->
+
+# Legacy API Names
+
+These names still run but are no longer taught; new code must use the replacement.
+Each emits a one-time deprecation warning per script run.
+They may be removed in a future release.
+
+## core
+
+| Old name | Use instead |
+|----------|-------------|
+| `composeChain()` | `Transform.compose(a, b, ...)` |
+| `importSvgSketch()` | `Import.svgSketch(file, options)` |
+| `importMesh()` | `Import.mesh(file, options)` |
+| `importStep()` | `Import.step(file)` |
+| `Constraint.makeParallel()` | `sk.parallel(a, b)` |
+| `Constraint.horizontal()` | `sk.horizontal(line)` |
+| `Constraint.vertical()` | `sk.vertical(line)` |
+| `Constraint.equalLength()` | `sk.equal(a, b)` |
+| `Constraint.distance()` | `sk.distance(a, b, value)` |
+| `Constraint.fix()` | `sk.fix(point, x, y)` |
+| `Constraint.coincident()` | `sk.coincident(a, b)` |
+| `Constraint.perpendicular()` | `sk.perpendicular(a, b)` |
+| `Constraint.length()` | `sk.length(line, value)` |
+| `Slot.rounded()` | `SurfaceMembers.roundedSlot({ length, width }) — same builder, same fluent chain` |
+| `Counterbore.cylindrical()` | `SurfaceMembers.counterbore({ diameter, clearanceDiameter, depth }) — same builder, same fluent chain` |
+| `Ribs.repeated()` | `SurfaceMembers.ribs({ count, height }) — same feature object` |
+
+## sketch
+
+| Old name | Use instead |
+|----------|-------------|
+| `point()` | `new Point2D(x, y) — or cs.point(x, y) inside constrainedSketch()` |
+| `line()` | `Line2D.fromCoordinates(x1, y1, x2, y2) — or cs.line(a, b) inside constrainedSketch()` |
+| `circle()` | `Circle2D.fromCenterAndRadius(new Point2D(cx, cy), r) — or circle2d(r) for a sketch profile` |
+| `addRect()` | `sk.rect({ x: 0, y: 0, width: 100, height: 50 }) — same options, called on the constrainedSketch() builder` |
+| `addPolygon()` | `sk.addPolygon({ points: [[0,0],[100,0],[50,80]] }) — same options, called on the constrainedSketch() builder` |
+| `addRegularPolygon()` | `sk.regularPolygon({ sides: 6, radius: 25 }) — same options, called on the constrainedSketch() builder` |
+| `filletTrackedEdge()` | `fillet(shape, radius, shape.edge('vert-br')) — same exact compiler-owned path, no quadrant tuple needed` |
+| `chamferTrackedEdge()` | `chamfer(shape, size, shape.edge('vert-br')) — same exact compiler-owned path, no quadrant tuple needed` |
+| `filletCorners()` | `polygon(points).filletCorner([x, y], radius) — seed-point corner selection; or .filletCorners(radius) for all corners` |
+| `star()` | `polygon(tips.flatMap((tip, i) => [tip, valleys[i]])) with tips = polygonVertices(n, outerR, { startDeg: -90 }) and valleys = polygonVertices(n, innerR, { startDeg: -90 + 180 / n })` |
+| `ConstrainedSketchBuilder.importPoint()` | `sk.point(pt.x, pt.y, fixed) — constraint methods auto-import Point2D values directly` |
+| `ConstrainedSketchBuilder.importLine()` | `sk.line(sk.point(l.start.x, l.start.y, fixed), sk.point(l.end.x, l.end.y, fixed)) — constraint methods auto-import Line2D values directly` |
+| `ConstrainedSketchBuilder.importRectangle()` | `sk.rect({ x, y, width, height }) — returns richer named sides (bottom/right/top/left) and vertices` |
+
+## assembly
+
+| Old name | Use instead |
+|----------|-------------|
+| `bomToCsv()` | `solvedAssembly.bomCsv() — the method form covers BOM CSV export` |
+| `SolvedAssembly.mateExplodeHints()` | `explode hints derive automatically from connect()/match() joints — use explodeView()` |
+| `SolvedAssembly.mateDof()` | `diagnostics for the legacy mate() solver — position parts with connect()/match() and inspect kinematics instead` |
+| `SolvedAssembly.mateConverged()` | `diagnostics for the legacy mate() solver — position parts with connect()/match() and inspect kinematics instead` |
+| `SolvedAssembly.toScene()` | `toSceneObjects() — same return shape; or return the SolvedAssembly directly` |
+| `Assembly.usedPortRefs()` | `usedConnectorRefs — same ReadonlySet` |
+| `Assembly.mate()` | `connect("Parent.connectorA", "Child.connectorB") / match("Child.connectorB", "Parent.connectorA") — connector-frame joints replace string-ref mates` |
+| `Assembly.getPort()` | `getConnector(ref) — same "PartName.connectorName" ref; fields are partName/connectorName/connector` |
+| `Assembly.linkToward()` | `linkAlong(name, fromLink, towardLink, distance) — same arguments; positive distance moves toward towardLink, negative moves away` |
+| `Assembly.linkAwayFrom()` | `linkAlong(name, fromLink, awayFromLink, -distance) — negate the distance: negative values extend away from the reference link` |
+| `Assembly.toJointsView()` | `return the Assembly directly (return mech) — solver-backed controls appear automatically; use addAnimation(name, { keyframes }) for animation clips` |
+| `ImportedAssembly.part()` | `getPart(name, state?) — same offset-aware accessor; note that solve(state).getPart(name) does NOT apply the placeReference() offset stored on the imported assembly` |
+| `ImportedAssembly.translate()` | `toGroup().translate(x, y, z) — the explicit toGroup(state?) call shows where kinematics become a static group; or placeReference() to position by a named point` |
+| `ImportedAssembly.rotate()` | `toGroup().rotate(axis, angleDeg, options) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.rotateX()` | `toGroup().rotateX(angleDeg, options) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.rotateY()` | `toGroup().rotateY(angleDeg, options) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.rotateZ()` | `toGroup().rotateZ(angleDeg, options) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.scale()` | `toGroup().scale(v) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.mirror()` | `toGroup().mirror(normal) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+| `ImportedAssembly.color()` | `toGroup().color(hex) — the explicit toGroup(state?) call shows where kinematics become a static group` |
+
+## curves
+
+| Old name | Use instead |
+|----------|-------------|
+| `nurbsSurface()` | `Surface.Nurbs(controlGrid, options) — same arguments and options, including thickness` |
+| `surfacePatch()` | `Surface.Patch(curves, { approximate: true }) — Surface.Patch defaults approximate: false (pass { approximate: true } for sampled Curve3D/Vec3[] boundaries) and returns an open sheet; use .thicken(t) instead of the thickness option` |
+| `Surface.MatchEdge()` | `Surface.Match()` |
+| `Product.ovalProfile()` | `Product.profiles.oval(width, depth, options) — identical arguments` |
+| `Product.roundedRectProfile()` | `Product.profiles.roundedRect(width, depth, radius) — identical arguments` |
+| `Product.circleProfile()` | `Product.profiles.circle(diameter, options) — identical arguments` |
+| `Product.superEllipseProfile()` | `Product.profiles.superEllipse(width, depth, options) — identical arguments` |
+| `Product.spout()` | `Product.place(loft(sectionSketches, heights).as('spout'), ref) — loft the local spout sections at origin, then place the result on the ProductSurfaceRef frame (or ref.attach(...) with offset/inset options)` |
+| `Product.handle()` | `sweep(gripProfile, spinePoints) with spine points derived from ref.frame().point, plus Product.place(padShape, ref) for landing pads — composes loft/sweep with connector frames instead of a fixed handle archetype` |
+| `Curve.Polyline()` | `pass the Vec3[] points array directly — sweep(profile, points) and Curve.Trim/Reverse accept raw point arrays; use Curve.Route.fromPolyline(points) when the centerline needs bend/port metadata` |
+| `Curve.Spline()` | `Curve.Fit(points) — exact NURBS interpolation through the same points (add { closed: true } for loops); unlike the sampled Catmull-Rom spline it works with Curve.Trim/Reverse, sweeps, and exact surface boundaries` |
+
+## sheet-metal
+
+| Old name | Use instead |
+|----------|-------------|
+| `kerfCompensateOutline()` | `sketch.offset(-kerf / 2) — or let FlatPart.profile(kerf) / Laser.kit({ kerf }) apply kerf compensation automatically` |
+| `kerfCompensateTabs()` | `sketch.offset(kerf / 2) — or let FlatPart.profile(kerf) / Laser.kit({ kerf }) apply kerf compensation automatically` |
+| `kerfCompensateSlots()` | `sketch.offset(kerf / 2) — or let FlatPart.profile(kerf) / Laser.kit({ kerf }) apply kerf compensation automatically` |
+| `kerfCompensatePart()` | `FlatPart.profile(kerf) / FlatPart.solid(kerf) — or Laser.kit({ kerf }), which compensates every part automatically` |
+| `lookupKerf()` | `Laser.lookupKerf(material, thickness, laserType)` |
+| `flatPanel()` | `Laser.panel(name, width, height, thickness, options) — identical arguments` |
+| `flatPart()` | `Laser.part(name, profile, thickness, edges, options) — identical arguments` |
+| `fingerJoint()` | `Laser.fingerJoint(partA, edgeA, partB, edgeB, options) — identical arguments` |
+| `tabSlot()` | `Laser.tabSlot(partA, edgeA, partB, edgeB, options) — identical arguments` |
+| `assemblyPreview()` | `Laser.kit(...).assemblyPreview(options) — the kit collects joints and applies its kerf (default 0.2 mm; this standalone form defaulted kerf to 0, so use Laser.kit({ kerf: 0 }) for byte-identical preview geometry); Laser.assemblyPreview(parts, joints, options) keeps the standalone form` |
+| `assemblyInstructions()` | `Laser.kit(...).assemblyInstructions(options) — the kit collects joints for you; Laser.instructions(parts, joints, options) keeps the standalone form` |
+| `formatInstructions()` | `Laser.kit(...).formatInstructions(options) — or Laser.formatInstructions(result) for the standalone form` |
+| `laserKit()` | `Laser.kit(options) — identical arguments` |
+| `COMMON_KERFS` | `Laser.COMMON_KERFS` |
+
+## viewport
+
+| Old name | Use instead |
+|----------|-------------|
+| `viewConfig()` | `scene({ jointOverlay: { ... } }) — same keys, on the one renderer-config global` |
+| `jointsView()` | `return the Assembly directly (return mech) — solver-backed controls appear automatically; use mech.addAnimation(name, { keyframes }) for animation clips` |
+| `showLabels()` | `Viewport.highlight(shape, { labels: true }) — then return the shape; highlight returns void` |
+| `highlight()` | `Viewport.highlight(target, options) — same arguments, namespaced with the other render-only overlays` |
+
+## output
+
+| Old name | Use instead |
+|----------|-------------|
+| `dimLine()` | `dim(line, opts) — dim() accepts a Line2D (or EdgeRef) directly` |
+
+## lib
+
+| Old name | Use instead |
+|----------|-------------|
+| `lib.boltHole()` | `shape.hole(face, { diameter, depth }) — face-relative blind/through holes with counterbore/countersink/thread support` |
+| `lib.counterbore()` | `shape.hole(face, { diameter: holeDia, counterbore: { diameter: boreDia, depth: boreDepth } }) — through by default; pass depth for blind holes` |
+| `lib.hexNut()` | `lib.nut(holeDia, { acrossFlats, height, boreDiameter: holeDia }) — exact same geometry` |
+| `lib.sideGear()` | `lib.faceGear(options) — identical arguments` |
+| `lib.sideGearPair()` | `lib.faceGearPair({ face, vertical, ... }) — same options with the side member renamed to face; diagnostics use facegear.* codes` |
+| `lib.gearBodyDisk()` | `lib.gearBodies.disk(options) — identical arguments` |
+| `lib.gearBodyDiskWithHub()` | `lib.gearBodies.diskWithHub(options) — identical arguments` |
+| `lib.gearBodySpoked()` | `lib.gearBodies.spoked(options) — identical arguments` |
+| `lib.gearBodyFromProfile()` | `lib.gearBodies.fromProfile(profile, options) — identical arguments` |
+
+## sdf
+
+| Old name | Use instead |
+|----------|-------------|
+| `combine()` | `sdf.combine(value, { op })` |
+| `Sculpt.circle()` | `Sculpt.disk(radius, thickness)` |
+| `Sculpt.path()` | `Sculpt.tube(points, options)` |
+| `sdf.morph()` | `a.morph(b, t)` |
+| `sdf.tpmsBlock()` | `sdf.gyroid({ cellSize, wallThickness }).intersect(sdf.box(x, y, z))` |
+| `sdf.withinBox()` | `shape.intersect(sdf.box(x, y, z))` |
+| `sdf.twist()` | `shape.twist(degreesPerUnit)` |
+| `sdf.bend()` | `shape.bend(radius)` |
+| `sdf.repeat()` | `shape.repeat(spacing, count)` |
+| `sdf.circularArray()` | `shape.circularArray(count, offset)` |
+| `SdfShape.move()` | `.at(x, y, z)` |
+| `SdfShape.goop()` | `.blend(other, { radius })` |
+| `SdfShape.keep()` | `.smoothIntersect(other, radius)` |
+| `SdfShape.clipBox()` | `.intersect(sdf.box(x, y, z))` |
+| `SdfShape.fillWith()` | `.intersect(pattern)` |
+| `SdfShape.fillWithGyroid()` | `.intersect(sdf.gyroid({ cellSize, wallThickness }))` |
+| `SdfShape.fillWithSchwarzP()` | `.intersect(sdf.schwarzP({ cellSize, wallThickness }))` |
+| `SdfShape.fillWithDiamond()` | `.intersect(sdf.diamond({ cellSize, wallThickness }))` |
+| `SdfShape.fillWithLidinoid()` | `.intersect(sdf.lidinoid({ cellSize, wallThickness }))` |