@metamesh/modeling 0.12.0 → 0.14.0

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

@@ -0,0 +1,65 @@
+# svgPathSection
+
+Imports bounded filled SVG path data.
+
+**svgPathSection**(`path`: `string`, `options?`: [`SvgPathSectionOptions`](SvgPathSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Fill an SVG path in millimetres
+
+```ts
+svgPathSection("M0 0H20V12H0Z", { origin: "center", scale: 1 });
+```
+
+## Parameters
+
+<a id="path"></a>
+
+**`path`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SvgPathSectionOptions`](SvgPathSectionOptions.md) · Optional
+
+- [`limits`](SvgPathSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`fillRule`](SvgPathSectionOptions.md#fillrule) · `"nonzero"` \| `"evenodd"` · Optional
+
+  Nonzero or even-odd filled-contour rule; defaults to nonzero.
+
+- [`resolution`](SvgPathSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`origin`](SvgPathSectionOptions.md#origin) · [`SvgOrigin`](SvgOrigin.md) · Optional
+
+  Center the painted bounds or preserve original path coordinates.
+
+- [`scale`](SvgPathSectionOptions.md#scale) · `number` · Optional
+
+  Positive uniform factor converting SVG user units to millimetres; defaults to one.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [SvgPathSectionOptions](SvgPathSectionOptions.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/svgSection.md

@@ -0,0 +1,64 @@
+# svgSection
+
+Imports bounded painted SVG document geometry.
+
+**svgSection**(`svg`: `string`, `options?`: [`SvgSectionOptions`](SvgSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Import a physical SVG rectangle
+
+```ts
+svgSection(
+  '<svg xmlns="http://www.w3.org/2000/svg" width="30mm" height="20mm" viewBox="0 0 30 20"><rect width="30" height="20"/></svg>',
+  { origin: "center" },
+);
+```
+
+## Parameters
+
+<a id="svg"></a>
+
+**`svg`** · `string` · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`SvgSectionOptions`](SvgSectionOptions.md) · Optional
+
+- [`limits`](SvgSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`circularSegments`](SvgSectionOptions.md#circularsegments) · `number` · Optional
+
+  Exact circular tessellation count overriding physical sampling.
+
+- [`resolution`](SvgSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+- [`origin`](SvgSectionOptions.md#origin) · [`SvgOrigin`](SvgOrigin.md) · Optional
+
+  Place the painted bounds around the origin or preserve document coordinates.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [SvgSectionOptions](SvgSectionOptions.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/sweep.md

@@ -0,0 +1,92 @@
+# sweep
+
+Sweeps explicit corresponding contours using the selected frame policy. Filled Sections use `section.sweep(path, options)`.
+
+**sweep**(`shape`: [`CorrespondingProfile`](CorrespondingProfile.md), `path`: readonly [`Vector3Tuple`](Vector3Tuple.md)[], `options?`: [`SweepOptions`](SweepOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Sweep
+
+```ts
+import { matchProfiles, sweep } from "@metamesh/modeling";
+import { rectangleProfile } from "@metamesh/modeling/geometry";
+
+const [profile] = matchProfiles([rectangleProfile({ size: [6, 3] })]);
+sweep(profile!, [[0, 0, 0], [0, 0, 15], [10, 0, 25]], {
+  orientation: { kind: "transport", initialNormal: [0, 1, 0] },
+});
+```
+
+## Parameters
+
+<a id="shape"></a>
+
+**`shape`** · [`CorrespondingProfile`](CorrespondingProfile.md) · Required
+
+
+
+<a id="path"></a>
+
+**`path`** · readonly [`Vector3Tuple`](Vector3Tuple.md)[] · Required
+
+
+
+<a id="options"></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
+
+- [CorrespondingProfile](CorrespondingProfile.md)
+- [Solid](Solid.md)
+- [SweepOptions](SweepOptions.md)
+- [Vector3Tuple](Vector3Tuple.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.14.0`.

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

@@ -0,0 +1,57 @@
+# textSection
+
+Consumes a previously prepared layout; never shapes or fetches a font.
+
+**textSection**(`layout`: [`VectorTextLayout`](VectorTextLayout.md), `options?`: [`TextSectionOptions`](TextSectionOptions.md)): [`Section`](Section.md)
+
+
+
+## Example: Use a prepared text layout
+
+```ts
+// Prepare the exact font and layout before entering build.
+function labelSection(layout: VectorTextLayout) {
+  return textSection(layout);
+}
+```
+
+## Parameters
+
+<a id="layout"></a>
+
+**`layout`** · [`VectorTextLayout`](VectorTextLayout.md) · Required
+
+
+
+<a id="options"></a>
+
+**`options`** · [`TextSectionOptions`](TextSectionOptions.md) · Optional
+
+- [`limits`](TextSectionOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Local allocation ceilings may only lower the configured engine policy.
+
+- [`resolution`](TextSectionOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Local physical sampling policy; exact interval counts take precedence.
+
+
+
+## Returns
+
+[`Section`](Section.md)
+
+
+## Related APIs
+
+- [Section](Section.md)
+- [TextSectionOptions](TextSectionOptions.md)
+- [VectorTextLayout](VectorTextLayout.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/threadRidge.md

@@ -0,0 +1,72 @@
+# threadRidge
+
+Helical ridge mesh construction.
+
+**threadRidge**(`options`: [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`HelicalThreadRidgeMeshOptions`](HelicalThreadRidgeMeshOptions.md) · Required
+
+- [`length`](HelicalThreadRidgeMeshOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`majorDiameter`](HelicalThreadRidgeMeshOptions.md#majordiameter) · `number` · Required
+
+  Nominal major diameter before any caller-owned fit compensation.
+
+- [`profile`](HelicalThreadRidgeMeshOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`ends`](HelicalThreadRidgeMeshOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](HelicalThreadRidgeMeshOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](HelicalThreadRidgeMeshOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](HelicalThreadRidgeMeshOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](HelicalThreadRidgeMeshOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](HelicalThreadRidgeMeshOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](HelicalThreadRidgeMeshOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [HelicalThreadRidgeMeshOptions](HelicalThreadRidgeMeshOptions.md)
+- [Solid](Solid.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,110 @@
+# threadedNut
+
+Compensated threaded nut.
+
+**threadedNut**(`options`: [`ThreadedNutOptions`](ThreadedNutOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Threaded nut
+
+```ts
+import { threadedNut } from "@metamesh/modeling";
+import { createThreadProfile } from "@metamesh/modeling/geometry";
+
+const profile = createThreadProfile({ kind: "triangular", pitch: 1.75 });
+threadedNut({ nominalMajorDiameter: 12, thickness: 8, width: 20, shape: "hex", profile, fit: "normal" });
+```
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ThreadedNutOptions`](ThreadedNutOptions.md) · Required
+
+- [`profile`](ThreadedNutOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](ThreadedNutOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before female compensation and faceting correction.
+
+- [`shape`](ThreadedNutOptions.md#shape) · [`ThreadedNutShape`](ThreadedNutShape.md) · Required
+
+  Nut body shape.
+
+- [`thickness`](ThreadedNutOptions.md#thickness) · `number` · Required
+
+  Nut thickness along +Z in millimetres.
+
+- [`width`](ThreadedNutOptions.md#width) · `number` · Required
+
+  Across-flats width for hex/square or diameter for round, in millimetres.
+
+- [`ends`](ThreadedNutOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](ThreadedNutOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](ThreadedNutOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](ThreadedNutOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](ThreadedNutOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](ThreadedNutOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](ThreadedNutOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`fit`](ThreadedNutOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+- [`bevel`](ThreadedNutOptions.md#bevel) · [`ThreadedNutBevel`](ThreadedNutBevel.md) · Optional
+
+  Nut body bevel selection. Default: `automatic`.
+
+- [`bodyResolution`](ThreadedNutOptions.md#bodyresolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional physical policy for a round body, independent of the thread's matched facet grid.
+
+- [`chamferSize`](ThreadedNutOptions.md#chamfersize) · `number` · Optional
+
+  45-degree body chamfer extent. Default: `min(profile.depth, thickness/4)`.
+
+- [`flushBuildPlateBottom`](ThreadedNutOptions.md#flushbuildplatebottom) · `boolean` · Optional
+
+  Leave the bottom outside edge flat for build-plate adhesion. Default: `false`.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [ThreadedNutOptions](ThreadedNutOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,99 @@
+# threadedRod
+
+Compensated external threaded rod.
+
+**threadedRod**(`options`: [`ThreadedRodOptions`](ThreadedRodOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Threaded rod
+
+```ts
+import { threadedRod } from "@metamesh/modeling";
+import { createThreadProfile } from "@metamesh/modeling/geometry";
+
+const profile = createThreadProfile({ kind: "triangular", pitch: 1.75 });
+threadedRod({ nominalMajorDiameter: 12, length: 24, profile, fit: "normal" });
+```
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`ThreadedRodOptions`](ThreadedRodOptions.md) · Required
+
+- [`length`](ThreadedRodOptions.md#length) · `number` · Required
+
+  Total threaded axial length in millimetres.
+
+- [`profile`](ThreadedRodOptions.md#profile) · [`ThreadProfile`](ThreadProfile.md) · Required
+
+  Validated periodic profile repeated around the shaft.
+
+- [`nominalMajorDiameter`](ThreadedRodOptions.md#nominalmajordiameter) · `number` · Required
+
+  Nominal major diameter before male compensation.
+
+- [`ends`](ThreadedRodOptions.md#ends) · [`ThreadEndTreatmentOptions`](ThreadEndTreatmentOptions.md) · Optional
+
+  Optional bottom/top ridge-end treatments. Standalone ridges honor the requested boundaries;
+  BOSL2-style non-cut lead-in scaling is available on complete thread solids.
+
+- [`handedness`](ThreadedRodOptions.md#handedness) · [`ThreadHandedness`](ThreadHandedness.md) · Optional
+
+  Helix direction. Default: `right`.
+
+- [`limits`](ThreadedRodOptions.md#limits) · `Partial`\<[`ModelingLimits`](ModelingLimits.md)\> · Optional
+
+  Explicit output and circular allocation ceilings.
+
+- [`phaseDegrees`](ThreadedRodOptions.md#phasedegrees) · `number` · Optional
+
+  Angular offset of the first start in degrees. Default: `0`.
+
+- [`resolution`](ThreadedRodOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Optional circular-resolution policy.
+
+- [`starts`](ThreadedRodOptions.md#starts) · `number` · Optional
+
+  Number of evenly phased starts. Default: `1`.
+
+- [`tolerance`](ThreadedRodOptions.md#tolerance) · [`GeometryToleranceOptions`](GeometryToleranceOptions.md) · Optional
+
+  Optional numerical tolerance overrides.
+
+- [`bevelBottom`](ThreadedRodOptions.md#bevelbottom) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=0.
+
+- [`bevelSize`](ThreadedRodOptions.md#bevelsize) · `number` · Optional
+
+  Axial bevel extent in millimetres. Active blunt ends default to one sixth of the compensated
+  male minor radius or female major radius; other ends default to the profile depth.
+
+- [`bevelTop`](ThreadedRodOptions.md#beveltop) · `boolean` · Optional
+
+  Apply a 45-degree bevel at Z=length.
+
+- [`fit`](ThreadedRodOptions.md#fit) · [`PrintableThreadFit`](PrintableThreadFit.md) \| [`PrintableThreadFitPolicy`](PrintableThreadFitPolicy.md) · Optional
+
+  Printable fit or caller-calibrated allowances. Default: `normal`.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [ThreadedRodOptions](ThreadedRodOptions.md)
+
+## Guides
+
+- [Build printable threads](https://metamesh.studio/docs/develop/printable-threads#build-the-first-mating-pair)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,27 @@
+# toTriangleMesh
+
+Copies a handle to manufacturing mesh buffers.
+
+**toTriangleMesh**(`solid`: [`Solid`](Solid.md)): [`TriangleMesh`](TriangleMesh.md)
+
+
+
+## Parameters
+
+<a id="solid"></a>
+
+**`solid`** · [`Solid`](Solid.md) · Required
+
+
+
+## Returns
+
+[`TriangleMesh`](TriangleMesh.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TriangleMesh](TriangleMesh.md)
+
+Package: `@metamesh/modeling@0.14.0`.

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

@@ -0,0 +1,70 @@
+# torus
+
+Torus around +Z.
+
+**torus**(`options`: [`TorusOptions`](TorusOptions.md)): [`Solid`](Solid.md)
+
+
+
+## Example: Torus
+
+
+
+```ts
+torus({ majorRadius: 12, minorRadius: 3 });
+```
+
+
+
+## Parameters
+
+<a id="options"></a>
+
+**`options`** · [`TorusOptions`](TorusOptions.md) · Required
+
+- [`majorRadius`](TorusOptions.md#majorradius) · `number` · Required
+
+  Radius from the Z axis to the profile center, in millimetres; greater than `minorRadius`.
+
+- [`minorRadius`](TorusOptions.md#minorradius) · `number` · Required
+
+  Radius of the swept circular profile in millimetres.
+
+- [`placement`](TorusOptions.md#placement) · [`PrimitivePlacementOptions`](PrimitivePlacementOptions.md) · Optional
+
+  Applied after local construction; Section placement must preserve the XY plane.
+
+- [`limits`](TorusOptions.md#limits) · `Partial`\<[`GeometrySamplingLimits`](GeometrySamplingLimits.md)\> · Optional
+
+  Explicit sampling ceilings, bounded by the host policy.
+
+- [`majorSegments`](TorusOptions.md#majorsegments) · `number` · Optional
+
+  Exact segment count around the Z axis; omitted uses adaptive resolution.
+
+- [`minorSegments`](TorusOptions.md#minorsegments) · `number` · Optional
+
+  Exact segment count around the swept profile; omitted uses adaptive resolution.
+
+- [`resolution`](TorusOptions.md#resolution) · [`GeometryResolution`](GeometryResolution.md) · Optional
+
+  Operation-level physical tessellation policy over the active model-wide policy.
+
+
+
+## Returns
+
+[`Solid`](Solid.md)
+
+
+## Related APIs
+
+- [Solid](Solid.md)
+- [TorusOptions](TorusOptions.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.14.0`.

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

@@ -0,0 +1,39 @@
+# transform2
+
+Creates an immutable XY transform, identity by default. Matrices are copied and validated. Pass it directly to Section.transform() and planar data helpers; to3D() explicitly crosses into XYZ. Zero scales and singular matrices throw GeometryError; negative scales reflect.
+
+**transform2**(`matrix?`: [`Transform2Matrix`](Transform2Matrix.md)): [`Transform2`](Transform2-type.md)
+
+
+
+## Example
+
+```ts
+const placement = transform2().rotate(90).translate([10, 0]);
+placement.applyPoint([1, 0]).toArray(); // approximately [10, 1]
+```
+
+## Parameters
+
+<a id="matrix"></a>
+
+**`matrix`** · [`Transform2Matrix`](Transform2Matrix.md) · Optional
+
+
+
+## Returns
+
+[`Transform2`](Transform2-type.md)
+
+
+## Related APIs
+
+- [Transform2](Transform2-type.md)
+- [Transform2Matrix](Transform2Matrix.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)
+
+Package: `@metamesh/modeling@0.14.0`.