@metamesh/modeling 0.17.0 → 0.19.0

package/dist/docs/reference/model/Transform3-type.md

@@ -1,297 +0,0 @@
-# Transform3
-
-Immutable reusable XYZ placement. Methods apply in written order; angles are degrees.
-
-## Methods
-
-### translate()
-
-
-
-**translate**(`offset`: [`Vector3Input`](Vector3Input.md)): `Transform3`
-
-
-
-Applies a translation in model units after this placement.
-
-#### Parameters
-
-<a id="offset"></a>
-
-**`offset`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### rotate()
-
-
-
-**rotate**(`degrees`: [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Rotates about global X, then Y, then Z in degrees, about an optional world-space pivot.
-
-#### Parameters
-
-<a id="degrees"></a>
-
-**`degrees`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="options"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### rotateAxis()
-
-
-
-**rotateAxis**(`axis`: [`Vector3Input`](Vector3Input.md), `degrees`: `number`, `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Rotates right-handed in degrees about a nonzero axis and optional world-space pivot.
-
-#### Parameters
-
-<a id="axis"></a>
-
-**`axis`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="degrees-1"></a>
-
-**`degrees`** · `number` · Required
-
-
-
-<a id="options-1"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### scale()
-
-
-
-**scale**(`factors`: `number` \| [`Vector3Input`](Vector3Input.md), `options?`: [`Pivot3Options`](Pivot3Options.md)): `Transform3`
-
-
-
-Scales about an optional world-space pivot; finite nonzero factors may reflect.
-
-#### Parameters
-
-<a id="factors"></a>
-
-**`factors`** · `number` \| [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-<a id="options-2"></a>
-
-**`options`** · [`Pivot3Options`](Pivot3Options.md) · Optional
-
-- [`pivot`](Pivot3Options.md#pivot) · [`Vector3Input`](Vector3Input.md) · Optional
-
-  World-space point left fixed by rotation or scaling.
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### andThen()
-
-
-
-**andThen**(`next`: [`Transform3Input`](Transform3Input.md)): `Transform3`
-
-
-
-Applies this placement first, then `next`; equivalent to composeTransform3(next, current).
-
-#### Parameters
-
-<a id="next"></a>
-
-**`next`** · [`Transform3Input`](Transform3Input.md) · Required
-
-
-
-#### Returns
-
-`Transform3`
-
-***
-
-### inverse()
-
-
-
-**inverse**(): `Transform3`
-
-
-
-Returns the inverse; singular and numerically unstable transforms throw GeometryError.
-
-#### Returns
-
-`Transform3`
-
-***
-
-### applyPoint()
-
-
-
-**applyPoint**(`point`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Transforms a finite point, including translation. Returns a fresh immutable vector.
-
-#### Parameters
-
-<a id="point"></a>
-
-**`point`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### applyDirection()
-
-
-
-**applyDirection**(`direction`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Transforms a finite direction, excluding translation and retaining scale. This is not a normal transform.
-
-#### Parameters
-
-<a id="direction"></a>
-
-**`direction`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### applyNormal()
-
-
-
-**applyNormal**(`normal`: [`Vector3Input`](Vector3Input.md)): [`Vector3`](Vector3-type.md)
-
-
-
-Applies the inverse transpose and normalizes. Ignores translation; rejects zero normals.
-
-#### Parameters
-
-<a id="normal"></a>
-
-**`normal`** · [`Vector3Input`](Vector3Input.md) · Required
-
-
-
-#### Returns
-
-[`Vector3`](Vector3-type.md)
-
-***
-
-### toData()
-
-
-
-**toData**(): [`Transform3Data`](Transform3Data.md)
-
-
-
-Returns the frozen canonical row-major 4x4 matrix for interchange.
-
-#### Returns
-
-[`Transform3Data`](Transform3Data.md)
-
-***
-
-### to2D()
-
-
-
-**to2D**(): [`Transform2`](Transform2-type.md)
-
-
-
-Restricts to XY; throws GeometryError for a plane change or singular XY restriction.
-
-#### Returns
-
-[`Transform2`](Transform2-type.md)
-
-
-## Related APIs
-
-- [Pivot3Options](Pivot3Options.md)
-- [Transform2](Transform2-type.md)
-- [Transform3Data](Transform3Data.md)
-- [Transform3Input](Transform3Input.md)
-- [Vector3](Vector3-type.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.17.0`.

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

@@ -1,19 +0,0 @@
-# Transform3Data
-
-A row-major affine 4x4 matrix applied to column vectors.
-
-**Transform3Data** = readonly \[`m00`: `number`, `m01`: `number`, `m02`: `number`, `m03`: `number`, `m10`: `number`, `m11`: `number`, `m12`: `number`, `m13`: `number`, `m20`: `number`, `m21`: `number`, `m22`: `number`, `m23`: `number`, `m30`: `number`, `m31`: `number`, `m32`: `number`, `m33`: `number`\]
-
-
-
-Translation occupies indices 3, 7, and 11. The final row must be
-`[0, 0, 0, 1]` within the active geometry tolerance.
-
-
-## 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.17.0`.

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

@@ -1,21 +0,0 @@
-# Transform3Input
-
-An immutable XYZ transform or its canonical row-major matrix for interchange.
-
-**Transform3Input** = [`Transform3`](Transform3-type.md) \| [`Transform3Data`](Transform3Data.md)
-
-
-
-
-## Related APIs
-
-- [Transform3](Transform3-type.md)
-- [Transform3Data](Transform3Data.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.17.0`.

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

@@ -1,42 +0,0 @@
-# TriangleMesh
-
-A topology-preserving indexed triangle mesh with XYZ vertex positions.
-
-## Extended by
-
-- [`FinalizedPart`](FinalizedPart.md)
-
-## Properties
-
-### indices
-
-
-
-`readonly` **indices**: `Uint32Array`
-
-
-
-Three unsigned vertex indices per triangle.
-
-***
-
-### positions
-
-
-
-`readonly` **positions**: `Float32Array`
-
-
-
-Flat XYZ coordinates, three finite values per vertex.
-
-
-## Related APIs
-
-- [FinalizedPart](FinalizedPart.md)
-
-## Guides
-
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,123 +0,0 @@
-# TriangleMeshAnalysis
-
-Measurements and optional edge-connected topology from one validated mesh traversal.
-
-## Extends
-
-- [`TriangleMeshMeasurements`](TriangleMeshMeasurements.md)
-
-## Properties
-
-### connectedComponentCount?
-
-
-
-`readonly` `optional` **connectedComponentCount?**: `number`
-
-
-
-Number of referenced edge-connected boundary shells when `includeTopology` is requested; cavities count separately.
-
-***
-
-### edgeCount?
-
-
-
-`readonly` `optional` **edgeCount?**: `number`
-
-
-
-Number of distinct indexed undirected edges when `includeTopology` is requested.
-
-***
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
-
-
-
-Axis-aligned bounds.
-
-#### Inherited from
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`bounds`](TriangleMeshMeasurements.md#bounds)
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed enclosed volume; positive values correspond to outward winding.
-
-#### Inherited from
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`signedVolume`](TriangleMeshMeasurements.md#signedvolume)
-
-***
-
-### surfaceArea
-
-
-
-`readonly` **surfaceArea**: `number`
-
-
-
-Sum of all triangle areas in squared model units.
-
-#### Inherited from
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`surfaceArea`](TriangleMeshMeasurements.md#surfacearea)
-
-***
-
-### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Number of indexed triangles.
-
-#### Inherited from
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`triangleCount`](TriangleMeshMeasurements.md#trianglecount)
-
-***
-
-### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Number of distinct entries in the position buffer.
-
-#### Inherited from
-
-[`TriangleMeshMeasurements`](TriangleMeshMeasurements.md).[`vertexCount`](TriangleMeshMeasurements.md#vertexcount)
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [TriangleMeshMeasurements](TriangleMeshMeasurements.md)
-
-## Guides
-
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,79 +0,0 @@
-# TriangleMeshMeasurements
-
-Geometric measurements derived from a validated, non-empty triangle mesh.
-
-## Extended by
-
-- [`TriangleMeshAnalysis`](TriangleMeshAnalysis.md)
-
-## Properties
-
-### bounds
-
-
-
-`readonly` **bounds**: [`Bounds3Data`](Bounds3Data.md)
-
-
-
-Axis-aligned bounds.
-
-***
-
-### signedVolume
-
-
-
-`readonly` **signedVolume**: `number`
-
-
-
-Signed enclosed volume; positive values correspond to outward winding.
-
-***
-
-### surfaceArea
-
-
-
-`readonly` **surfaceArea**: `number`
-
-
-
-Sum of all triangle areas in squared model units.
-
-***
-
-### triangleCount
-
-
-
-`readonly` **triangleCount**: `number`
-
-
-
-Number of indexed triangles.
-
-***
-
-### vertexCount
-
-
-
-`readonly` **vertexCount**: `number`
-
-
-
-Number of distinct entries in the position buffer.
-
-
-## Related APIs
-
-- [Bounds3Data](Bounds3Data.md)
-- [TriangleMeshAnalysis](TriangleMeshAnalysis.md)
-
-## Guides
-
-- [Solid inspection](../../guides/recipes.md#solid-inspection)
-
-Package: `@metamesh/modeling@0.17.0`.

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

@@ -1,143 +0,0 @@
-# TubeOptions
-
-Dimensions, placement, and tessellation for a hollow Z-axis tube.
-
-## Extends
-
-- [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md)
-- [`PrimitiveAttachment`](PrimitiveAttachment.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)
-
-***
-
-### 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)
-
-***
-
-### center?
-
-
-
-`readonly` `optional` **center?**: `boolean`
-
-
-
-Centers the tube on the Z origin when `true`; otherwise its bottom is at `Z = 0`.
-
-#### Default Value
-
-`true`
-
-***
-
-### height
-
-
-
-`readonly` **height**: `number`
-
-
-
-Total height along Z in millimetres.
-
-***
-
-### innerRadius
-
-
-
-`readonly` **innerRadius**: `number`
-
-
-
-Positive inner radius in millimetres.
-
-***
-
-### outerRadius
-
-
-
-`readonly` **outerRadius**: `number`
-
-
-
-Outer radius in millimetres; greater than [TubeOptions.innerRadius](#innerradius).
-
-
-## Related APIs
-
-- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
-- [GeometryResolution](GeometryResolution.md)
-- [GeometrySamplingLimits](GeometrySamplingLimits.md)
-- [PrimitiveAttachment](PrimitiveAttachment.md)
-- [PrimitiveAttachmentOptions](PrimitiveAttachmentOptions.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.17.0`.