fluidcad 0.0.32 → 0.0.34

package/llm-docs/api/types/extrudable-geometry.md

@@ -0,0 +1,23 @@
+---
+id: api/types/extrudable-geometry
+title: ExtrudableGeometry
+summary: "The ExtrudableGeometry type. Extends Geometry."
+tags: [api, type, interface]
+symbols: [ExtrudableGeometry, IExtrudableGeometry]
+seeAlso: [api/types/geometry, api/extrude]
+---
+# ExtrudableGeometry
+
+```ts
+interface ExtrudableGeometry extends Geometry {
+  // No own methods — see Inherited below.
+}
+```
+
+Extends [[api/types/geometry]].
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,194 @@
+---
+id: api/types/extrude
+title: Extrude
+summary: "The Extrude type. Extends BooleanOperation; adds 16 methods."
+tags: [api, type, interface]
+symbols: [Extrude, IExtrude]
+seeAlso: [api/extrude, api/types/boolean-operation]
+---
+# Extrude
+
+```ts
+interface Extrude extends BooleanOperation {
+  symmetric(): this;
+  startFaces(...args: (number | FaceFilter)[]): SceneObject;
+  endFaces(...args: (number | FaceFilter)[]): SceneObject;
+  startEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  endEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  sideFaces(...args: (number | FaceFilter)[]): SceneObject;
+  sideEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  internalFaces(...args: (number | FaceFilter)[]): SceneObject;
+  internalEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  capFaces(...args: (number | FaceFilter)[]): SceneObject;
+  capEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  draft(value: number | [number, number]): this;
+  endOffset(value: number): this;
+  drill(value?: boolean): this;
+  pick(...points: Point2DLike[]): this;
+  thin(offset: number): this;
+  thin(offset1: number, offset2: number): this;
+}
+```
+
+Extends [[api/types/boolean-operation]].
+
+## Methods
+
+### `symmetric()`
+
+Enables symmetric mode — extrudes equally in both directions from the sketch plane.
+
+### `startFaces()`
+
+Selects faces at the start (base) of the extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `endFaces()`
+
+Selects faces at the end (cap) of the extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `startEdges()`
+
+Selects edges on the start (base) faces of the extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `endEdges()`
+
+Selects edges on the end (cap) faces of the extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `sideFaces()`
+
+Selects the lateral faces created by the extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `sideEdges()`
+
+Selects edges on the side faces, excluding edges shared with start/end faces.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalFaces()`
+
+Selects faces created inside the solid during extrusion (e.g., from holes or intersections).
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalEdges()`
+
+Selects edges bounding the internal geometry created during extrusion.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `capFaces()`
+
+Selects the cap faces at the open ends of a thin-walled extrusion from an open profile.
+These are the small faces connecting the inner and outer walls at the profile endpoints.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `capEdges()`
+
+Selects edges on the cap faces of a thin-walled extrusion from an open profile.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `draft()`
+
+Applies a draft (taper) angle to the extrusion 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 end face by a specified distance along the extrusion direction.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `number` | The offset distance. |
+
+### `drill()`
+
+Enables or disables drill mode, which partitions the sketch into face regions
+before extruding.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `boolean` | `true` to enable (default), `false` to disable. *(optional)* |
+
+### `pick()`
+
+Restricts extrusion 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 extrude. *(optional)* |
+
+### `thin()`
+
+```ts
+thin(offset: number): this
+thin(offset1: number, offset2: number): this
+```
+
+Enables thin extrude mode — offsets the profile edges to create a thin-walled solid
+instead of extruding 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/boolean-operation]]: `add()`, `'new'()`, `remove()`, `scope()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,51 @@
+---
+id: api/types/geometry
+title: Geometry
+summary: "The Geometry type. Extends SceneObject; adds 4 methods."
+tags: [api, type, interface]
+symbols: [Geometry, IGeometry]
+seeAlso: [api/types/scene-object]
+---
+# Geometry
+
+```ts
+interface Geometry extends SceneObject {
+  guide(): this;
+  start(): Vertex;
+  end(): Vertex;
+  tangent(): Vertex;
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Methods
+
+### `guide()`
+
+Marks this sketch geometry as construction geometry. Guide geometries are
+excluded from the final sketch output (e.g., extrude, revolve) unless
+explicitly included.
+
+### `start()`
+
+Returns a lazy-evaluated vertex at the start point of this geometry element.
+
+**Returns**: [[api/types/vertex]].
+
+### `end()`
+
+Returns a lazy-evaluated vertex at the end point of this geometry element.
+
+**Returns**: [[api/types/vertex]].
+
+### `tangent()`
+
+Returns a lazy-evaluated vertex representing the tangent direction at the end
+of this geometry. Used to determine the direction of subsequent geometry elements.
+
+**Returns**: [[api/types/vertex]].
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,35 @@
+---
+id: api/types/hline
+title: HLine
+summary: "The HLine type. Extends Geometry; adds 1 method."
+tags: [api, type, interface]
+symbols: [HLine, IHLine]
+seeAlso: [api/line, api/types/geometry]
+---
+# HLine
+
+```ts
+interface HLine 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/linear-repeat-options.md

@@ -0,0 +1,31 @@
+---
+id: api/types/linear-repeat-options
+title: LinearRepeatOptions
+summary: "Options for `repeat(\"linear\", ...)`."
+tags: [api, type, options]
+symbols: [LinearRepeatOptions]
+seeAlso: [api/repeat]
+---
+# LinearRepeatOptions
+
+```ts
+type LinearRepeatOptions = {
+  count: number | number[];
+  offset?: number | number[];
+  length?: number | number[];
+  centered?: boolean;
+  skip?: number[][];
+};
+```
+
+Options accepted by the linear variant of `repeat()`. Controls how many copies are placed and how they are spaced along the chosen axes.
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `count` | `number` \| `number`[] | Number of instances per axis (including the original) |
+| `offset` | `number` \| `number`[] | Spacing between each instance. Cannot be used with `length`. *(optional)* |
+| `length` | `number` \| `number`[] | Total span to distribute instances across (evenly spaced). Cannot be used with `offset`. *(optional)* |
+| `centered` | `boolean` | When `true`, centers the pattern around the original object's position *(optional)* |
+| `skip` | `number`[][] | Index tuples to skip (e.g. `[[1], [3]]` for single axis, `[[1, 2]]` for multi-axis) *(optional)* |

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

@@ -0,0 +1,154 @@
+---
+id: api/types/loft
+title: Loft
+summary: "The Loft type. Extends BooleanOperation; adds 11 methods."
+tags: [api, type, interface]
+symbols: [Loft, ILoft]
+seeAlso: [api/loft, api/types/boolean-operation]
+---
+# Loft
+
+```ts
+interface Loft extends BooleanOperation {
+  startFaces(...args: (number | FaceFilter)[]): SceneObject;
+  endFaces(...args: (number | FaceFilter)[]): SceneObject;
+  sideFaces(...args: (number | FaceFilter)[]): SceneObject;
+  startEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  endEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  sideEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  thin(offset: number): this;
+  thin(offset1: number, offset2: number): this;
+  internalFaces(...args: (number | FaceFilter)[]): SceneObject;
+  internalEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  capFaces(...args: (number | FaceFilter)[]): SceneObject;
+  capEdges(...args: (number | EdgeFilter)[]): SceneObject;
+}
+```
+
+Extends [[api/types/boolean-operation]].
+
+## Methods
+
+### `startFaces()`
+
+Selects faces on the first profile plane of the loft.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `endFaces()`
+
+Selects faces on the last profile plane of the loft.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `sideFaces()`
+
+Selects the lateral faces generated between loft profiles.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `startEdges()`
+
+Selects edges on the first profile plane of the loft.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `endEdges()`
+
+Selects edges on the last profile plane of the loft.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `sideEdges()`
+
+Selects edges on the side faces, excluding edges shared with start/end faces.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `thin()`
+
+```ts
+thin(offset: number): this
+thin(offset1: number, offset2: number): this
+```
+
+Enables thin loft mode — offsets the profile edges of each section to create a
+thin-walled shell instead of lofting filled faces. All profiles must be sketches
+and share the same topology. Positive values offset outward, negative offsets 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. |
+
+### `internalFaces()`
+
+Selects faces created inside the solid during loft (e.g., the inner
+wall of a thin-walled loft from closed profiles).
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalEdges()`
+
+Selects edges bounding the internal geometry created during loft.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `capFaces()`
+
+Selects the cap faces at the open ends of a thin-walled loft from open profiles.
+These are the small faces connecting the inner and outer walls at the profile endpoints.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `capEdges()`
+
+Selects edges on the cap faces of a thin-walled loft from open profiles.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+## Inherited
+
+From [[api/types/boolean-operation]]: `add()`, `'new'()`, `remove()`, `scope()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,35 @@
+---
+id: api/types/mirror
+title: Mirror
+summary: "The Mirror type. Extends BooleanOperation; adds 1 method."
+tags: [api, type, interface]
+symbols: [Mirror, IMirror]
+seeAlso: [api/mirror, api/types/boolean-operation]
+---
+# Mirror
+
+```ts
+interface Mirror extends BooleanOperation {
+  exclude(...objects: SceneObject[]): this;
+}
+```
+
+Extends [[api/types/boolean-operation]].
+
+## Methods
+
+### `exclude()`
+
+Excludes the given objects from the mirror operation. Useful when
+mirroring "everything" but a few specific objects should be skipped,
+or when narrowing an explicit target list.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...objects` | [[api/types/scene-object]][] | The objects to exclude from mirroring. *(optional)* |
+
+## Inherited
+
+From [[api/types/boolean-operation]]: `add()`, `'new'()`, `remove()`, `scope()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,31 @@
+---
+id: api/types/offset
+title: Offset
+summary: "The Offset type. Extends ExtrudableGeometry; adds 1 method."
+tags: [api, type, interface]
+symbols: [Offset, IOffset]
+seeAlso: [api/offset, api/types/extrudable-geometry]
+---
+# Offset
+
+```ts
+interface Offset extends ExtrudableGeometry {
+  close(): this;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `close()`
+
+Closes an open offset by joining it back to the source wire with
+straight cap edges at each endpoint. Has no effect when the offset
+is already closed. Cannot be combined with `removeOriginal=true`.
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,35 @@
+---
+id: api/types/plane-like
+title: PlaneLike
+summary: "A plane reference accepted by sketch(), filters, and other plane-aware operations."
+tags: [api, type, union]
+symbols: [PlaneLike, PlaneObjectBase]
+seeAlso: [api/sketch, api/plane, api/types/plane, api/types/scene-object]
+---
+# PlaneLike
+
+```ts
+type PlaneLike = StandardPlane | Plane | IPlane | PlaneObjectBase;
+```
+
+A plane reference used by `sketch()`, filters, and other operations. Any of the following formats are accepted:
+
+| Format | Example | Description |
+| --- | --- | --- |
+| Standard plane string | `"xy"`, `"xz"`, `"yz"` | The three principal planes. |
+| Negative plane string | `"-xy"`, `"-xz"`, `"-yz"` | Principal planes with flipped normals. |
+| Named plane string | `"top"`, `"bottom"`, `"front"`, `"back"`, `"left"`, `"right"` | Descriptive aliases for the principal planes. |
+| [[api/types/plane]] | `plane("xy", 10)` | A plane object created with `plane()`. |
+| [[api/types/scene-object]] | A face selection | A planar face to use as reference. |
+
+## Example
+
+```fluid.js
+import { sketch, rect, circle, extrude, plane } from "fluidcad/core";
+
+sketch("xy", () => rect(100, 50).centered());            // string form
+const e = extrude(20);
+sketch(plane("xy", 30), () => rect(40, 40).centered());  // Plane form
+sketch(e.endFaces(), () => circle(10));                  // face form
+extrude(5);
+```

package/llm-docs/api/types/plane-transform-options.md

@@ -0,0 +1,29 @@
+---
+id: api/types/plane-transform-options
+title: PlaneTransformOptions
+summary: "Options accepted by `plane()` for offsetting and rotating a plane in its own frame."
+tags: [api, type, options]
+symbols: [PlaneTransformOptions, PlaneRenderableOptions]
+seeAlso: [api/plane]
+---
+# PlaneTransformOptions
+
+```ts
+type PlaneTransformOptions = {
+  offset?: number;
+  rotateX?: number;
+  rotateY?: number;
+  rotateZ?: number;
+};
+```
+
+Options accepted by `plane()` to offset and rotate a plane relative to its own axes. Rotations are composed together and applied around the plane's origin (after the offset is applied), so the plane tilts in place rather than orbiting the world origin.
+
+## Properties
+
+| Property | Type | Description |
+| --- | --- | --- |
+| `offset` | `number` | Distance to translate the plane along its normal *(optional)* |
+| `rotateX` | `number` | Rotation around the plane's X axis (in degrees) *(optional)* |
+| `rotateY` | `number` | Rotation around the plane's Y axis (in degrees) *(optional)* |
+| `rotateZ` | `number` | Rotation around the plane's Z axis / normal (in degrees) *(optional)* |

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

@@ -0,0 +1,21 @@
+---
+id: api/types/plane
+title: Plane
+summary: "The Plane type. Extends SceneObject."
+tags: [api, type, interface]
+symbols: [Plane, IPlane]
+seeAlso: [api/plane, api/types/plane-like, api/types/scene-object]
+---
+# Plane
+
+```ts
+interface Plane 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/point-like.md

@@ -0,0 +1,22 @@
+---
+id: api/types/point-like
+title: PointLike
+summary: "A 3D point accepted by translate() and other 3D operations."
+tags: [api, type, union]
+symbols: [PointLike]
+seeAlso: [api/translate]
+---
+# PointLike
+
+```ts
+type PointLike = | Point
+  | [number, number, number]
+  | { x: number; y: number; z: number };
+```
+
+A 3D point used by operations like `translate()`. Any of the following formats are accepted:
+
+| Format | Example | Description |
+| --- | --- | --- |
+| `[number, number, number]` | `[10, 20, 30]` | Tuple of x, y, z coordinates. |
+| `{ x, y, z }` | `{ x: 10, y: 20, z: 30 }` | Object with x, y, z properties. |

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

@@ -0,0 +1,26 @@
+---
+id: api/types/point2dlike
+title: Point2DLike
+summary: "A 2D point accepted by sketching functions."
+tags: [api, type, union]
+symbols: [Point2DLike]
+seeAlso: [api/line, api/rect, api/types/vertex]
+---
+# Point2DLike
+
+```ts
+type Point2DLike = | Point2D
+  | [number, number]
+  | number[]
+  | { x: number; y: number }
+  | LazyVertex;
+```
+
+A 2D point used by all sketching functions. Any of the following formats are accepted:
+
+| Format | Example | Description |
+| --- | --- | --- |
+| `[number, number]` | `[10, 20]` | Tuple of x, y coordinates. |
+| `number[]` | `[10, 20]` | Array of x, y coordinates. |
+| `{ x, y }` | `{ x: 10, y: 20 }` | Object with x, y properties. |
+| [[api/types/vertex]] | `line(...).end()` | A vertex returned by a geometry method. |