@metamesh/modeling 0.11.0 → 0.13.0

package/dist/docs/reference/geometry/CylindricalGearPairDimensions.md

@@ -0,0 +1,82 @@
+# CylindricalGearPairDimensions
+
+Pitch solution for a coordinated cylindrical gear pair.
+
+## Properties
+
+### centerDistance
+
+
+
+`readonly` **centerDistance**: `number`
+
+
+
+Nominal distance between the two +Z gear axes, in millimetres.
+
+***
+
+### driver
+
+
+
+`readonly` **driver**: [`CylindricalGearDimensions`](CylindricalGearDimensions.md)
+
+
+
+Resolved driver dimensions.
+
+***
+
+### drivenDirection
+
+
+
+`readonly` **drivenDirection**: `-1` \| `1`
+
+
+
+`-1` for opposite external rotation and `1` for same-direction internal rotation.
+
+***
+
+### driven
+
+
+
+`readonly` **driven**: [`CylindricalGearDimensions`](CylindricalGearDimensions.md)
+
+
+
+Resolved driven dimensions.
+
+***
+
+### ratio
+
+
+
+`readonly` **ratio**: `number`
+
+
+
+Absolute driven-to-driver tooth-count ratio.
+
+***
+
+### requiredDrivenHelixAngleDegrees
+
+
+
+`readonly` **requiredDrivenHelixAngleDegrees**: `number`
+
+
+
+Helix angle required on the driven member for conjugate teeth, in degrees.
+
+
+## Related APIs
+
+- [CylindricalGearDimensions](CylindricalGearDimensions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/CylindricalGearPairMotionOptions.md

@@ -0,0 +1,34 @@
+# CylindricalGearPairMotionOptions
+
+Sampling controls for one coupled internal-gear tooth cycle.
+
+## Properties
+
+### outline?
+
+
+
+`readonly` `optional` **outline?**: [`CylindricalGearOutlineOptions`](CylindricalGearOutlineOptions.md)
+
+
+
+Optional deterministic outline sampling overrides.
+
+***
+
+### samples?
+
+
+
+`readonly` `optional` **samples?**: `number`
+
+
+
+Coupled poses sampled over one driver tooth pitch. Defaults to 24.
+
+
+## Related APIs
+
+- [CylindricalGearOutlineOptions](CylindricalGearOutlineOptions.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/CylindricalGearPairMotionReport.md

@@ -0,0 +1,41 @@
+# CylindricalGearPairMotionReport
+
+Maximum sampled planar overlap for an external pinion inside an internal ring.
+
+## Properties
+
+### driverPhaseRadians
+
+
+
+`readonly` **driverPhaseRadians**: `number`
+
+
+
+Driver phase at the maximum overlap, in radians.
+
+***
+
+### maximumOverlapArea
+
+
+
+`readonly` **maximumOverlapArea**: `number`
+
+
+
+Maximum pinion area lying inside ring material, in square millimetres.
+
+***
+
+### samples
+
+
+
+`readonly` **samples**: `number`
+
+
+
+Number of evenly spaced coupled poses inspected.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/CylindricalGearPairSpec.md

@@ -0,0 +1,47 @@
+# CylindricalGearPairSpec
+
+Inputs for resolving a coordinated cylindrical gear pair.
+
+## Properties
+
+### driver
+
+
+
+`readonly` **driver**: [`CylindricalGearSpec`](CylindricalGearSpec.md)
+
+
+
+Driving gear or pinion.
+
+***
+
+### driven
+
+
+
+`readonly` **driven**: [`CylindricalGearSpec`](CylindricalGearSpec.md)
+
+
+
+Driven external gear or internal ring gear.
+
+***
+
+### mesh
+
+
+
+`readonly` **mesh**: [`CylindricalGearMeshKind`](CylindricalGearMeshKind.md)
+
+
+
+External/external or external/internal mesh.
+
+
+## Related APIs
+
+- [CylindricalGearMeshKind](CylindricalGearMeshKind.md)
+- [CylindricalGearSpec](CylindricalGearSpec.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/CylindricalGearSpec.md

@@ -0,0 +1,82 @@
+# CylindricalGearSpec
+
+Nominal dimensions for a standard full-depth cylindrical involute gear.
+
+Lengths use millimetres. `module` and `pressureAngleDegrees` are measured in
+the normal plane; a non-zero signed helix angle is converted to transverse
+pitch-plane dimensions. Positive and negative helix angles identify
+opposite hands but produce the same 2D pitch geometry.
+
+## Properties
+
+### backlash?
+
+
+
+`readonly` `optional` **backlash?**: `number`
+
+
+
+Tangential tooth-thickness reduction at the pitch circle, in millimetres.
+
+***
+
+### clearanceFactor?
+
+
+
+`readonly` `optional` **clearanceFactor?**: `number`
+
+
+
+Dedendum clearance as a multiple of normal module; defaults to `0.25`.
+
+***
+
+### helixAngleDegrees?
+
+
+
+`readonly` `optional` **helixAngleDegrees?**: `number`
+
+
+
+Signed helix angle in degrees; zero creates a spur pitch system.
+
+***
+
+### module
+
+
+
+`readonly` **module**: `number`
+
+
+
+Normal module in millimetres per tooth.
+
+***
+
+### pressureAngleDegrees?
+
+
+
+`readonly` `optional` **pressureAngleDegrees?**: `number`
+
+
+
+Normal pressure angle in degrees; defaults to 20 degrees.
+
+***
+
+### toothCount
+
+
+
+`readonly` **toothCount**: `number`
+
+
+
+Integer tooth count from 6 through 1,000; external profiles also enforce the no-undercut limit.
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/DEFAULT_GEOMETRY_TOLERANCE.md

@@ -0,0 +1,7 @@
+# DEFAULT_GEOMETRY_TOLERANCE
+
+Default absolute, relative, and angular tolerances for millimetre-scale models.
+
+`const` **DEFAULT\_GEOMETRY\_TOLERANCE**: `Readonly`\<\{ `absolute`: `1e-9`; `angular`: `1e-10`; `relative`: `1e-12`; \}\>
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/EdgeTreatment.md

@@ -0,0 +1,17 @@
+# EdgeTreatment
+
+Uniform finishing vocabulary shared by applicable solid edges and profile corners.
+
+**EdgeTreatment** = [`ChamferedEdgeTreatment`](ChamferedEdgeTreatment.md) \| [`RoundedEdgeTreatment`](RoundedEdgeTreatment.md) \| [`SmoothEdgeTreatment`](SmoothEdgeTreatment.md) \| [`ProfiledEdgeTreatment`](ProfiledEdgeTreatment.md)
+
+
+
+
+## Related APIs
+
+- [ChamferedEdgeTreatment](ChamferedEdgeTreatment.md)
+- [ProfiledEdgeTreatment](ProfiledEdgeTreatment.md)
+- [RoundedEdgeTreatment](RoundedEdgeTreatment.md)
+- [SmoothEdgeTreatment](SmoothEdgeTreatment.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/EllipseContourOptions.md

@@ -0,0 +1,15 @@
+# EllipseContourOptions
+
+Ellipse dimensions with exactly one XY radii or full-size tuple and explicit sampling.
+
+**EllipseContourOptions** = [`CircularPrimitiveOptions`](CircularPrimitiveOptions.md) & (\{ `radius`: [`Vector2`](Vector2.md); `size?`: `never`; \} \| \{ `size`: [`Vector2`](Vector2.md); `radius?`: `never`; \})
+
+
+
+
+## Related APIs
+
+- [CircularPrimitiveOptions](CircularPrimitiveOptions.md)
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/EndTreatments.md

@@ -0,0 +1,34 @@
+# EndTreatments
+
+Independent inward finishing on primitive or straight convex extrusion ends. Zero amounts leave the end untreated, including when all ends are disabled.
+
+## Properties
+
+### bottom?
+
+
+
+`readonly` `optional` **bottom?**: [`EdgeTreatment`](EdgeTreatment.md)
+
+
+
+Bottom cap and adjoining side; omitted leaves the end untreated.
+
+***
+
+### top?
+
+
+
+`readonly` `optional` **top?**: [`EdgeTreatment`](EdgeTreatment.md)
+
+
+
+Top cap and adjoining side; omitted leaves the end untreated.
+
+
+## Related APIs
+
+- [EdgeTreatment](EdgeTreatment.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/ExtrudeOptions.md

@@ -0,0 +1,134 @@
+# ExtrudeOptions
+
+Dimensions and sampling shared by native and pure +Z extrusion.
+
+## Extends
+
+- [`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md)
+
+## Properties
+
+### height
+
+
+
+`readonly` **height**: `number`
+
+
+
+Positive extrusion height in millimetres.
+
+***
+
+### center?
+
+
+
+`readonly` `optional` **center?**: `boolean`
+
+
+
+Center the extrusion on Z; otherwise its bottom is at zero. Defaults to false.
+
+***
+
+### ends?
+
+
+
+`readonly` `optional` **ends?**: [`EndTreatments`](EndTreatments.md)
+
+
+
+Independent inward end treatments on straight convex single-contour extrusions.
+
+***
+
+### divisions?
+
+
+
+`readonly` `optional` **divisions?**: `number`
+
+
+
+Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+
+#### Inherited from
+
+[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`divisions`](ExtrusionSamplingOptions.md#divisions)
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+
+
+
+Explicit output and sampling allocation ceilings.
+
+#### Inherited from
+
+[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`limits`](ExtrusionSamplingOptions.md#limits)
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical policy over the nearest model scope.
+
+#### Inherited from
+
+[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`resolution`](ExtrusionSamplingOptions.md#resolution)
+
+***
+
+### scaleTop?
+
+
+
+`readonly` `optional` **scaleTop?**: `number` \| [`Vector2`](Vector2.md)
+
+
+
+Finite uniform or XY scale of the top profile; defaults to one.
+
+#### Inherited from
+
+[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`scaleTop`](ExtrusionSamplingOptions.md#scaletop)
+
+***
+
+### twistDegrees?
+
+
+
+`readonly` `optional` **twistDegrees?**: `number`
+
+
+
+Finite rotation of the top profile about +Z, in degrees; defaults to zero.
+
+#### Inherited from
+
+[`ExtrusionSamplingOptions`](ExtrusionSamplingOptions.md).[`twistDegrees`](ExtrusionSamplingOptions.md#twistdegrees)
+
+
+## Related APIs
+
+- [EndTreatments](EndTreatments.md)
+- [ExtrusionSamplingOptions](ExtrusionSamplingOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [ModelingLimits](ModelingLimits.md)
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/ExtrusionSamplingOptions.md

@@ -0,0 +1,77 @@
+# ExtrusionSamplingOptions
+
+Shared sampling controls for a twisted or scaled linear extrusion.
+
+## Extended by
+
+- [`ExtrudeOptions`](ExtrudeOptions.md)
+
+## Properties
+
+### divisions?
+
+
+
+`readonly` `optional` **divisions?**: `number`
+
+
+
+Exact number of intermediate profiles, nonnegative; overrides physical sampling.
+
+***
+
+### limits?
+
+
+
+`readonly` `optional` **limits?**: `Partial`\<[`ModelingLimits`](ModelingLimits.md)\>
+
+
+
+Explicit output and sampling allocation ceilings.
+
+***
+
+### resolution?
+
+
+
+`readonly` `optional` **resolution?**: [`GeometryResolution`](GeometryResolution.md)
+
+
+
+Operation-level physical policy over the nearest model scope.
+
+***
+
+### scaleTop?
+
+
+
+`readonly` `optional` **scaleTop?**: `number` \| [`Vector2`](Vector2.md)
+
+
+
+Finite uniform or XY scale of the top profile; defaults to one.
+
+***
+
+### twistDegrees?
+
+
+
+`readonly` `optional` **twistDegrees?**: `number`
+
+
+
+Finite rotation of the top profile about +Z, in degrees; defaults to zero.
+
+
+## Related APIs
+
+- [ExtrudeOptions](ExtrudeOptions.md)
+- [GeometryResolution](GeometryResolution.md)
+- [ModelingLimits](ModelingLimits.md)
+- [Vector2](Vector2.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/FittedTextLayout.md

@@ -0,0 +1,60 @@
+# FittedTextLayout
+
+Fitted immutable text whose visible ink bounds are known to be present.
+
+## Extends
+
+- [`VectorTextLayout`](VectorTextLayout.md)
+
+## Properties
+
+### metrics
+
+
+
+`readonly` **metrics**: [`VectorTextMetrics`](VectorTextMetrics.md) & `object`
+
+
+
+Transformed physical measurements, including nonempty visible ink bounds.
+
+#### Type Declaration
+
+##### bounds
+
+
+
+`readonly` **bounds**: [`Bounds2`](Bounds2.md)
+
+
+
+Finite positive-area ink bounds in final millimetres.
+
+#### Overrides
+
+[`VectorTextLayout`](VectorTextLayout.md).[`metrics`](VectorTextLayout.md#metrics)
+
+***
+
+### paths
+
+
+
+`readonly` **paths**: readonly `string`[]
+
+
+
+Nonzero-filled path data in millimetres, positive Y upward; empty for text with no ink.
+
+#### Inherited from
+
+[`VectorTextLayout`](VectorTextLayout.md).[`paths`](VectorTextLayout.md#paths)
+
+
+## Related APIs
+
+- [Bounds2](Bounds2.md)
+- [VectorTextLayout](VectorTextLayout.md)
+- [VectorTextMetrics](VectorTextMetrics.md)
+
+Package: `@metamesh/modeling@0.13.0`.

package/dist/docs/reference/geometry/Frame3.md

@@ -0,0 +1,58 @@
+# Frame3
+
+A right-handed orthonormal coordinate frame expressed in world coordinates.
+
+## Properties
+
+### origin
+
+
+
+`readonly` **origin**: [`Vector3`](Vector3.md)
+
+
+
+World-space origin of the local frame.
+
+***
+
+### xAxis
+
+
+
+`readonly` **xAxis**: [`Vector3`](Vector3.md)
+
+
+
+Unit vector defining the local +X axis.
+
+***
+
+### yAxis
+
+
+
+`readonly` **yAxis**: [`Vector3`](Vector3.md)
+
+
+
+Unit vector defining the local +Y axis.
+
+***
+
+### zAxis
+
+
+
+`readonly` **zAxis**: [`Vector3`](Vector3.md)
+
+
+
+Unit vector defining the local +Z axis.
+
+
+## Related APIs
+
+- [Vector3](Vector3.md)
+
+Package: `@metamesh/modeling@0.13.0`.