fluidcad 0.0.32 → 0.0.34

package/llm-docs/api/split-trim.md

@@ -0,0 +1,42 @@
+---
+id: api/split-trim
+title: split / trim
+summary: Sketch-level cleanup. `split` breaks intersecting geometries at their crossings; `trim` discards the unwanted segments.
+tags: [api, 2d, modifier]
+symbols: [split, trim]
+seeAlso: [api/sketch, api/edge-filter]
+---
+
+# split / trim
+
+Imported from `fluidcad/core`.
+
+```ts
+split()                                  // split all intersecting geometries
+split(...objects)
+
+trim()                                   // trim all segments at crossings
+trim(...filters: EdgeFilter[])           // trim segments matching the filters
+```
+
+Both run inside a sketch context. `split` keeps every piece around so
+you can reference them individually; `trim` keeps only the segments you
+want, discarding the others. Pair `trim(...)` with an
+[[api/edge-filter]] to target specific segments by length, orientation,
+or parent.
+
+## Example
+
+```fluid.js
+import { circle, extrude, hLine, sketch, trim } from "fluidcad/core";
+import { edge } from "fluidcad/filters";
+
+sketch("xy", () => {
+  circle(50);
+  hLine([50, 0], 100);        // cuts the circle in half
+  trim(edge().line());        // drop the line, keep the circle halves
+});
+extrude(2);
+```
+
+See [[api/edge-filter]] for the filter language `trim` uses.

package/llm-docs/api/sweep.md

@@ -0,0 +1,43 @@
+---
+id: api/sweep
+title: sweep(path)
+summary: Sweeps the active sketch (profile) along a path sketch. The profile is consumed implicitly; the path is passed explicitly.
+tags: [api, 3d, solid]
+symbols: [sweep]
+seeAlso: [api/sketch, api/extrude, api/loft, api/revolve]
+---
+
+# sweep
+
+Imported from `fluidcad/core`.
+
+```ts
+sweep(path: SceneObject)                              // sweep last sketch along path
+sweep(path: SceneObject, target?: SceneObject)
+```
+
+Returns `Sweep` (extends `BooleanOperation`). Chain: `.draft()`,
+`.endOffset()`, `.drill()`, `.pick()`, `.thin()`, plus boolean scope
+methods. Direct accessors mirror `extrude`: `startFaces`, `endFaces`,
+`sideFaces`, etc.
+
+The path is typically a reusable sketch (open or closed wire) or an
+edge selection. The profile is whatever sketch was last opened — usually
+on a plane perpendicular to the path's start tangent.
+
+## Example
+
+```fluid.js
+import { arc, circle, line, sketch, sweep } from "fluidcad/core";
+
+const path = sketch("xy", () => {
+  line([0, 0], [100, 0]);
+  arc([200, 100]).radius(150);
+}).reusable();
+
+sketch("yz", () => circle(8));
+sweep(path);
+```
+
+See [[api/loft]] for blending between distinct profiles and
+[[api/revolve]] for axis-driven sweeps.

package/llm-docs/api/tarc.md

@@ -0,0 +1,45 @@
+---
+id: api/tarc
+title: tArc — tangent arc
+summary: The most flexible constrained primitive. Tangent-continues from the previous geometry; can target a point, a curve, or thread between two curves.
+tags: [api, 2d, constrained, curve]
+symbols: [tArc]
+seeAlso: [api/tline, api/tcircle, api/arc]
+---
+
+# tArc
+
+Imported from `fluidcad/core`.
+
+```ts
+tArc(target: SceneObject | QualifiedGeometry)            // ends tangent to target curve
+tArc(radius, target)                                     // arc of given radius to target
+tArc(radius?, endAngle?)                                 // defaults: radius 100, sweep 90°
+tArc(radius, angle, tangent: Point2D)                    // explicit start tangent
+tArc(endPoint: Point2D)                                  // tangent arc to a point
+tArc(endPoint, tangent)                                  // with end tangent
+tArc(startPoint, endPoint, tangent)
+tArc(c1: SceneObject, c2: SceneObject, radius, mustTouch?)
+tArc(c1: Point2D, c2: Point2D, radius, mustTouch?)
+```
+
+Defaults: radius `100`, end angle `90°`. Negative radius flips sweep
+direction. Chain `.flip()` to curve to the right of the start tangent
+instead of the left.
+
+## Example
+
+```fluid.js
+import { connect, extrude, hLine, sketch, tArc } from "fluidcad/core";
+
+sketch("xy", () => {
+  hLine(40);
+  tArc(20, 180);            // half-circle of radius 20, tangent to the hLine
+  hLine(-40);
+  connect();
+});
+extrude(3);
+```
+
+See [[api/tline]] for tangent lines and [[api/arc]] for unconstrained
+arcs.

