@metamesh/modeling 0.18.0 → 0.19.0

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

@@ -1,47 +0,0 @@
-# ProfileSpan2
-
-An identified line, circular arc, or cubic Bézier between corresponding landmarks.
-
-**ProfileSpan2** = `object` & (\{ `kind`: `"line"`; `start`: [`Vector2Data`](Vector2Data.md); `end`: [`Vector2Data`](Vector2Data.md); \} \| \{ `kind`: `"arc"`; `center`: [`Vector2Data`](Vector2Data.md); `radius`: `number`; `startAngle`: `number`; `sweepAngle`: `number`; \} \| \{ `kind`: `"cubic"`; `start`: [`Vector2Data`](Vector2Data.md); `control1`: [`Vector2Data`](Vector2Data.md); `control2`: [`Vector2Data`](Vector2Data.md); `end`: [`Vector2Data`](Vector2Data.md); \})
-
-
-
-## Type Declaration
-
-### id
-
-
-
-`readonly` **id**: `string`
-
-
-
-Stable canonical lowercase identity; unique within the containing topology or output.
-
-### segments?
-
-
-
-`readonly` `optional` **segments?**: `number`
-
-
-
-Optional exact span interval count; the family uses the largest requested count.
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Optional span-local physical sampling over the family's resolution; exact intervals take precedence.
-
-
-## Related APIs
-
-- [GeometryResolution](GeometryResolution.md)
-- [Vector2Data](Vector2Data.md)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,41 +0,0 @@
-# ProfiledEdgeTreatment
-
-A deliberately sampled, inward-only corner profile with exact polyline geometry.
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"profile"`
-
-
-
-Selects an explicit corner profile; no analytic curve is inferred from its samples.
-
-***
-
-### profile
-
-
-
-`readonly` **profile**: readonly [`Vector2Data`](Vector2Data.md)[]
-
-
-
-Millimetre setbacks on adjoining surfaces, from [positive, 0] to [0, positive].
-First coordinates decrease and second coordinates increase. Cylinder/extrusion ends use
-cap inset first, side setback second; planar corners use incoming then outgoing edges.
-
-
-## Related APIs
-
-- [Vector2Data](Vector2Data.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.18.0`.

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

