@metamesh/modeling 0.12.0 → 0.13.0

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

@@ -0,0 +1,96 @@
+# RoundedEdgeTreatment
+
+A circular edge or corner roundover with explicit physical sampling.
+
+## Extends
+
+- [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md)
+
+## Properties
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
+
+
+
+Explicit sampling ceilings; bound modeling operations may only lower the host policy.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`limits`](CircularPrimitiveOptions.md#limits)
+
+***
+
+### segments?
+
+
+
+`readonly` `optional` **segments?**: `number`
+
+
+
+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.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`segments`](CircularPrimitiveOptions.md#segments)
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical tessellation policy over the active model-wide policy.
+
+#### Inherited from
+
+[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`resolution`](CircularPrimitiveOptions.md#resolution)
+
+***
+
+### kind
+
+
+
+`readonly` **kind**: `"round"`
+
+
+
+Selects circular corners or spherical all-edge roundovers.
+
+***
+
+### radius
+
+
+
+`readonly` **radius**: `number`
+
+
+
+Nonnegative millimetre radius; zero leaves the edge or corner untreated. Positive values must fit adjoining dimensions.
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [GeometrySamplingLimits](GeometrySamplingLimits.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/Section.md

@@ -0,0 +1,450 @@
+# Section
+
+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.
+
+## 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 ownership brand for a same-session section.
+
+## Methods
+
+### translate()
+
+
+
+**translate**(`offset`: [`Vector2`](Vector2.md)): `Section`
+
+
+
+Translates XY coordinates in millimetres.
+
+#### Parameters
+
+<a id="offset"></a>
+
+**`offset`** · [`Vector2`](Vector2.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### rotate()
+
+
+
+**rotate**(`degrees`: `number`): `Section`
+
+
+
+Rotates counterclockwise about the origin by a scalar angle in degrees.
+
+#### Parameters
+
+<a id="degrees"></a>
+
+**`degrees`** · `number` · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### scale()
+
+
+
+**scale**(`factors`: `number` \| [`Vector2`](Vector2.md)): `Section`
+
+
+
+Nonsingular scaling about the origin.
+
+#### Parameters
+
+<a id="factors"></a>
+
+**`factors`** · `number` \| [`Vector2`](Vector2.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### mirror()
+
+
+
+**mirror**(`normal`: [`Vector2`](Vector2.md)): `Section`
+
+
+
+Reflection across an origin line/plane.
+
+#### Parameters
+
+<a id="normal"></a>
+
+**`normal`** · [`Vector2`](Vector2.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### transform()
+
+
+
+**transform**(`matrix`: [`Transform2`](Transform2.md)): `Section`
+
+
+
+Row-major affine transform preserving dimensionality.
+
+#### Parameters
+
+<a id="matrix"></a>
+
+**`matrix`** · [`Transform2`](Transform2.md) · Required
+
+
+
+#### Returns
+
+`Section`
+
+***
+
+### 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 same-session handle 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?`: [`RegionOffsetOptions`](RegionOffsetOptions.md)): `Section`
+
+
+
+Native millimetre offset preserving holes.
+
+#### Parameters
+
+<a id="distance"></a>
+
+**`distance`** · `number` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`RegionOffsetOptions`](RegionOffsetOptions.md) · Optional
+
+- [`circularSegments`](RegionOffsetOptions.md#circularsegments) · `number` · Optional
+
+  Number of segments per full circle for round joins.
+
+- [`join`](RegionOffsetOptions.md#join) · [`RegionOffsetJoin`](RegionOffsetJoin.md) · Optional
+
+  Corner treatment; defaults to `round`.
+
+- [`miterLimit`](RegionOffsetOptions.md#miterlimit) · `number` · Optional
+
+  Maximum miter extension in offset-distance multiples; at least two.
+
+- [`resolution`](RegionOffsetOptions.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-1"></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` \| [`Vector2`](Vector2.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-2"></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 [`Vector3`](Vector3.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 [`Vector3`](Vector3.md)[] · Required
+
+
+
+<a id="options-3"></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` \| [`Vector2`](Vector2.md) \| readonly [`Vector2`](Vector2.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)
+- [RegionOffsetOptions](RegionOffsetOptions.md)
+- [RevolveOptions](RevolveOptions.md)
+- [Solid](Solid.md)
+- [SweepOptions](SweepOptions.md)
+- [Transform2](Transform2.md)
+- [Vector2](Vector2.md)
+- [Vector3](Vector3.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.13.0`.

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

@@ -0,0 +1,72 @@
+# SectionHullOptions
+
+Planar convex hull inputs are finite XY points or same-session filled sections.
+
+**SectionHullOptions** = \{ `points`: readonly [`Vector2`](Vector2.md)[]; `sections?`: `never`; \} \| \{ `sections`: readonly [`Section`](Section.md)[]; `points?`: `never`; \}
+
+
+
+## Union Members
+
+### Type Literal
+
+\{ `points`: readonly [`Vector2`](Vector2.md)[]; `sections?`: `never`; \}
+
+#### points
+
+
+
+`readonly` **points**: readonly [`Vector2`](Vector2.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 same-session sections to include in the convex hull.
+
+#### points?
+
+
+
+`readonly` `optional` **points?**: `never`
+
+
+
+Section input excludes point input.
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [Vector2](Vector2.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.13.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**: [`Vector2`](Vector2.md)
+
+
+
+Inclusive maximum coordinates in millimetres.
+
+***
+
+### min
+
+
+
+`readonly` **min**: [`Vector2`](Vector2.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
+
+- [Vector2](Vector2.md)
+
+## Guides
+
+- [Solid inspection](../../guides/recipes.md#solid-inspection)
+
+Package: `@metamesh/modeling@0.13.0`.