package/llm-docs/api/tcircle.md

@@ -0,0 +1,38 @@
+---
+id: api/tcircle
+title: tCircle — tangent circle
+summary: Full circle of given diameter tangent to two objects (or threading two points). Use qualifiers to disambiguate among the up-to-8 valid solutions.
+tags: [api, 2d, constrained, curve]
+symbols: [tCircle]
+seeAlso: [api/tline, api/tarc, api/circle]
+---
+
+# tCircle
+
+Imported from `fluidcad/core`.
+
+```ts
+tCircle(c1, c2, diameter, mustTouch?)
+tCircle(c1: QualifiedGeometry, c2: QualifiedGeometry, diameter, mustTouch?)
+tCircle(c1: Point2D, c2: Point2D, diameter, mustTouch?)
+```
+
+Returns a full circle (`ExtrudableGeometry`) of the given diameter
+tangent to both targets. Up to 8 solutions exist for two circles —
+narrow with `outside` / `enclosing` / `enclosed` qualifiers and/or
+`mustTouch: true`.
+
+## Example
+
+```fluid.js
+import { outside } from "fluidcad/constraints";
+
+sketch("xy", () => {
+  const c1 = circle([0, 0], 40).reusable();
+  const c2 = circle([100, 0], 40).reusable();
+  tCircle(outside(c1), outside(c2), 20);
+});
+extrude(2);
+```
+
+See [[api/tline]] and [[api/tarc]] for tangent lines and arcs.

package/llm-docs/api/tline.md

@@ -0,0 +1,42 @@
+---
+id: api/tline
+title: tLine — tangent line
+summary: Constrained tangent line — between two curves, from the cursor to one curve, or continuing the previous geometry's tangent.
+tags: [api, 2d, constrained, curve]
+symbols: [tLine]
+seeAlso: [api/tarc, api/tcircle, api/cursor-lines]
+---
+
+# tLine
+
+Imported from `fluidcad/core`.
+
+```ts
+tLine(distance)                                          // continue tangent to previous geometry
+tLine(c1: SceneObject, c2: SceneObject, mustTouch?)      // between two objects
+tLine(c1: QualifiedGeometry, c2: QualifiedGeometry, mustTouch?)
+tLine(c1, mustTouch?)                                    // tangent to one object from cursor
+```
+
+Returns `Geometry` (one-arg form) or `TwoObjectsTangentLine` with
+`.start()`, `.end()`, and `.tangent()` vertices.
+
+Multiple tangent lines exist between two curves — disambiguate with
+`outside()`, `enclosing()`, or `enclosed()` qualifiers (see Phase 11
+slice 4 once they land).
+
+## Example
+
+```fluid.js
+import { circle, extrude, sketch, tLine } from "fluidcad/core";
+
+sketch("xy", () => {
+  const c1 = circle([0, 0], 30).reusable();
+  const c2 = circle([100, 0], 20).reusable();
+  tLine(c1, c2);
+});
+extrude(2);
+```
+
+See [[api/tarc]] for tangent arcs and [[api/tcircle]] for tangent
+circles.

package/llm-docs/api/translate.md

@@ -0,0 +1,40 @@
+---
+id: api/translate
+title: translate(x, y?, z?, ...targets?)
+summary: "Moves one or more objects by a vector. With no targets, operates on the last object. Pass `copy: true` to clone instead of moving."
+tags: [api, 3d, transform]
+symbols: [translate]
+seeAlso: [api/rotate, api/mirror, api/copy]
+---
+
+# translate
+
+Imported from `fluidcad/core`.
+
+```ts
+translate(x, ...targets)
+translate(x, y, ...targets)
+translate(x, y, z, ...targets)
+translate(point: PointLike, ...targets)
+translate(x, y, z, copy: boolean, ...targets)    // copy flag at any arity
+```
+
+Returns the translated `SceneObject`. With no explicit target it operates
+on the last object — the same implicit-context model as the rest of the
+API.
+
+The `copy: true` overload duplicates the source rather than moving it,
+producing a new independent object. Use it for one-off duplicates; for
+patterns use [[api/copy]] or [[api/repeat]].
+
+## Example
+
+```fluid.js
+import { sphere, translate } from "fluidcad/core";
+
+const s = sphere(15);
+translate(0, 0, 60, s);                          // lift the sphere by 60
+```
+
+See [[api/rotate]] for rotations and [[api/copy]] for snapshot
+duplication patterns.

package/llm-docs/api/types/aline.md