@@ -1,59 +0,0 @@
-# RadialPatternOptions
-
-Degree rotations about a fixed world-space pivot; XY patterns use the implicit +Z axis.
-
-**RadialPatternOptions**\<`Dimension` *extends* `2` \| `3` = `3`\> = `object` & `Dimension` *extends* `2` ? `object` : `object`
-
-
-
-## Type Parameters
-
-### Dimension
-
-`Dimension` *extends* `2` \| `3` = `3`
-
-## Type Declaration
-
-### count
-
-
-
-`readonly` **count**: `number`
-
-
-
-Number of shapes to return, including the original.
-
-### angle
-
-
-
-`readonly` **angle**: `number`
-
-
-
-Signed rotation from one copy to the next, in degrees.
-
-### pivot?
-
-
-
-`readonly` `optional` **pivot?**: `Dimension` *extends* `2` ? [`Vector2Input`](Vector2Input.md) : [`Vector3Input`](Vector3Input.md)
-
-
-
-Fixed world-space rotation pivot; defaults to the coordinate origin.
-
-
-## Related APIs
-
-- [Vector2Input](Vector2Input.md)
-- [Vector3Input](Vector3Input.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)
-- [Fluent values and standalone algorithms](../../guides/concepts.md#choose-fluent-values-or-standalone-algorithms)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,15 +0,0 @@
-# RadialSizing
-
-Radial dimensions refer to polygon vertices or compensate faceting to meet polygon faces.
-
-**RadialSizing** = `"vertex"` \| `"face"`
-
-
-
-
-## 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.18.0`.

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

@@ -1,40 +0,0 @@
-# RadialSizingOptions
-
-Nominal radial sizing shared by circular and regular polygon construction.
-
-## Properties
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceilings; bound modeling operations may only lower the host policy.
-
-***
-
-### sizing?
-
-
-
-`readonly` `optional` **sizing?**: [`RadialSizing`](RadialSizing.md)
-
-
-
-Vertex sizing is inscribed; face sizing circumscribes the nominal radius. Defaults to vertex.
-
-
-## Related APIs
-
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [RadialSizing](RadialSizing.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.18.0`.

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

@@ -1,72 +0,0 @@
-# RectangleContourOptions
-
-Shared rectangle dimensions, origin and uniform or per-corner treatment.
-
-## Extended by
-
-- [`RectangleOptions`](RectangleOptions.md)
-
-## Properties
-
-### size
-
-
-
-`readonly` **size**: `number` \| [`Vector2Input`](Vector2Input.md)
-
-
-
-Positive uniform size or explicit XY extents in millimetres.
-
-***
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Center on XY; otherwise the minimum corner is the origin. Defaults to true.
-
-***
-
-### treatment?
-
-
-
-`readonly` `optional` **treatment?**: [`EdgeTreatment`](EdgeTreatment.md) \| [`RectangleCornerTreatments`](RectangleCornerTreatments.md)
-
-
-
-Uniform treatment or four corner treatments. Exact round segments describe a complete circle and must divide by four.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceiling for the complete output profile.
-
-
-## Related APIs
-
-- [EdgeTreatment](EdgeTreatment.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [RectangleCornerTreatments](RectangleCornerTreatments.md)
-- [RectangleOptions](RectangleOptions.md)
-- [Vector2Input](Vector2Input.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.18.0`.

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

@@ -1,40 +0,0 @@
-# RectangleCornerTreatment
-
-A rectangle corner, including an explicitly untreated corner in a treatment tuple.
-
-**RectangleCornerTreatment** = [`EdgeTreatment`](EdgeTreatment.md) \| \{ `kind`: `"square"`; \}
-
-
-
-## Union Members
-
-[`EdgeTreatment`](EdgeTreatment.md)
-
-***
-
-### Type Literal
-
-\{ `kind`: `"square"`; \}
-
-#### kind
-
-
-
-`readonly` **kind**: `"square"`
-
-
-
-Leaves this corner untreated.
-
-
-## Related APIs
-
-- [EdgeTreatment](EdgeTreatment.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.18.0`.

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

@@ -1,20 +0,0 @@
-# RectangleCornerTreatments
-
-Corner treatments ordered top-right, top-left, bottom-left, bottom-right.
-
-**RectangleCornerTreatments** = readonly \[`topRight`: [`RectangleCornerTreatment`](RectangleCornerTreatment.md), `topLeft`: [`RectangleCornerTreatment`](RectangleCornerTreatment.md), `bottomLeft`: [`RectangleCornerTreatment`](RectangleCornerTreatment.md), `bottomRight`: [`RectangleCornerTreatment`](RectangleCornerTreatment.md)\]
-
-
-
-
-## Related APIs
-
-- [RectangleCornerTreatment](RectangleCornerTreatment.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.18.0`.

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

@@ -1,19 +0,0 @@
-# RegionData
-
-A two-dimensional region represented by disjoint filled polygons. Each PolygonData owns one exterior and its holes; an empty region contains no material.
-
-**RegionData** = readonly [`PolygonData`](PolygonData.md)[]
-
-
-
-
-## Related APIs
-
-- [PolygonData](PolygonData.md)
-
-## Guides
-
-- [Geometry vocabulary](../../guides/concepts.md#geometry-vocabulary)
-- [Lifecycle and inspection](../../guides/concepts.md#lifecycle-and-inspection)
-
-Package: `@metamesh/modeling@0.18.0`.

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

@@ -1,94 +0,0 @@
-# RevolveOptions
-
-Circumferential sampling and degree sweep shared by pure and filled revolution.
-
-## Extends
-
-- [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md)
-
-## Properties
-
-### 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)
-
-***
-
-### degrees?
-
-
-
-`readonly` `optional` **degrees?**: `number`
-
-
-
-Positive sweep in degrees, no greater than 360. Defaults to a full revolution;
-smaller sweeps form partial revolutions with 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 mesh.revolve supports one interval.
-
-#### Default Value
-
-`360`
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
-
-
-
-Explicit output and sampling allocation ceilings.
-
-#### Overrides
-
-[`CircularPrimitiveOptions`](CircularPrimitiveOptions.md).[`limits`](CircularPrimitiveOptions.md#limits)
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [GeometryResolution](GeometryResolution.md)
-- [ModelingLimits](ModelingLimits.md)
-
-## 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.18.0`.

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

@@ -1,96 +0,0 @@
-# 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.18.0`.

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

@@ -1,76 +0,0 @@
-# SmoothEdgeTreatment
-
-A cubic corner transition with zero curvature at its straight tangent joins.
-
-## Properties
-
-### kind
-
-
-
-`readonly` **kind**: `"smooth"`
-
-
-
-Selects continuous-curvature cubic rounding, rather than a circular radius.
-
-***
-
-### distance
-
-
-
-`readonly` **distance**: `number` \| readonly \[`number`, `number`\]
-
-
-
-Millimetre setbacks, equal or [first, second]; zero or [0, 0] leaves the edge untreated, otherwise both must be positive.
-
-***
-
-### segments?
-
-
-
-`readonly` `optional` **segments?**: `number`
-
-
-
-Exact cubic interval count, positive; overrides physical sampling.
-
-***
-
-### resolution?
-
-
-
-`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
-
-
-
-Physical chord/edge-length sampling; circularSegments does not describe a cubic.
-
-***
-
-### limits?
-
-
-
-`readonly` `optional` **limits?**: `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\>
-
-
-
-Explicit sampling ceilings, bounded by the host policy.
-
-
-## Related APIs
-
-- [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.18.0`.

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

@@ -1,20 +0,0 @@
-# SphereOptions
-
-Exactly one radius or diameter, placement, and tessellation for an origin-centered sphere.
-
-**SphereOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & [`PrimitiveAttachment`](PrimitiveAttachment.md) & (\{ `radius`: `number`; `diameter?`: `never`; \} \| \{ `diameter`: `number`; `radius?`: `never`; \})
-
-
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [PrimitiveAttachment](PrimitiveAttachment.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.18.0`.