fluidcad 0.0.32 → 0.0.34

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

@@ -0,0 +1,46 @@
+---
+id: api/types/polygon
+title: Polygon
+summary: "The Polygon type. Extends ExtrudableGeometry; adds 2 methods."
+tags: [api, type, interface]
+symbols: [Polygon, IPolygon]
+seeAlso: [api/polygon, api/types/extrudable-geometry]
+---
+# Polygon
+
+```ts
+interface Polygon extends ExtrudableGeometry {
+  getEdge(index: number): SceneObject;
+  getVertex(index: number): Vertex;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `getEdge()`
+
+Returns a specific edge of the polygon by index.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `index` | `number` | Zero-based edge index. |
+
+### `getVertex()`
+
+Returns a lazy-evaluated vertex at a specific corner of the polygon.
+
+**Returns**: [[api/types/vertex]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `index` | `number` | Zero-based vertex index. |
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,128 @@
+---
+id: api/types/rect
+title: Rect
+summary: "The Rect type. Extends ExtrudableGeometry; adds 14 methods."
+tags: [api, type, interface]
+symbols: [Rect, IRect]
+seeAlso: [api/rect, api/types/extrudable-geometry]
+---
+# Rect
+
+```ts
+interface Rect extends ExtrudableGeometry {
+  radius(...r: number[]): this;
+  centered(value?: boolean | "horizontal" | "vertical"): this;
+  topEdge(): SceneObject;
+  bottomEdge(): SceneObject;
+  leftEdge(): SceneObject;
+  rightEdge(): SceneObject;
+  topLeftArcEdge(): SceneObject;
+  topRightArcEdge(): SceneObject;
+  bottomLeftArcEdge(): SceneObject;
+  bottomRightArcEdge(): SceneObject;
+  topLeft(): Vertex;
+  topRight(): Vertex;
+  bottomLeft(): Vertex;
+  bottomRight(): Vertex;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `radius()`
+
+Sets corner radii for a rounded rectangle. Accepts 1–4 values
+in order: `[bottomLeft, bottomRight, topRight, topLeft]`.
+A single value applies to all corners.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...r` | `number`[] | One or more radius values. *(optional)* |
+
+### `centered()`
+
+Controls how the rectangle is positioned relative to the current point.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `boolean` \| `"horizontal"` \| `"vertical"` | `true` centers on both axes, `'horizontal'` or `'vertical'` centers on one axis, `false` (default) keeps the current point as the origin corner. *(optional)* |
+
+### `topEdge()`
+
+Returns the top straight edge of the rectangle.
+
+**Returns**: [[api/types/scene-object]].
+
+### `bottomEdge()`
+
+Returns the bottom straight edge of the rectangle.
+
+**Returns**: [[api/types/scene-object]].
+
+### `leftEdge()`
+
+Returns the left straight edge of the rectangle.
+
+**Returns**: [[api/types/scene-object]].
+
+### `rightEdge()`
+
+Returns the right straight edge of the rectangle.
+
+**Returns**: [[api/types/scene-object]].
+
+### `topLeftArcEdge()`
+
+Returns the arc edge at the top-left corner. Only present when a radius is applied.
+
+**Returns**: [[api/types/scene-object]].
+
+### `topRightArcEdge()`
+
+Returns the arc edge at the top-right corner. Only present when a radius is applied.
+
+**Returns**: [[api/types/scene-object]].
+
+### `bottomLeftArcEdge()`
+
+Returns the arc edge at the bottom-left corner. Only present when a radius is applied.
+
+**Returns**: [[api/types/scene-object]].
+
+### `bottomRightArcEdge()`
+
+Returns the arc edge at the bottom-right corner. Only present when a radius is applied.
+
+**Returns**: [[api/types/scene-object]].
+
+### `topLeft()`
+
+Returns a lazy-evaluated vertex at the top-left corner.
+
+**Returns**: [[api/types/vertex]].
+
+### `topRight()`
+
+Returns a lazy-evaluated vertex at the top-right corner.
+
+**Returns**: [[api/types/vertex]].
+
+### `bottomLeft()`
+
+Returns a lazy-evaluated vertex at the bottom-left corner.
+
+**Returns**: [[api/types/vertex]].
+
+### `bottomRight()`
+
+Returns a lazy-evaluated vertex at the bottom-right corner.
+
+**Returns**: [[api/types/vertex]].
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,102 @@
+---
+id: api/types/revolve
+title: Revolve
+summary: "The Revolve type. Extends BooleanOperation; adds 7 methods."
+tags: [api, type, interface]
+symbols: [Revolve, IRevolve]
+seeAlso: [api/revolve, api/types/boolean-operation]
+---
+# Revolve
+
+```ts
+interface Revolve extends BooleanOperation {
+  symmetric(): this;
+  pick(...points: Point2DLike[]): this;
+  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
+
+### `symmetric()`
+
+Enables symmetric mode — revolves equally in both directions from the sketch plane.
+
+### `pick()`
+
+Restricts the revolve 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 revolve. *(optional)* |
+
+### `thin()`
+
+```ts
+thin(offset: number): this
+thin(offset1: number, offset2: number): this
+```
+
+Enables thin revolve mode — offsets the profile edges to create a thin-walled
+solid of revolution instead of revolving 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. |
+
+### `internalFaces()`
+
+Selects faces created inside the solid during revolution (e.g., the inner
+wall of a thin-walled revolve from a closed profile).
+
+**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 revolution.
+
+**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 revolve 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 revolve 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)* |
+
+## Inherited
+
+From [[api/types/boolean-operation]]: `add()`, `'new'()`, `remove()`, `scope()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,133 @@
+---
+id: api/types/rib
+title: Rib
+summary: "The Rib type. Extends BooleanOperation; adds 11 methods."
+tags: [api, type, interface]
+symbols: [Rib, IRib]
+seeAlso: [api/rib, api/types/boolean-operation]
+---
+# Rib
+
+```ts
+interface Rib extends BooleanOperation {
+  startFaces(...args: (number | FaceFilter)[]): SceneObject;
+  endFaces(...args: (number | FaceFilter)[]): SceneObject;
+  sideFaces(...args: (number | FaceFilter)[]): SceneObject;
+  capFaces(...args: (number | FaceFilter)[]): SceneObject;
+  startEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  endEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  sideEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  capEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  draft(value: number | [number, number]): this;
+  parallel(): this;
+  extend(): this;
+}
+```
+
+Extends [[api/types/boolean-operation]].
+
+## Methods
+
+### `startFaces()`
+
+Selects faces at the start (base) of the rib — the profile face at the sketch plane.
+
+**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 (top) of the rib — where the rib meets the boundary.
+
+**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 wall faces of the rib.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `capFaces()`
+
+Selects the small cap faces at the spine endpoints.
+
+**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 faces.
+
+**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 faces.
+
+**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)* |
+
+### `capEdges()`
+
+Selects edges on the cap faces.
+
+**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 rib walls.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `number` \| `[number, number]` | A single angle for uniform draft, or a `[start, end]` tuple for asymmetric draft. |
+
+### `parallel()`
+
+Switches the extrusion direction to parallel to the sketch plane
+(perpendicular to the spine within the plane) instead of normal to it.
+
+### `extend()`
+
+Extends the rib's side faces at the spine endpoints outward to blend
+with the target solids' walls.
+
+## Inherited
+
+From [[api/types/boolean-operation]]: `add()`, `'new'()`, `remove()`, `scope()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

package/llm-docs/api/types/scene-object.md

@@ -0,0 +1,33 @@
+---
+id: api/types/scene-object
+title: SceneObject
+summary: "The SceneObject type. Defines 2 methods."
+tags: [api, type, interface]
+symbols: [SceneObject, ISceneObject]
+seeAlso: [api/select, concepts/scene-graph]
+---
+# SceneObject
+
+```ts
+interface SceneObject {
+  name(value: string): this;
+  reusable(): this;
+}
+```
+
+## Methods
+
+### `name()`
+
+Sets a custom display name for this object, overriding the default type-based name.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `string` | The display name to assign. |
+
+### `reusable()`
+
+Marks this object as reusable. Reusable objects retain their shapes when
+consumed by features (e.g., extrude, revolve), allowing multiple features
+to reference the same source geometry. Use `remove(obj)` to force-remove
+shapes from a reusable object.

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

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

@@ -0,0 +1,54 @@
+---
+id: api/types/shell
+title: Shell
+summary: "The Shell type. Extends SceneObject; adds 3 methods."
+tags: [api, type, interface]
+symbols: [Shell, IShell]
+seeAlso: [api/shell, api/types/scene-object]
+---
+# Shell
+
+```ts
+interface Shell extends SceneObject {
+  internalFaces(...args: (number | FaceFilter)[]): SceneObject;
+  internalEdges(...args: (number | EdgeFilter)[]): SceneObject;
+  join(type: ShellJoinType): this;
+}
+```
+
+Extends [[api/types/scene-object]].
+
+## Methods
+
+### `internalFaces()`
+
+Selects the inner wall faces created by the shell operation (from thickness removal).
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `FaceFilter`)[] | Numeric indices or FaceFilterBuilder instances to filter the selection. *(optional)* |
+
+### `internalEdges()`
+
+Selects edges created by the shell operation that are not from the original solid
+or on the opening rim.
+
+**Returns**: [[api/types/scene-object]].
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `...args` | (`number` \| `EdgeFilter`)[] | Numeric indices or EdgeFilterBuilder instances to filter the selection. *(optional)* |
+
+### `join()`
+
+Sets the join type used at inner-wall corners.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `type` | `ShellJoinType` | `'arc'` (default) for rounded blends, `'intersection'` for sharp corners, or `'tangent'` for tangent-continuous blends. |
+
+## Inherited
+
+From [[api/types/scene-object]]: `name()`, `reusable()`

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

@@ -0,0 +1,43 @@
+---
+id: api/types/slot
+title: Slot
+summary: "The Slot type. Extends ExtrudableGeometry; adds 2 methods."
+tags: [api, type, interface]
+symbols: [Slot, ISlot]
+seeAlso: [api/slot, api/types/extrudable-geometry]
+---
+# Slot
+
+```ts
+interface Slot extends ExtrudableGeometry {
+  centered(value?: boolean): this;
+  rotate(angle: number): this;
+}
+```
+
+Extends [[api/types/extrudable-geometry]].
+
+## Methods
+
+### `centered()`
+
+Controls whether the slot is centered on the current position.
+When `true`, the slot is offset backward by half its length.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `value` | `boolean` | `true` to center, `false` (default) to start from the current position. *(optional)* |
+
+### `rotate()`
+
+Sets the rotation angle of the slot's primary axis.
+
+| Parameter | Type | Description |
+| --- | --- | --- |
+| `angle` | `number` | Rotation in degrees. |
+
+## Inherited
+
+From [[api/types/geometry]]: `guide()`, `start()`, `end()`, `tangent()`
+
+From [[api/types/scene-object]]: `name()`, `reusable()`