@metamesh/modeling 0.19.0 → 0.20.0

package/dist/docs/reference/{geometry → model}/LoftOptions.md

@@ -48,7 +48,7 @@ Positive integer point-density multiplier, uniformly or per input profile. Origi
 
 
 
-Nonnegative count of world-linearly interpolated profiles, uniformly or per gap. Defaults to zero.
+Positive longitudinal interval count, uniformly or per supplied station gap. Each gap with n slices has n - 1 inserted profiles. Defaults to one; placed world vertices interpolate linearly.
 
 ***
 
@@ -56,7 +56,7 @@ Nonnegative count of world-linearly interpolated profiles, uniformly or per gap.
 
 
 
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+`readonly` `optional` **resolution?**: [`GeometryResolution`](../geometry/GeometryResolution.md)
 
 
 
@@ -68,7 +68,7 @@ Physical curve policy for retained primitives, and maximum edge length for point
 
 
 
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](../geometry/ModelingLimits.md)\>
 
 
 
@@ -77,26 +77,21 @@ Explicit output and sampling budgets; native operations may only lower host ceil
 
 ## Related APIs
 
-- [GeometryResolution](GeometryResolution.md)
 - [LoftCorrespondence](LoftCorrespondence.md)
-- [ModelingLimits](ModelingLimits.md)
 
 ## Guides
 
