@metamesh/modeling 0.12.0 → 0.13.0

package/dist/docs/reference/model/anchor.md

@@ -0,0 +1,46 @@
+# anchor
+
+Reads a copied, immutable named anchor from this exact active generation.
+
+**anchor**(`shape`: [`Solid`](Solid.md) \| [`Section`](Section.md), `name`: `string`): [`Anchor3`](Anchor3.md)
+
+
+
+## Example: Read the top datum
+
+```ts
+const plate = box({ size: [30, 20, 6] });
+anchor(plate, "top"); // position [0, 0, 3], direction [0, 0, 1]
+```
+
+## Parameters
+
+<a id="shape"></a>
+
+**`shape`** · [`Solid`](Solid.md) \| [`Section`](Section.md) · Required
+
+
+
+<a id="name"></a>
+
+**`name`** · `string` · Required
+
+
+
+## Returns
+
+[`Anchor3`](Anchor3.md)
+
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [Section](Section.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Named anchors and custom frames](../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/box.md

@@ -0,0 +1,62 @@
+# box
+
+Axis-aligned box with uniform or disjoint named edge/group treatments.
+
+**box**(`options`: [`BoxOptions`](BoxOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Rounded box
+
+
+
+```ts
+box({ size: [30, 20, 8], treatment: { kind: "round", radius: 2 } });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`BoxOptions`](BoxOptions.md) · Required
+
+- [`size`](BoxOptions.md#size) · `number` \| [`Vector3`](Vector3.md) · Required
+
+  Positive uniform size or explicit `[X, Y, Z]` extents in millimetres.
+
+- [`limits`](BoxOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings for edge treatments, bounded by the host policy.
+
+- [`center`](BoxOptions.md#center) · `boolean` · Optional · Default: `true`
+
+  Centers the box on the XYZ origin when `true`; otherwise its minimum corner is at the origin.
+
+- [`treatment`](BoxOptions.md#treatment) · [`EdgeTreatment`](EdgeTreatment.md) \| `Readonly`\<`Partial`\<`Record`\<[`BoxEdgeSelection`](BoxEdgeSelection.md), [`EdgeTreatment`](EdgeTreatment.md)\>\>\> · Optional
+
+  Uniform treatment or independent disjoint nominal edge/group treatments.
+
+- [`placement`](BoxOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [BoxOptions](BoxOptions.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/boolean-operations.md

@@ -0,0 +1,37 @@
+# Boolean Operations
+
+Combine, intersect and subtract same-dimensional shapes; construct solid envelopes and sums.
+
+union and intersect combine arrays of Sections or Solids; shape.subtract(cutters) cuts an array from one base. Every operand must have the same dimension. Section operations preserve filled holes and disconnected components. compose combines solid components without a Boolean union; hull and minkowskiSum construct envelopes. Keep Boolean overtravel separate from physical fit clearance. hull accepts same-session solids, sections, or finite points. split returns intersection then subtraction without repeating the cutter setup. Plane operations use a nonzero normal and a signed millimetre offset along its normalized direction; empty results remain queryable handles.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [compose](../compose.md) | Combines disjoint components without resolving overlap. |
+| [hull](../hull.md) | Convex hull of points or solids. |
+| [intersect](../intersect.md) | Robust intersection. |
+| [minkowskiSum](../minkowskiSum.md) | Three-dimensional Minkowski sum. |
+| [union](../union.md) | Robust union. |
+| [split](../split.md) | Splits a solid into [inside the cutter, outside the cutter]. |
+| [splitByPlane](../splitByPlane.md) | Splits a solid into [positive-normal side, negative side] at a world-space plane. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [PlaneOptions](../PlaneOptions.md) | A world-space cutting plane, retaining the half-space in the normal's direction. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [HullOptions](../HullOptions.md) | Hull inputs are either finite points or same-session solids. |
+| [SectionHullOptions](../SectionHullOptions.md) | Planar convex hull inputs are finite XY points or same-session filled sections. |
+
+## Guides
+
+- [Choose the Boolean by the material you want](../../../guides/fundamentals.md#choose-the-boolean-by-the-material-you-want)
+- [Primitive booleans and repeated placement](../../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/bounded-surfaces.md

@@ -0,0 +1,26 @@
+# Sampled surfaces
+
+Construct bounded heightfields and positive-inside implicit fields.
+
+Heightfields accept uniform or explicit uneven XY coordinates and close absolute heights against a flat base. Fixed or shorter-edge triangulation samples each grid point once; centre-error selection also samples each cell centre without adding triangles. Implicit sampling uses finite bounds, positive grid spacing, and fixed algorithm limits before the engine checks actual extracted output. Neither operation silently reduces fidelity.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [heightfield](../heightfield.md) | Closed rectilinear top above a flat base, with uniform or explicit XY coordinates. Samples each grid height once; center-error triangulation also samples each cell centre. |
+| [implicit](../implicit.md) | Bounded positive-inside implicit field constructor. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [ImplicitOptions](../ImplicitOptions.md) | Positive-inside sampling, bounded to 4M native BCC grid slots and 8M field calls. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [HeightfieldOptions](../HeightfieldOptions.md) | A closed rectilinear heightfield above a flat base, with uniform or explicit XY samples in millimetres. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/contracts.md

@@ -0,0 +1,16 @@
+# Model contracts
+
+Describe opaque handles, dimensions, manufacturing parts, and completed snapshots.
+
+Generation returns semantic parts from part(id, geometry) or placement/color options. Opaque recipe handles belong to their session. Finalized snapshots carry copied manufacturing arrays and exact facts.
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [FinalizedModel](../FinalizedModel.md) | Finalized manufacturing snapshot. Its arrays are independent of all native values. |
+| [FinalizedPart](../FinalizedPart.md) | Copied manufacturing part with facts computed from the finalized mesh. |
+| [GeometrySamplingLimits](../GeometrySamplingLimits.md) | Explicit allocation ceilings for pure sampling and host-owned modeling operations. |
+| [ModelingLimits](../ModelingLimits.md) | Aggregate manufacturing output ceilings selected by a trusted host. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/core-values-errors.md

@@ -0,0 +1,30 @@
+# Core Values & Errors
+
+Use the small shared vocabulary for authored geometry, coordinates, paths, and stable failures.
+
+Use the small shared vocabulary for authored geometry, coordinates, paths, and stable failures.
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [Frame3](../Frame3.md) | A right-handed orthonormal coordinate frame expressed in world coordinates. |
+| [Polygon](../Polygon-type.md) | One bounded two-dimensional polygon. |
+| [Bounds2](../Bounds2.md) | Axis-aligned bounds in two-dimensional model space. |
+| [Bounds3](../Bounds3.md) | Axis-aligned bounds in three-dimensional model space. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [Contour](../Contour.md) | A closed two-dimensional boundary whose first point is not repeated at the end. |
+| [Region](../Region.md) | A two-dimensional region represented by disjoint filled polygons. |
+| [Vector2](../Vector2.md) | A two-dimensional Cartesian vector or point. |
+| [Vector3](../Vector3.md) | A three-dimensional Cartesian vector or point. |
+
+## Guides
+
+- [Geometry vocabulary](../../../guides/concepts.md#geometry-vocabulary)
+- [Lifecycle and inspection](../../../guides/concepts.md#lifecycle-and-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/explicit-profiles.md

@@ -0,0 +1,32 @@
+# Explicit matching profiles
+
+Build hollow or multicomponent lofts and sweeps using stable landmarks.
+
+Contour is plain point data with an implicit closing edge. Profile is an identified family specification with stable component, contour and span IDs; it is distinct from a filled native Section. Prepare matchProfiles over the complete family once to produce CorrespondingProfile values. All paired spans share a physical sampling grid, including logical slots for collapsed corners. loft and sweep consume this correspondence without guessing topology or rematching.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [matchProfiles](../matchProfiles.md) | Explicit family matching on a shared physical span grid using session or operation resolution. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [CorrespondingProfile](../CorrespondingProfile.md) | Shared logical contour sampling suitable for a loft or hollow sweep. |
+| [CorrespondingComponent](../CorrespondingComponent.md) | One sampled component retaining contour identities and logical point correspondence. |
+| [CorrespondingContour](../CorrespondingContour.md) | A sampled contour retaining logical slots, including intentionally collapsed spans. |
+| [MatchProfilesOptions](../MatchProfilesOptions.md) | Explicit family sampling settings; omitted values use physical package defaults. |
+| [Profile](../Profile.md) | An explicit component/contour/span topology, before shared family sampling. |
+| [ProfileComponent2](../ProfileComponent2.md) | One component and its explicitly identified holes. |
+| [ProfileContour2](../ProfileContour2.md) | Ordered, closed spans. Outer winding is CCW and hole winding is CW. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [CorrespondingProfileStation](../CorrespondingProfileStation.md) | One already matched profile at an explicit height or right-handed spatial frame. |
+| [ProfileSpan2](../ProfileSpan2.md) | An identified line, circular arc, or cubic Bézier between corresponding landmarks. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/extrude-revolve-sweep.md

@@ -0,0 +1,42 @@
+# Extrude, Revolve & Sweep
+
+Turn sections and paths into extruded, lofted, revolved, or swept solids.
+
+`section.extrude({ height, twistDegrees, scaleTop })` adds +Z depth; center defaults to false. `section.revolve({ revolveDegrees })` rotates radial/Z geometry around +Z and caps partial turns. loft(stations, options) places each profile at exactly one z or frame in input order. Compatible primitive landmarks match directly, including circle/ellipse quadrants to rectangle corners. Other unlike primitive families use direct perimeter association from construction-local +X seams. Arbitrary Sections and loops require an explicit direct, reindex, fast-distance or distance method. refine controls density and slices interpolate world vertices. Identified CorrespondingProfile landmarks reject geometric remapping. section.sweep(path, options) supports implicit closed paths, transport/fixed-normal/guide/Frenet orientation, physical-length or station twist progression, uniform/XY/per-station scales and an explicit rotationally equivalent seamProfileOffset. Open sweeps have watertight end caps; closed sweeps require compatible orientation and scale at the seam. Standalone extrude, revolve and sweep accept CorrespondingProfile data only; Section construction uses its methods.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [extrude](../extrude.md) | Extrudes explicit corresponding contours along +Z with degree twist and top scaling. Filled Sections use `section.extrude(options)`. |
+| [loft](../loft.md) | Lofts primitive Sections at z heights or frames; arbitrary Sections and loops require an explicit correspondence method. |
+| [revolve](../revolve.md) | Revolves explicit corresponding radial/Z contours around +Z, with caps for partial sweeps. Filled Sections use `section.revolve(options)`. |
+| [sweep](../sweep.md) | Sweeps explicit corresponding contours using the selected frame policy. Filled Sections use `section.sweep(path, options)`. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [ExtrudeOptions](../ExtrudeOptions.md) | Dimensions and sampling shared by native and pure +Z extrusion. |
+| [LoftOptions](../LoftOptions.md) | Shared controls for native and pure lofts. Point data and arbitrary Sections require explicit correspondence. |
+| [RevolveOptions](../RevolveOptions.md) | Circumferential sampling and degree sweep shared by pure and filled revolution. |
+| [SweepOptions](../SweepOptions.md) | Controls shared by pure mesh construction and filled modeling sweeps. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [LoftCorrespondence](../LoftCorrespondence.md) | Associates ordered loft contours without inferring component identities or repairing topology. |
+| [LoftPlacement](../LoftPlacement.md) | A horizontal XY station height, or an explicit right-handed spatial frame, never both. |
+| [LoftStation](../LoftStation.md) | A Section or point loop at an explicit height or frame. |
+| [PathNormalGuide](../PathNormalGuide.md) | Supplies a profile-X orientation guide for each original normalized sweep station. |
+| [SweepOrientation](../SweepOrientation.md) | Explicit profile-X frame policy; all normals are directed, and selected singular policies reject. |
+
+## Guides
+
+- [Revolve a radial profile](../../../guides/recipes.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../../guides/recipes.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../../guides/recipes.md#matched-section-loft)
+- [Choose a modeling path](../../../guides/concepts.md#choose-a-modeling-path)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/generation.md

@@ -0,0 +1,44 @@
+# Model generation
+
+Declare typed programs, optional computations, semantic parts and structured diagnostics.
+
+Start with `generate(({ params, part, assert }) => ...)` and return one `part(...)` or a readonly array of parts. Parameter values are ordinary readonly data. `computed(id, callback)` optionally caches pure data or geometry and tracks synchronous reads. List changing outer captures with `computed(id, () => ..., [value])`; dependency arrays supplement automatic tracking. Assertions stop immediately; warnings continue and must be emitted in the outer callback. Place finished parts with `position` in millimetres and fixed global XYZ `rotation` in degrees. Capture cached numeric arrays with `immutableBuffer` and indexed meshes with `immutableMesh`. Buffers expose only length, at(index), and copy(); snapshots still contain ordinary typed arrays.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [generate](../generate.md) | Defines a typed model without executing it. Use `computed` only for work worth reusing. |
+| [immutableBuffer](../immutableBuffer.md) | Copies numeric data once into private storage. This pure helper needs no active generation. |
+| [immutableMesh](../immutableMesh.md) | Copies mesh buffers into immutable data; geometric validation still occurs when modeling or finalizing. |
+
+## Classes
+
+| API | Summary |
+| --- | --- |
+| [GenerationError](../GenerationError.md) | A user-correctable assertion failure. Successful computation caches never retain failures. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [ImmutableBuffer](../ImmutableBuffer-type.md) | Owned immutable numeric data. Use copy() to obtain mutable storage for numerical work. |
+| [ImmutableTriangleMesh](../ImmutableTriangleMesh.md) | Immutable local XYZ positions and triangle indices, suitable for a computed value or part. |
+| [Computed](../Computed.md) | Reads immutable data or a deferred recipe; evaluation is synchronous and cached. |
+| [DiagnosticOptions](../DiagnosticOptions.md) | Typed parameter association for an assertion or warning. |
+| [GenerateContext](../GenerateContext.md) | The sole synchronous authoring context, supplied independently of Studio. |
+| [GeneratedPart](../GeneratedPart.md) | One declared output part. Construct with the context's `part` helper. |
+| [GenerationDiagnostic](../GenerationDiagnostic.md) | Structured user-facing issue associated with the attempted revision. |
+| [ModelProgram](../ModelProgram.md) | Stateless portable program descriptor. Execution and caches belong to an engine session. |
+| [PartOptions](../PartOptions.md) | Appearance and rigid placement of a finished local manufacturing part. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [NumericArray](../NumericArray.md) | Numeric storage supported by immutable generation buffers. |
+| [ComputedValue](../ComputedValue.md) | A value supplied immediately or by a lazy computed reader. |
+| [GenerateCallback](../GenerateCallback.md) | Pure synchronous callback returning one declared part or an array; caches are optional. |
+| [PartGeometry](../PartGeometry.md) | Manufacturing geometry; filled sections are intermediate construction values. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/inspection.md

@@ -0,0 +1,23 @@
+# Solid inspection
+
+Inspect and convert session-owned recipes while retaining host ownership.
+
+Inspection returns copied scalar facts and finite bounds. Mesh extraction is explicit; finalized engine output is already copied and validated. A handle belongs to one session and cannot cross a worker or be used after session disposal. components accepts either dimension; simplify is an immutable shape method. Solid.projectSection and Solid.sliceSection return Sections. isEmpty distinguishes empty Boolean/split results; distance measures the minimum separation between nonempty solids and returns zero for contact or overlapping material.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [components](../components.md) | Separates a solid's disconnected surface shells into same-session solid handles. |
+| [rayCast](../rayCast.md) | Copies intersections along the finite directed origin-to-endpoint segment. |
+| [toTriangleMesh](../toTriangleMesh.md) | Copies a handle to manufacturing mesh buffers. |
+| [isEmpty](../isEmpty.md) | Checks whether a same-session solid or filled section contains no geometry. |
+| [distance](../distance.md) | Measures the minimum separation between two nonempty solids in millimetres. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [SolidRayHit](../SolidRayHit.md) | Copied surface intersection from a finite directed segment. Distance is in millimetres. |
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/mesh-inspection.md

@@ -0,0 +1,29 @@
+# Mesh & Inspection
+
+Convert validated meshes and inspect stable section or solid measurements.
+
+inspectSection and inspectSolid copy native scalar facts and bounds from same-build handles. toTriangleMesh returns copied manufacturing arrays; final engine output also receives strict mesh analysis. Neither inspection certifies wall thickness, overhangs, printer fit or material behavior.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [inspectSection](../inspectSection.md) | Copies lightweight section measurements. |
+| [inspectSolid](../inspectSolid.md) | Reads immutable native facts once per solid; temporary components are owned by the build. |
+| [solidFromMesh](../solidFromMesh.md) | Imports a bounded closed indexed mesh. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [SectionInspection](../SectionInspection.md) | Immutable native filled section facts in millimetres and square millimetres. Repeated inspections of the same native shape share these facts within one revision. |
+| [SolidInspection](../SolidInspection.md) | Immutable solid bounds, emptiness, component count, volume, surface area and native tolerance. Repeated inspections of the same native shape share these facts within one revision. |
+| [TriangleMesh](../TriangleMesh.md) | A topology-preserving indexed triangle mesh with XYZ vertex positions. |
+| [TriangleMeshAnalysis](../TriangleMeshAnalysis.md) | Measurements and optional edge-connected topology from one validated mesh traversal. |
+| [TriangleMeshMeasurements](../TriangleMeshMeasurements.md) | Geometric measurements derived from a validated, non-empty triangle mesh. |
+
+## Guides
+
+- [Solid inspection](../../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/primitives.md

@@ -0,0 +1,61 @@
+# Primitives
+
+Create foundational solid geometry and configure its dimensions and tessellation.
+
+All primitives use millimetres and one options object. `box` accepts scalar or XYZ size; `cylinder` accepts exactly one radius or diameter, uniformly or as a bottom/top tuple along +Z. Radial sizing explicitly selects polygon vertices or compensated faces. Treatments share `{kind: "round", radius}`, `{kind: "chamfer", distance}`, `{kind: "smooth", distance}` and `{kind: "profile", profile}`; boxes may select named edges; cylinder and straight convex extrusion ends select independent bottom/top treatments. Boxes, cylinders and tubes are centered by default. `placement` maps a named or explicit local anchor onto a world anchor after shape construction.
+
+Use imported primitives inside generation:
+
+```ts
+import { box, cylinder, generate } from "@metamesh/modeling";
+export default generate(({ part }) => {
+  const plate = box({ size: [30, 20, 6], treatment: { kind: "chamfer", distance: 0.5 } });
+  const bore = cylinder({ radius: 3, height: 8, sizing: "face" });
+  return [part("plate", plate.subtract([bore]))];
+});
+``` Zero round radius or zero chamfer/smooth setbacks leave a feature untreated; setback tuples are either all zero or both positive.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [box](../box.md) | Axis-aligned box with uniform or disjoint named edge/group treatments. |
+| [cylinder](../cylinder.md) | +Z cylinder or frustum. Face sizing compensates polygon faceting. |
+| [sphere](../sphere.md) | Origin-centered sphere. |
+| [torus](../torus.md) | Torus around +Z. |
+| [tube](../tube.md) | Hollow +Z tube. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [Solid](../Solid.md) | Immutable deferred solid recipe belonging to exactly one model session. Methods run during synchronous generation, preserve their receiver, and use millimetres and degrees. A no-op may reuse the receiver; final part placement belongs in `part` options. |
+| [BoxOptions](../BoxOptions.md) | Dimensions, placement, and uniform or independently selected finishing for an axis-aligned box. |
+| [ChamferedEdgeTreatment](../ChamferedEdgeTreatment.md) | A planar edge or corner chamfer with equal or independent surface setbacks. |
+| [CircularPrimitiveOptions](../CircularPrimitiveOptions.md) | Tessellation controls shared by circular primitives across Geometry entry points. |
+| [EndTreatments](../EndTreatments.md) | Independent inward finishing on primitive or straight convex extrusion ends. Zero amounts leave the end untreated, including when all ends are disabled. |
+| [RadialSizingOptions](../RadialSizingOptions.md) | Nominal radial sizing shared by circular and regular polygon construction. |
+| [RoundedEdgeTreatment](../RoundedEdgeTreatment.md) | A circular edge or corner roundover with explicit physical sampling. |
+| [TorusOptions](../TorusOptions.md) | Dimensions and independent ring/profile tessellation for a torus around the Z axis. |
+| [TubeOptions](../TubeOptions.md) | Dimensions, placement, and tessellation for a hollow Z-axis tube. |
+| [SmoothEdgeTreatment](../SmoothEdgeTreatment.md) | A cubic corner transition with zero curvature at its straight tangent joins. |
+| [ProfiledEdgeTreatment](../ProfiledEdgeTreatment.md) | A deliberately sampled, inward-only corner profile with exact polyline geometry. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [CylinderOptions](../CylinderOptions.md) | Dimensions, placement, independent end finishing, and tessellation for a Z-axis cylinder or frustum. |
+| [EdgeTreatment](../EdgeTreatment.md) | Uniform finishing vocabulary shared by applicable solid edges and profile corners. |
+| [RadialSizing](../RadialSizing.md) | Radial dimensions refer to polygon vertices or compensate faceting to meet polygon faces. |
+| [SphereOptions](../SphereOptions.md) | Exactly one radius or diameter, placement, and tessellation for an origin-centered sphere. |
+| [BoxEdge](../BoxEdge.md) | Box edges use +Z top, +Y front and +X right; vertical names list front/back first. |
+| [BoxEdgeSelection](../BoxEdgeSelection.md) | Named individual edges or top/bottom rims and all four vertical edges. |
+| [BoxEdgeTreatments](../BoxEdgeTreatments.md) | Independent treatments for disjoint named edge selections; overlapping selections fail. |
+
+## Guides
+
+- [Choose a primitive](../../../guides/recipes.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../../guides/recipes.md#treated-boxes-frustums-and-mirrored-arrays)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/resolution.md

@@ -0,0 +1,18 @@
+# Local resolution
+
+Choose physical curve sampling and explicit native tolerance.
+
+Exact operation counts take precedence over the operation’s resolution policy, followed by host session defaults. Pass resolution explicitly to each affected constructor or Section operation. Solid.setTolerance changes native geometric tolerance on an immutable copy; it does not select curve sampling.
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [GeometryResolution](../GeometryResolution.md) | Tessellation policy for sampled geometry measured in millimetres. |
+| [GeometryToleranceOptions](../GeometryToleranceOptions.md) | Optional overrides for MetaMesh's geometry comparison policy. |
+
+## Guides
+
+- [Coordinates, units, and resolution](../../../guides/concepts.md#coordinates-units-and-resolution)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/sections.md

@@ -0,0 +1,59 @@
+# 2D Sections
+
+Create native filled XY sections, including prepared text and bounded painted SVG.
+
+A Section is a filled native XY shape with holes and disconnected components. rectangle, circle, ellipse, regularPolygon and star take object options. Boolean and offset chains stay native until an explicit toRegion conversion. textSection consumes prepared VectorTextLayout without shaping again. Extrusion and revolution preserve filled topology; sweeps retain all contours. Compatible primitive Sections retain their authored landmarks for direct lofting; arbitrary Sections require explicit vertex correspondence. `polygon(points)` fills a single implicit closed contour. `polygon({ outer, holes })` validates explicit topology; `polygon({ contours, fillRule })` resolves compound winding with nonzero fill by default or evenodd fill. All forms return a Section.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [circle](../circle.md) | Centered circular section. |
+| [ellipse](../ellipse.md) | Centered elliptical section. |
+| [fromRegion](../fromRegion.md) | Imports explicit region topology once. |
+| [rectangle](../rectangle.md) | Filled rectangular section with uniform or independently treated corners. |
+| [regularPolygon](../regularPolygon.md) | Regular polygon with a vertex on +X. |
+| [polygon](../polygon.md) | Fills one closed millimetre XY outline, explicit outer/hole topology, or compound contours. Closing edges are implicit. Compound contours use nonzero fill unless selected otherwise. Explicit topology must be simple and disjoint; compound winding may resolve overlaps. |
+| [star](../star.md) | Alternating outer/inner star vertices. |
+| [svgPathSection](../svgPathSection.md) | Imports bounded filled SVG path data. |
+| [svgSection](../svgSection.md) | Imports bounded painted SVG document geometry. |
+| [textSection](../textSection.md) | Consumes a previously prepared layout; never shapes or fetches a font. |
+| [toRegion](../toRegion.md) | Explicit copied topology inspection; not needed for section operations. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [Section](../Section.md) | Immutable deferred filled XY section recipe belonging to exactly one model session. Methods run during synchronous generation and preserve their receiver. Distances use millimetres; rotations are counterclockwise degrees about the origin. Construction uses the session resolution unless the operation supplies explicit options. |
+| [RectangleContourOptions](../RectangleContourOptions.md) | Shared rectangle dimensions, origin and uniform or per-corner treatment. |
+| [RectangleOptions](../RectangleOptions.md) | Rectangle dimensions, placement and uniform or per-corner treatment. |
+| [RegionOffsetOptions](../RegionOffsetOptions.md) | Options controlling robust Clipper2 region offsets. |
+| [StarOptions](../StarOptions.md) | Alternating outer and inner vertices, centered on the XY origin. |
+| [SvgPathSectionOptions](../SvgPathSectionOptions.md) | Bounded filled SVG path sampling. Path scale converts user units to millimetres. |
+| [SvgSectionOptions](../SvgSectionOptions.md) | Bounded SVG document sampling. Center origin uses the final painted bounds. |
+| [TextSectionOptions](../TextSectionOptions.md) | Physical curve sampling applied to already prepared vector text. |
+| [VectorTextLayout](../VectorTextLayout.md) | Immutable vector layout with no browser, font parser, or kernel ownership. |
+| [VectorTextMetrics](../VectorTextMetrics.md) | Text measurements from the same immutable layout that supplies geometry and SVG outlines. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [CircleContourOptions](../CircleContourOptions.md) | Circular profile dimensions with exactly one radius or diameter and explicit sampling. |
+| [CircleOptions](../CircleOptions.md) | Circular dimensions with exactly one nominal radius or diameter. |
+| [EllipseContourOptions](../EllipseContourOptions.md) | Ellipse dimensions with exactly one XY radii or full-size tuple and explicit sampling. |
+| [EllipseOptions](../EllipseOptions.md) | Ellipse dimensions in local XY, with exactly one radii or full-size tuple. |
+| [RectangleCornerTreatment](../RectangleCornerTreatment.md) | A rectangle corner, including an explicitly untreated corner in a treatment tuple. |
+| [RectangleCornerTreatments](../RectangleCornerTreatments.md) | Corner treatments ordered top-right, top-left, bottom-left, bottom-right. |
+| [RegularPolygonOptions](../RegularPolygonOptions.md) | Regular polygon dimensions, radial convention and degree rotation. |
+| [RegionOffsetJoin](../RegionOffsetJoin.md) | Clipper2 join styles accepted by robust region offsets. |
+| [PolygonOptions](../PolygonOptions.md) | Explicit polygon topology or compound contours; all closing edges are implicit. |
+| [SvgOrigin](../SvgOrigin.md) | Placement of painted SVG geometry after SVG Y-axis inversion. |
+
+## Guides
+
+- [Section, hole, offset, and extrusion](../../../guides/recipes.md#section-hole-offset-and-extrusion)
+- [SVG sections: fills and strokes are different inputs](../../../guides/concepts.md#svg-sections-fills-and-strokes-are-different-inputs)
+- [Text and font variability](../../../guides/concepts.md#text-and-font-variability)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/threads.md

@@ -0,0 +1,50 @@
+# Printable threads
+
+Construct compensated thread forms and inspect allocation-free preflight facts.
+
+Thread pitch is adjacent axial spacing; lead equals pitch times starts. Prepare shared thread dimensions once. Constructors enforce safety automatically; optional preflight provides resource estimates or early control-specific validation. Native rods, internal cutters, and nuts share printable fit and end-treatment options. These forms do not certify a structural rating or a metrology class.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [internalThreadCutter](../internalThreadCutter.md) | Compensated internal threaded cutter. |
+| [preflightInternalThreadCutter](../preflightInternalThreadCutter.md) | Allocation-free internal-thread facts. |
+| [preflightThreadedNut](../preflightThreadedNut.md) | Allocation-free nut/cutter facts. |
+| [preflightThreadedRod](../preflightThreadedRod.md) | Allocation-free external-thread facts. |
+| [threadedNut](../threadedNut.md) | Compensated threaded nut. |
+| [threadedRod](../threadedRod.md) | Compensated external threaded rod. |
+| [threadRidge](../threadRidge.md) | Helical ridge mesh construction. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [HelicalThreadRidgeMeshOptions](../HelicalThreadRidgeMeshOptions.md) | Runtime-neutral options for the dedicated helical ridge mesher. |
+| [HelicalThreadSolidMeshPreflight](../HelicalThreadSolidMeshPreflight.md) | Conservative allocation facts resolved before constructing a direct thread solid mesh. |
+| [InternalThreadCutterOptions](../InternalThreadCutterOptions.md) | Options for a compensated internal-thread subtraction tool along +Z. |
+| [PrintableThreadFitPolicy](../PrintableThreadFitPolicy.md) | Explicit radial and axial allowances for a mating printed thread pair. |
+| [ThreadedNutOptions](../ThreadedNutOptions.md) | Options for a compensated nut with an internal thread. |
+| [ThreadedNutPreflight](../ThreadedNutPreflight.md) | Allocation-free body, cutter, and end-face facts resolved for a threaded nut. |
+| [ThreadedRodOptions](../ThreadedRodOptions.md) | Options for a compensated external threaded rod along +Z. |
+| [ThreadEndTreatmentOptions](../ThreadEndTreatmentOptions.md) | Axial end controls for a generated ridge. |
+| [ThreadProfile](../ThreadProfile.md) | A validated immutable periodic thread profile in `[axial, radial]` millimetres. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [PrintableThreadFit](../PrintableThreadFit.md) | Named baseline fit policies for calibrated FDM-style printed threads. |
+| [ThreadedNutBevel](../ThreadedNutBevel.md) | Nut-edge bevel selection. |
+| [ThreadedNutShape](../ThreadedNutShape.md) | Supported printable nut body shapes. |
+| [ThreadEndStyle](../ThreadEndStyle.md) | End shape of a generated helical ridge. |
+| [ThreadHandedness](../ThreadHandedness.md) | Direction in which a conventional helical thread advances around +Z. |
+| [ThreadLeadInEnvelope](../ThreadLeadInEnvelope.md) | Radial envelope toward which a blunt lead-in collapses. |
+| [ThreadLeadInShape](../ThreadLeadInShape.md) | BOSL2-compatible cross-section scaling curve for a blunt thread lead-in. |
+| [ThreadRidgeOptions](../ThreadRidgeOptions.md) | Parameters for a helical ridge before solid construction. |
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/model/categories/transforms-placement.md

@@ -0,0 +1,43 @@
+# Transforms & Placement
+
+Transform 2D sections and 3D solids; arrange and attach solids with explicit placement contracts.
+
+Solid and Section methods translate, rotate, scale, mirror and transform return immutable same-dimensional recipes. Sections use XY vectors and counterclockwise degree rotations; solids use XYZ vectors and degree Euler angles. Calls apply in written order about the origin: translating then rotating also rotates the translated position. Transform2 and Transform3 are row-major affine matrices. Solid.attach and primitive placement share source/target anchors, alignment, millimetre gap and degree spin. withAnchors adds explicit datums to either shape. Patterns return same-session Solid or Section arrays; Section placements must preserve XY. Pure *PatternTransforms expose matching placements from /geometry. Place completed parts through part options so placement can reuse geometry.
+
+## Functions
+
+| API | Summary |
+| --- | --- |
+| [anchor](../anchor.md) | Reads a copied, immutable named anchor from this exact active generation. |
+| [gridPattern](../gridPattern.md) | XY or XYZ copies, optionally centered or placed in an explicit frame. |
+| [linearPattern](../linearPattern.md) | Repeats one solid along a normalized direction. |
+| [pathPattern](../pathPattern.md) | Physical arc-length copies along a sampled path, with optional tangent orientation. |
+| [radialPattern](../radialPattern.md) | Repeats one solid about an axis. |
+
+## Interfaces
+
+| API | Summary |
+| --- | --- |
+| [Anchor3](../Anchor3.md) | An attachment pose on a solid or assembly. |
+| [AttachOptions](../AttachOptions.md) | Degree-based anchor attachment controls for a scoped solid. |
+| [PathPatternOptions](../PathPatternOptions.md) | Equal physical arc-length placements along an open or implicitly closed sampled path. |
+| [PrimitivePlacement](../PrimitivePlacement.md) | Placement shared by solid and filled-section factories. |
+| [PrimitivePlacementOptions](../PrimitivePlacementOptions.md) | Maps an explicit or named shape-local attachment anchor onto a world-space anchor. |
+| [RadialPatternOptions](../RadialPatternOptions.md) | Options for repeating one solid around an axis through a center point. |
+
+## Type aliases
+
+| API | Summary |
+| --- | --- |
+| [GridPatternOptions](../GridPatternOptions.md) | XY or XYZ grid with X varying fastest. The first item starts at the local origin. |
+| [LinearPatternOptions](../LinearPatternOptions.md) | Equal linear intervals determined by exactly two of count, spacing and total length. |
+| [PatternSource](../PatternSource.md) | One same-session shape, or a synchronous factory called once per copy in index order. |
+| [Transform2](../Transform2.md) | Row-major affine XY matrix. Translation occupies m02/m12; final row is [0, 0, 1]. |
+| [Transform3](../Transform3.md) | A row-major affine 4x4 matrix applied to column vectors. |
+
+## Guides
+
+- [Named anchors and custom frames](../../../guides/recipes.md#named-anchors-and-custom-frames)
+- [Primitive booleans and repeated placement](../../../guides/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.13.0`.