@@ -0,0 +1,35 @@
+---
+id: api/types/aline
+title: ALine
+summary: "The ALine type. Extends Geometry; adds 1 method."
+tags: [api, type, interface]
+symbols: [ALine, IALine]
+seeAlso: [api/line, api/types/geometry]
+---
+# ALine
+
+```ts
+interface ALine extends Geometry {
+  centered(value?: boolean): this;
+}
+```
+
+Extends [[api/types/geometry]].
+
+## Methods
+
+### `centered()`
+
+Controls whether the line is centered on the current position.
+When `true`, the line is offset backward by half its length so that the
+current position falls at its midpoint.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `boolean` | `true` to center, `false` (default) to start from the current position. *(optional)* |
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/arc-angles.md

@@ -0,0 +1,29 @@
+---
+id: api/types/arc-angles
+title: ArcAngles
+summary: "The ArcAngles type. Extends ExtrudableGeometry; adds 1 method."
+tags: [api, type, interface]
+symbols: [ArcAngles, IArcAngles]
+seeAlso: [api/arc, api/types/extrudable-geometry]
+---
+# ArcAngles
+
+```ts
+interface ArcAngles extends ExtrudableGeometry {
+  centered(): this;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `centered()`
+
+Centers the arc symmetrically around the start angle.
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/arc-points.md

@@ -0,0 +1,48 @@
+---
+id: api/types/arc-points
+title: ArcPoints
+summary: "The ArcPoints type. Extends ExtrudableGeometry; adds 2 methods."
+tags: [api, type, interface]
+symbols: [ArcPoints, IArcPoints]
+seeAlso: [api/arc, api/types/extrudable-geometry]
+---
+# ArcPoints
+
+```ts
+interface ArcPoints extends ExtrudableGeometry {
+  radius(value: number): IArcRadius;
+  center(value: Point2DLike): IArcCenter;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `radius()`
+
+Sets the bulge radius for point-to-point arcs.
+Positive = CCW, negative = CW.
+
+**Returns**: `IArcRadius`.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `number` | The bulge radius. |
+
+### `center()`
+
+Specifies the circle center point for the arc.
+Mutually exclusive with `.radius()`.
+
+**Returns**: `IArcCenter`.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | [[api/types/point2dlike]] | The center point of the arc's circle. |
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/axis-like.md

@@ -0,0 +1,38 @@
+---
+id: api/types/axis-like
+title: AxisLike
+summary: "An axis reference accepted by revolve(), repeat(), and other axis-based operations."
+tags: [api, type, union]
+symbols: [AxisLike, AxisObjectBase]
+seeAlso: [api/revolve, api/axis, api/types/axis]
+---
+# AxisLike
+
+```ts
+type AxisLike = StandardAxis | Axis | IAxis | AxisObjectBase;
+```
+
+An axis reference used by `revolve()` and other axis-based operations. Any of the following formats are accepted:
+
+| Format | Example | Description |
+| --- | --- | --- |
+| Standard axis string | `"x"`, `"y"`, `"z"` | The three principal axes. |
+| [[api/types/axis]] | `axis("x", [0, 10])` | An axis object created with `axis()`. |
+
+## Example
+
+```fluid.js
+import { sketch, rect, move, revolve, axis } from "fluidcad/core";
+
+sketch("xz", () => {
+  move([20, 0]);
+  rect(10, 30);
+});
+revolve("z", 360);             // string form
+
+sketch("xz", () => {
+  move([30, 0]);
+  rect(5, 5);
+});
+revolve(axis("z"), 180);       // Axis form
+```

package/llm-docs/api/types/axis.md

@@ -0,0 +1,21 @@
+---
+id: api/types/axis
+title: Axis
+summary: "The Axis type. Extends SceneObject."
+tags: [api, type, interface]
+symbols: [Axis, IAxis]
+seeAlso: [api/axis, api/types/axis-like, api/types/scene-object]
+---
+# Axis
+
+```ts
+interface Axis extends SceneObject {
+  // No own methods — see Inherited below.
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/boolean-operation.md

@@ -0,0 +1,50 @@
+---
+id: api/types/boolean-operation
+title: BooleanOperation
+summary: "The BooleanOperation type. Extends SceneObject; adds 4 methods."
+tags: [api, type, interface]
+symbols: [BooleanOperation, IBooleanOperation]
+seeAlso: [api/types/scene-object, concepts/scene-graph]
+---
+# BooleanOperation
+
+```ts
+interface BooleanOperation extends SceneObject {
+  add(): this;
+  'new'(): this;
+  remove(): this;
+  scope(...objects: SceneObject[]): this;
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Methods
+
+### `add()`
+
+Additive boolean operation — fuses the result with all intersecting scene objects.
+Use `.scope()` to target specific objects.
+
+### `'new'()`
+
+No boolean operation — keeps the result as a standalone shape,
+separate from all other scene objects.
+
+### `remove()`
+
+Subtractive boolean operation — cuts the result from all intersecting scene objects.
+Use `.scope()` to target specific objects.
+
+### `scope()`
+
+Narrows the boolean operation scope to specific target objects.
+Must be chained after `.add()` or `.remove()`.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...objects` | [[api/types/scene-object]][] | The target objects to operate on. *(optional)* |
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/circular-repeat-options.md

@@ -0,0 +1,31 @@
+---
+id: api/types/circular-repeat-options
+title: CircularRepeatOptions
+summary: "Options for `repeat(\"circular\", ...)`."
+tags: [api, type, options]
+symbols: [CircularRepeatOptions]
+seeAlso: [api/repeat]
+---
+# CircularRepeatOptions
+
+```ts
+type CircularRepeatOptions = {
+  count: number;
+  angle?: number;
+  offset?: number;
+  centered?: boolean;
+  skip?: number[];
+};
+```
+
+Options accepted by the circular variant of `repeat()`. Controls how many copies are placed and how they sweep around the chosen axis.
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `count` | `number` | Number of instances (including the original) |
+| `angle` | `number` | Total angle to spread across. Cannot be used with `offset`. *(optional)* |
+| `offset` | `number` | Angle between each instance. Cannot be used with `angle`. *(optional)* |
+| `centered` | `boolean` | When `true`, centers the pattern around the original object's position *(optional)* |
+| `skip` | `number`[] | Indices to skip (e.g. `[2, 4]` to skip the 3rd and 5th instances) *(optional)* |

package/llm-docs/api/types/common.md

@@ -0,0 +1,32 @@
+---
+id: api/types/common
+title: Common
+summary: "The Common type. Extends SceneObject; adds 1 method."
+tags: [api, type, interface]
+symbols: [Common, ICommon]
+seeAlso: [api/booleans, api/types/scene-object]
+---
+# Common
+
+```ts
+interface Common extends SceneObject {
+  keepOriginal(value?: boolean): this;
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Methods
+
+### `keepOriginal()`
+
+Controls whether the original objects involved in the boolean intersection
+are retained or removed after the operation.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `boolean` | `true` to keep originals, `false` (default) to remove them. *(optional)* |
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/cut.md

@@ -0,0 +1,125 @@
+---
+id: api/types/cut
+title: Cut
+summary: "The Cut type. Extends SceneObject; adds 10 methods."
+tags: [api, type, interface]
+symbols: [Cut, ICut]
+seeAlso: [api/cut, api/types/scene-object]
+---
+# Cut
+
+```ts
+interface Cut extends SceneObject {
+  symmetric(): this;
+  scope(...objects: SceneObject[]): this;
+  draft(value: number | [number, number]): this;
+  endOffset(value: number): this;
+  startEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  endEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  internalEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  internalFaces(...args: (number | FaceFilter)[]): SceneObject;
+  pick(...points: Point2DLike[]): this;
+  thin(offset: number): this;
+  thin(offset1: number, offset2: number): this;
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Methods
+
+### `symmetric()`
+
+Enables symmetric mode — cuts equally in both directions from the sketch plane.
+
+### `scope()`
+
+Narrows the cut scope to specific target objects.
+Must be chained after `.remove()`.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...objects` | [[api/types/scene-object]][] | The target objects to cut from. *(optional)* |
+
+### `draft()`
+
+Applies a draft (taper) angle to the cut walls.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `number` \| `[number, number]` | A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft. |
+
+### `endOffset()`
+
+Offsets the cut end face by a specified distance along the cut direction.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `number` | The offset distance. |
+
+### `startEdges()`
+
+Selects edges at the start of the cut path, classified by signed distance from the cut plane.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `endEdges()`
+
+Selects edges at the end of the cut path, classified by signed distance from the cut plane.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalEdges()`
+
+Selects internal edges created by the cut that are not on the cut plane boundary.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalFaces()`
+
+Selects internal faces exposed by the cut — newly created surfaces not from the original stock.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `pick()`
+
+Restricts the cut to only the sketch regions containing the given points.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...points` | [[api/types/point2dlike]][] | 2D points in the sketch plane identifying regions to cut. *(optional)* |
+
+### `thin()`
+
+```ts
+thin(offset: number): this
+thin(offset1: number, offset2: number): this
+```
+
+Enables thin cut mode — offsets the profile edges to cut a thin-walled shape
+instead of cutting filled faces. Positive values offset outward, negative values offset inward.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `offset1` | `number` | The first wall offset distance. Positive = outward, negative = inward. |
+| `offset2` | `number` | The second wall offset distance, in the opposite direction of offset1. |
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/draft.md

@@ -0,0 +1,21 @@
+---
+id: api/types/draft
+title: Draft
+summary: "The Draft type. Extends SceneObject."
+tags: [api, type, interface]
+symbols: [Draft, IDraft]
+seeAlso: [api/draft, api/types/scene-object]
+---
+# Draft
+
+```ts
+interface Draft extends SceneObject {
+  // No own methods — see Inherited below.
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`