-- [Exact counts and preflight guarantees](../../guides/resolution-and-inspection.md#check-preflight-guarantees)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Chamfer a twisted extrusion](../../guides/profiles-and-extrusion.md#chamfer-a-twisted-extrusion)
+- [Revolve a radial profile](../../guides/profiles-and-extrusion.md#revolve-a-radial-profile)
+- [Rotation-minimizing path sweep](../../guides/sweeps-and-lofts.md#rotation-minimizing-path-sweep)
+- [Matched-section loft](../../guides/sweeps-and-lofts.md#matched-section-loft)
+- [Choose a modeling path](../../guides/recipes.md#choose-a-technique)
 
-## Supported imports
+## Import
 
 ```ts
 import type { LoftOptions } from "@metamesh/modeling";
 ```
 
-```ts
-import type { LoftOptions } from "@metamesh/modeling/geometry";
-```
-
-```ts
-import * as mesh from "@metamesh/modeling/geometry/mesh";
-```
-
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,6 +1,6 @@
 # LoftStation
 
-A Section or point loop at an explicit height or frame.
+A Section or point loop at a horizontal height or explicit affine transform.
 
 **LoftStation** = [`LoftPlacement`](../geometry/LoftPlacement.md) & `object`
 
@@ -21,22 +21,21 @@ Filled Section recipe or ordered XY boundary point data.
 
 ## Related APIs
 
-- [LoftPlacement](../geometry/LoftPlacement.md)
-- [Path2Input](../geometry/Path2Input.md)
 - [Section](Section.md)
 
 ## Guides
 
 - [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Chamfer a twisted extrusion](../../guides/profiles-and-extrusion.md#chamfer-a-twisted-extrusion)
 - [Revolve a radial profile](../../guides/profiles-and-extrusion.md#revolve-a-radial-profile)
 - [Rotation-minimizing path sweep](../../guides/sweeps-and-lofts.md#rotation-minimizing-path-sweep)
 - [Matched-section loft](../../guides/sweeps-and-lofts.md#matched-section-loft)
 - [Choose a modeling path](../../guides/recipes.md#choose-a-technique)
 
-## Supported imports
+## Import
 
 ```ts
 import type { LoftStation } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -45,10 +45,10 @@ Eagerly reuses pure synchronous functions by function identity and immutable arg
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-## Supported imports
+## Import
 
 ```ts
 import type { Memo } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -45,10 +45,10 @@ Typed synchronous declaration callback.
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-## Supported imports
+## Import
 
 ```ts
 import type { ModelProgram } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -45,7 +45,7 @@ Local manufacturing geometry; native objects never cross a revision.
 
 
 Rigid local-to-world transform; translation uses millimetres. Defaults to identity.
-Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
+Accepts a Frame3, fluent transform, or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
 
 #### Inherited from
 
@@ -61,7 +61,7 @@ Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection
 
 
 
-Optional six-digit hexadecimal semantic part color.
+Optional six-digit hexadecimal display color.
 
 #### Inherited from
 
@@ -72,16 +72,15 @@ Optional six-digit hexadecimal semantic part color.
 
 - [PartGeometry](PartGeometry.md)
 - [PartOptions](PartOptions.md)
-- [Transform3Input](../geometry/Transform3Input.md)
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PartDeclaration } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -2,25 +2,23 @@
 
 Manufacturing geometry; filled sections are intermediate construction values.
 
-**PartGeometry** = [`Solid`](Solid.md) \| [`TriangleMesh`](../geometry/TriangleMesh.md) \| [`ImmutableTriangleMesh`](../geometry/ImmutableTriangleMesh.md)
+**PartGeometry** = [`Solid`](Solid.md) \| [`TriangleMesh`](../mesh/TriangleMesh.md) \| [`ImmutableTriangleMesh`](../mesh/ImmutableTriangleMesh.md)
 
 
 
 
 ## Related APIs
 
-- [ImmutableTriangleMesh](../geometry/ImmutableTriangleMesh.md)
 - [Solid](Solid.md)
-- [TriangleMesh](../geometry/TriangleMesh.md)
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PartGeometry } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -29,7 +29,7 @@ Local manufacturing geometry; native objects never cross a revision.
 
 
 Rigid local-to-world transform; translation uses millimetres. Defaults to identity.
-Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
+Accepts a Frame3, fluent transform, or row-major 4x4 matrix. Scale, shear, and reflection are invalid.
 
 ***
 
@@ -41,23 +41,22 @@ Accepts a fluent transform or row-major 4x4 matrix. Scale, shear, and reflection
 
 
 
-Optional six-digit hexadecimal semantic part color.
+Optional six-digit hexadecimal display color.
 
 
 ## Related APIs
 
 - [PartDeclaration](PartDeclaration.md)
 - [PartGeometry](PartGeometry.md)
-- [Transform3Input](../geometry/Transform3Input.md)
 
 ## Guides
 
 - [Complete standalone model example](../../guides/standalone-model.md#minimal-model-entry)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PartOptions } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,6 +1,6 @@
 # PatternSource
 
-One immutable shape, or a synchronous factory called once per copy in index order.
+One immutable shape, or a synchronous factory called once per copy in zero-based index order.
 
 **PatternSource**\<`T` *extends* [`Solid`](Solid.md) \| [`Section`](Section.md) = [`Solid`](Solid.md)\> = `T` \| ((`index`: `number`) => `T`)
 
@@ -22,12 +22,12 @@ One immutable shape, or a synchronous factory called once per copy in index orde
 
 - [Named anchors and custom frames](../../guides/transforms-and-placement.md#named-anchors-and-custom-frames)
 - [Primitive booleans and repeated placement](../../guides/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
-- [Fluent values and standalone algorithms](../../guides/geometry-values.md#choose-fluent-values-or-standalone-algorithms)
+- [Fluent values and standalone algorithms](../../guides/geometry-values.md#fluent-values-plain-data-and-descriptors)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PatternSource } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -1,6 +1,6 @@
 # PlaneOptions
 
-A world-space cutting plane, retaining the half-space in the normal's direction.
+A world-space cutting plane defined by a normal and signed millimetre offset.
 
 ## Properties
 
@@ -27,20 +27,16 @@ Finite nonzero plane normal; magnitude does not affect the plane.
 Signed millimetre distance from the origin along the unit normal. Defaults to zero.
 
 
-## Related APIs
-
-- [Vector3Input](../geometry/Vector3Input.md)
-
 ## 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/transforms-and-placement.md#primitive-booleans-and-repeated-placement)
 - [Join an independently modeled feature](../../guides/solid-joins.md#join-an-independently-modeled-feature)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PlaneOptions } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -175,21 +175,16 @@ Serialized topology excludes compound contours.
 Serialized polygons define fill explicitly.
 
 
-## Related APIs
-
-- [Path2Input](../geometry/Path2Input.md)
-- [RegionData](../geometry/RegionData.md)
-
 ## Guides
 
 - [Section, hole, offset, and extrusion](../../guides/profiles-and-extrusion.md#section-hole-offset-and-extrusion)
 - [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
 - [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
 
-## Supported imports
+## Import
 
 ```ts
 import type { PolygonOptions } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -0,0 +1,50 @@
+# PrimitiveAttachment
+
+Anchor attachment shared by solid and filled-section factories.
+
+## Extended by
+
+- [`BoxOptions`](BoxOptions.md)
+- [`CornerCutterOptions`](CornerCutterOptions.md)
+- [`EdgeCutterOptions`](EdgeCutterOptions.md)
+- [`RectangleOptions`](RectangleOptions.md)
+- [`StarOptions`](StarOptions.md)
+- [`TorusOptions`](TorusOptions.md)
+
+## Properties
+
+### attachment?
+
+
+
+`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
+
+
+
+Applied after local construction; Section attachment must preserve the XY plane.
+
+
+## Related APIs
+
+- [BoxOptions](BoxOptions.md)
+- [CornerCutterOptions](CornerCutterOptions.md)
+- [EdgeCutterOptions](EdgeCutterOptions.md)
+- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
+- [RectangleOptions](RectangleOptions.md)
+- [StarOptions](StarOptions.md)
+- [TorusOptions](TorusOptions.md)
+
+## Guides
+
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Shape openings and local edges](../../guides/profiles-and-extrusion.md#shape-openings-and-local-edges)
+
+## Import
+
+```ts
+import type { PrimitiveAttachment } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -0,0 +1,111 @@
+# PrimitiveAttachmentOptions
+
+Maps an explicit or named shape-local attachment anchor onto a world-space anchor.
+
+## Extends
+
+- [`AttachOptions`](../geometry/AttachOptions.md)
+
+## Properties
+
+### alignment?
+
+
+
+`readonly` `optional` **alignment?**: `"opposed"` \| `"same"`
+
+
+
+Align outward directions face-to-face (`opposed`) or in parallel (`same`).
+
+#### Inherited from
+
+[`AttachOptions`](../geometry/AttachOptions.md).[`alignment`](../geometry/AttachOptions.md#alignment)
+
+***
+
+### gap?
+
+
+
+`readonly` `optional` **gap?**: `number`
+
+
+
+Separation along the target anchor's outward direction in model units.
+
+#### Inherited from
+
+[`AttachOptions`](../geometry/AttachOptions.md).[`gap`](../geometry/AttachOptions.md#gap)
+
+***
+
+### spin?
+
+
+
+`readonly` `optional` **spin?**: `number`
+
+
+
+Additional right-handed roll about the attached direction, in degrees.
+
+#### Inherited from
+
+[`AttachOptions`](../geometry/AttachOptions.md).[`spin`](../geometry/AttachOptions.md#spin)
+
+***
+
+### tolerance?
+
+
+
+`readonly` `optional` **tolerance?**: [`GeometryToleranceOptions`](../geometry/GeometryToleranceOptions.md)
+
+
+
+Optional numeric comparison overrides.
+
+#### Inherited from
+
+[`AttachOptions`](../geometry/AttachOptions.md).[`tolerance`](../geometry/AttachOptions.md#tolerance)
+
+***
+
+### source
+
+
+
+`readonly` **source**: `string` \| [`Anchor3`](../geometry/Anchor3-type.md)
+
+
+
+Shape-local source frame or a named primitive anchor such as bottom.
+
+***
+
+### target
+
+
+
+`readonly` **target**: [`Anchor3`](../geometry/Anchor3-type.md)
+
+
+
+World-space target frame in millimetres.
+
+
+## Guides
+
+- [Choose a primitive](../../guides/profiles-and-extrusion.md#choose-a-primitive)
+- [Treated boxes, frustums, and mirrored arrays](../../guides/profiles-and-extrusion.md#treated-boxes-frustums-and-mirrored-arrays)
+- [Finish a profile with a hole](../../guides/profiles-and-extrusion.md#finish-a-profile-with-a-hole)
+- [Shape openings and local edges](../../guides/profiles-and-extrusion.md#shape-openings-and-local-edges)
+
+## Import
+
+```ts
+import type { PrimitiveAttachmentOptions } from "@metamesh/modeling";
+```
+
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -5,26 +5,10 @@ Rectangle dimensions, placement and uniform or per-corner treatment.
 ## Extends
 
 - [`RectangleContourOptions`](../geometry/RectangleContourOptions.md)
-- [`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md)
+- [`PrimitiveAttachment`](PrimitiveAttachment.md)
 
 ## Properties
 
-### attachment?
-
-
-
-`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](../geometry/PrimitiveAttachmentOptions.md)
-
-
-
-Applied after local construction; Section attachment must preserve the XY plane.
-
-#### Inherited from
-
-[`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md).[`attachment`](../geometry/PrimitiveAttachment.md#attachment)
-
-***
-
 ### size
 
 
@@ -87,16 +71,27 @@ Explicit sampling ceiling for the complete output profile.
 
 [`RectangleContourOptions`](../geometry/RectangleContourOptions.md).[`limits`](../geometry/RectangleContourOptions.md#limits)
 
+***
+
+### attachment?
+
+
+
+`readonly` `optional` **attachment?**: [`PrimitiveAttachmentOptions`](PrimitiveAttachmentOptions.md)
+
+
+
+Applied after local construction; Section attachment must preserve the XY plane.
+
+#### Inherited from
+
+[`PrimitiveAttachment`](PrimitiveAttachment.md).[`attachment`](PrimitiveAttachment.md#attachment)
+
 
 ## Related APIs
 
-- [EdgeTreatment](../geometry/EdgeTreatment.md)
-- [GeometrySamplingLimits](../geometry/GeometrySamplingLimits.md)
-- [PrimitiveAttachment](../geometry/PrimitiveAttachment.md)
-- [PrimitiveAttachmentOptions](../geometry/PrimitiveAttachmentOptions.md)
-- [RectangleContourOptions](../geometry/RectangleContourOptions.md)
-- [RectangleCornerTreatments](../geometry/RectangleCornerTreatments.md)
-- [Vector2Input](../geometry/Vector2Input.md)
+- [PrimitiveAttachment](PrimitiveAttachment.md)
+- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.md)
 
 ## Guides
 
@@ -104,10 +99,10 @@ Explicit sampling ceiling for the complete output profile.
 - [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
 - [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
 
-## Supported imports
+## Import
 
 ```ts
 import type { RectangleOptions } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.

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

@@ -2,47 +2,14 @@
 
 Regular polygon dimensions, radial convention and degree rotation.
 
-**RegularPolygonOptions** = [`RadialSizingOptions`](../geometry/RadialSizingOptions.md) & [`PrimitiveAttachment`](../geometry/PrimitiveAttachment.md) & `object`
+**RegularPolygonOptions** = [`RegularPolygonContourOptions`](../geometry/RegularPolygonContourOptions.md) & [`PrimitiveAttachment`](PrimitiveAttachment.md)
 
 
 
-## Type Declaration
-
-### radius
-
-
-
-`readonly` **radius**: `number`
-
-
-
-Positive nominal radius in millimetres, interpreted according to sizing.
-
-### sides
-
-
-
-`readonly` **sides**: `number`
-
-
-
-Exact integer side count from three through 100000.
-
-### rotation?
-
-
-
-`readonly` `optional` **rotation?**: `number`
-
-
-
-Counterclockwise rotation in degrees; defaults to zero with a vertex on +X.
-
 
 ## Related APIs
 
-- [PrimitiveAttachment](../geometry/PrimitiveAttachment.md)
-- [RadialSizingOptions](../geometry/RadialSizingOptions.md)
+- [PrimitiveAttachment](PrimitiveAttachment.md)
 
 ## Guides
 
@@ -50,10 +17,10 @@ Counterclockwise rotation in degrees; defaults to zero with a vertex on +X.
 - [SVG sections: fills and strokes are different inputs](../../guides/svg-and-text.md#svg-sections-fills-and-strokes-are-different-inputs)
 - [Text and font variability](../../guides/svg-and-text.md#text-and-font-variability)
 
-## Supported imports
+## Import
 
 ```ts
 import type { RegularPolygonOptions } from "@metamesh/modeling";
 ```
 
-Package: `@metamesh/modeling@0.19.0`.
+Package: `@metamesh/modeling@0.20.0`.