@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,490 @@
+# Section
+
+Immutable deferred filled XY section recipe. Construction and composition require no engine. Ordinary recipes may be reused across sessions regardless of where constructed. Observed components and recipes using them can only be evaluated in their originating session. Methods leave the source unchanged; observations require a synchronous model execution. Distances use millimetres; rotations use counterclockwise degrees. Explicit resolution settings are captured; unspecified settings inherit the evaluating host's defaults.
+
+## Example: Extrude an outline with a border
+
+```ts
+const body = rectangle({ size: [20, 12] })
+  .subtract([rectangle({ size: [16, 8] })])
+  .offset(0.5)
+  .extrude({ height: 4 });
+```
+
+## Properties
+
+### \[sectionBrand\]
+
+
+
+`readonly` **\[sectionBrand\]**: `"Section"`
+
+
+
+Compile-time identity brand for an immutable filled section recipe.
+
+## Methods
+
+### translate()
+
+
+
+**translate**(`offset`: [`Vector2Input`](Vector2Input.md)): `Section`
+
+
+
+Translates XY coordinates in millimetres.
+
+#### Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### rotate()
+
+
+
+**rotate**(`degrees`: `number`, `options?`: [`Pivot2Options`](Pivot2Options.md)): `Section`
+
+
+
+Rotates counterclockwise in degrees.
+`options.pivot` is a fixed world-space point; omission uses the coordinate origin.
+
+#### Parameters
+
+<a id="degrees"></a>
+
+**`degrees`** · `number` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
+
+- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### scale()
+
+
+
+**scale**(`factors`: `number` \| [`Vector2Input`](Vector2Input.md), `options?`: [`Pivot2Options`](Pivot2Options.md)): `Section`
+
+
+
+Uniform or per-axis nonsingular scaling; negative factors reflect geometry.
+`options.pivot` is a fixed world-space point; omission uses the coordinate origin.
+
+#### Parameters
+
+<a id="factors"></a>
+
+**`factors`** · `number` \| [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+<a id="options-1"></a>
+
+**`options`** · [`Pivot2Options`](Pivot2Options.md) · Optional
+
+- [`pivot`](Pivot2Options.md#pivot) · [`Vector2Input`](Vector2Input.md) · Optional
+
+  World-space point left fixed by rotation or scaling.
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### mirror()
+
+
+
+**mirror**(`normal`: [`Vector2Input`](Vector2Input.md)): `Section`
+
+
+
+Reflection across an origin line/plane.
+
+#### Parameters
+
+<a id="normal"></a>
+
+**`normal`** · [`Vector2Input`](Vector2Input.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### transform()
+
+
+
+**transform**(`placement`: [`Transform2Input`](Transform2Input.md)): `Section`
+
+
+
+Applies a reusable XY placement or canonical row-major matrix.
+
+#### Parameters
+
+<a id="placement"></a>
+
+**`placement`** · [`Transform2Input`](Transform2Input.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### toRegionData()
+
+
+
+**toRegionData**(): [`RegionData`](RegionData.md)
+
+
+
+Copies canonical filled polygons for interchange; requires an active model execution.
+
+#### Returns
+
+[`RegionData`](RegionData.md)
+
+***
+
+### subtract()
+
+
+
+**subtract**(`cutters`: readonly `Section`[]): `Section`
+
+
+
+Native section difference; an empty cutter array preserves the source.
+
+#### Parameters
+
+<a id="cutters"></a>
+
+**`cutters`** · readonly `Section`[] · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### simplify()
+
+
+
+**simplify**(`tolerance`: `number`): `Section`
+
+
+
+Simplifies filled 2D contours using an explicit positive millimetre tolerance.
+
+Useful for dense imported outlines before extrusion. This changes the outline rather
+than selecting a lower rendering quality; fine features may be removed.
+
+#### Parameters
+
+<a id="tolerance"></a>
+
+**`tolerance`** · `number` · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### withAnchors()
+
+
+
+**withAnchors**(`anchors`: `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\>): `Section`
+
+
+
+Returns a new recipe with copied named anchors; existing names may be replaced.
+
+#### Parameters
+
+<a id="anchors"></a>
+
+**`anchors`** · `Readonly`\<`Record`\<`string`, [`Anchor3`](Anchor3.md)\>\> · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### offset()
+
+
+
+**offset**(`distance`: `number`, `options?`: [`SectionOffsetOptions`](SectionOffsetOptions.md)): `Section`
+
+
+
+Native millimetre offset preserving holes.
+
+#### Parameters
+
+<a id="distance"></a>
+
+**`distance`** · `number` · Required
+
+
+
+<a id="options-2"></a>
+
+**`options`** · [`SectionOffsetOptions`](SectionOffsetOptions.md) · Optional
+
+- [`circularSegments`](SectionOffsetOptions.md#circularsegments) · `number` · Optional
+
+  Number of segments per full circle for round joins.
+
+- [`join`](SectionOffsetOptions.md#join) · [`SectionOffsetJoin`](SectionOffsetJoin.md) · Optional
+
+  Corner treatment; defaults to `round`.
+
+- [`miterLimit`](SectionOffsetOptions.md#miterlimit) · `number` · Optional
+
+  Maximum miter extension in offset-distance multiples; at least two.
+
+- [`resolution`](SectionOffsetOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### extrude()
+
+
+
+**extrude**(`options`: [`ExtrudeOptions`](ExtrudeOptions.md)): [`Solid`](Solid.md)
+
+
+
+Extrudes along +Z with degree twist and top scaling.
+
+#### Parameters
+
+<a id="options-3"></a>
+
+**`options`** · [`ExtrudeOptions`](ExtrudeOptions.md) · Required
+
+- [`height`](ExtrudeOptions.md#height) · `number` · Required
+
+  Positive extrusion height in millimetres.
+
+- [`center`](ExtrudeOptions.md#center) · `boolean` · Optional
+
+  Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
+
+- [`ends`](ExtrudeOptions.md#ends) · [`EndTreatments`](EndTreatments.md) · Optional
+
+  Independent inward end treatments on straight convex single-contour extrusions.
+
+- [`divisions`](ExtrudeOptions.md#divisions) · `number` · Optional
+
+  Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+
+- [`limits`](ExtrudeOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+- [`resolution`](ExtrudeOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical policy over the nearest model scope.
+
+- [`scaleTop`](ExtrudeOptions.md#scaletop) · `number` \| [`Vector2Tuple`](Vector2Tuple.md) · Optional
+
+  Finite uniform or XY scale of the top profile; defaults to one.
+
+- [`twistDegrees`](ExtrudeOptions.md#twistdegrees) · `number` · Optional
+
+  Finite rotation of the top profile about +Z, in degrees; defaults to zero.
+
+
+
+#### Returns
+
+[`Solid`](Solid.md)
+
+***
+
+### revolve()
+
+
+
+**revolve**(`options?`: [`RevolveOptions`](RevolveOptions.md)): [`Solid`](Solid.md)
+
+
+
+Revolves a filled radial/Z shape around +Z, with caps for partial sweeps.
+
+#### Parameters
+
+<a id="options-4"></a>
+
+**`options`** · [`RevolveOptions`](RevolveOptions.md) · Optional
+
+- [`segments`](RevolveOptions.md#segments) · `number` · Optional
+
+  Exact circumferential segment count from three through the configured safety limit.
+
+  This local topology override takes precedence over [CircularPrimitiveOptions.resolution](CircularPrimitiveOptions.md#resolution)
+  and any active model-wide resolution policy.
+
+- [`resolution`](RevolveOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+- [`revolveDegrees`](RevolveOptions.md#revolvedegrees) · `number` · Optional
+
+  Positive angular sweep no greater than 360 degrees; partial revolutions have end caps.
+  Segment counts describe a complete circle and scale to this angular span. Native filled
+  revolutions require at least three sweep intervals: adaptive sampling refines to that floor,
+  while exact counts that imply fewer intervals reject. Pure revolveMesh supports one interval.
+
+- [`limits`](RevolveOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+
+
+#### Returns
+
+[`Solid`](Solid.md)
+
+***
+
+### sweep()
+
+
+
+**sweep**(`path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `options?`: [`SweepOptions`](SweepOptions.md)): [`Solid`](Solid.md)
+
+
+
+Sweeps this filled section using the selected frame policy and degree twist.
+
+#### Parameters
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="options-5"></a>
+
+**`options`** · [`SweepOptions`](SweepOptions.md) · Optional
+
+- [`closed`](SweepOptions.md#closed) · `boolean` · Optional
+
+  Join the path's last station to its first. Open paths retain watertight end caps.
+
+- [`limits`](SweepOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and sampling allocation ceilings.
+
+- [`orientation`](SweepOptions.md#orientation) · [`SweepOrientation`](SweepOrientation.md) · Optional
+
+  Explicit frame policy; default transport minimizes rotations, initially projecting +X then +Y then +Z.
+
+- [`resolution`](SweepOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Physical sampling of nonzero twist; inserted stations retain authored station controls.
+
+- [`twistDegrees`](SweepOptions.md#twistdegrees) · `number` · Optional
+
+  Total additional profile rotation in degrees, with progression selected by twistBy.
+
+- [`twistBy`](SweepOptions.md#twistby) · `"length"` \| `"stations"` · Optional
+
+  Twist advances by physical path length (default), or normalized authored station position, including a closed seam gap.
+
+- [`scale`](SweepOptions.md#scale) · `number` \| [`Vector2Tuple`](Vector2Tuple.md) \| readonly [`Vector2Tuple`](Vector2Tuple.md)[] · Optional
+
+  Positive uniform/XY scale, or one XY pair per path station. Defaults to one.
+
+- [`seamProfileOffset`](SweepOptions.md#seamprofileoffset) · `number` · Optional
+
+  Corresponding point-index advance at a rotationally equivalent closed seam.
+
+
+
+#### Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Anchor3](Anchor3.md)
+- [ExtrudeOptions](ExtrudeOptions.md)
+- [Pivot2Options](Pivot2Options.md)
+- [RegionData](RegionData.md)
+- [RevolveOptions](RevolveOptions.md)
+- [SectionOffsetOptions](SectionOffsetOptions.md)
+- [Solid](Solid.md)
+- [SweepOptions](SweepOptions.md)
+- [Transform2Input](Transform2Input.md)
+- [Vector2Input](Vector2Input.md)
+- [Vector3Tuple](Vector3Tuple.md)
+
+## 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.14.0`.

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

@@ -0,0 +1,72 @@
+# SectionHullOptions
+
+Planar convex hull inputs are finite XY points or filled section recipes.
+
+**SectionHullOptions** = \{ `points`: readonly [`Vector2Tuple`](Vector2Tuple.md)[]; `sections?`: `never`; \} \| \{ `sections`: readonly [`Section`](Section.md)[]; `points?`: `never`; \}
+
+
+
+## Union Members
+
+### Type Literal
+
+\{ `points`: readonly [`Vector2Tuple`](Vector2Tuple.md)[]; `sections?`: `never`; \}
+
+#### points
+
+
+
+`readonly` **points**: readonly [`Vector2Tuple`](Vector2Tuple.md)[]
+
+
+
+At least three finite millimetre XY points spanning positive area.
+
+#### sections?
+
+
+
+`readonly` `optional` **sections?**: `never`
+
+
+
+Point input excludes section input.
+
+***
+
+### Type Literal
+
+\{ `sections`: readonly [`Section`](Section.md)[]; `points?`: `never`; \}
+
+#### sections
+
+
+
+`readonly` **sections**: readonly [`Section`](Section.md)[]
+
+
+
+One through 1000 filled section recipes to include in the convex hull.
+
+#### points?
+
+
+
+`readonly` `optional` **points?**: `never`
+
+
+
+Section input excludes point input.
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [Vector2Tuple](Vector2Tuple.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/recipes.md#primitive-booleans-and-repeated-placement)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,98 @@
+# SectionInspection
+
+Immutable native filled section facts in millimetres and square millimetres. Repeated inspections of the same native shape share these facts within one revision.
+
+## Properties
+
+### isEmpty
+
+
+
+`readonly` **isEmpty**: `boolean`
+
+
+
+Whether this filled section has no area or boundary.
+
+***
+
+### area
+
+
+
+`readonly` **area**: `number`
+
+
+
+Filled section area in square millimetres.
+
+***
+
+### contours
+
+
+
+`readonly` **contours**: `number`
+
+
+
+Number of extracted outer and hole contours.
+
+***
+
+### max
+
+
+
+`readonly` **max**: [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Inclusive maximum coordinates in millimetres.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector2Tuple`](Vector2Tuple.md)
+
+
+
+Inclusive minimum coordinates in millimetres.
+
+***
+
+### parts
+
+
+
+`readonly` **parts**: `number`
+
+
+
+Number of disconnected filled section components.
+
+***
+
+### vertices
+
+
+
+`readonly` **vertices**: `number`
+
+
+
+Number of native section vertices.
+
+
+## Related APIs
+
+- [Vector2Tuple](Vector2Tuple.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,16 @@
+# SectionOffsetJoin
+
+Clipper2 join styles accepted by robust region offsets.
+
+**SectionOffsetJoin** = `"miter"` \| `"round"` \| `"square"`
+
+
+
+
+## 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.14.0`.