forgecad 0.9.4 → 0.9.6

package/dist-skill/docs-dev/generated/core.md

@@ -18,15 +18,15 @@ skill-order: 100
 - [Grouping & Local Coordinates](#grouping-local-coordinates) — `group`
 - [Section & Projection](#section-projection) — `intersectWithPlane`, `faceProfile`, `projectToPlane`
 - [Transforms](#transforms) — `composeChain`
-- [Backend Runtime](#backend-runtime) — `initKernel`, `setActiveBackend`, `activateBackend`, `getActiveBackend`
 - [Verification](#verification) — `spec`
 - [Shape](#shape) — Appearance, Face Topology, Edge Topology, Transforms, Booleans & Cutting, Features, Placement, Connectors, References, Measurement
 - [Transform](#transform)
 - [ShapeGroup](#shapegroup) — Children, Transforms, Placement, Connectors, References
 - [SurfacePattern](#surfacepattern)
+- [Pattern2D](#pattern2d)
+- [Pattern2DBuilder](#pattern2dbuilder)
 - [ShapeRef](#shaperef)
 - [ANCHOR3D_NAMES](#anchor3d-names)
-- [DEFAULT_ACTIVE_BACKEND](#default-active-backend)
 - [verify](#verify)
 - [Constraint](#constraint)
 - [Points](#points)
@@ -121,9 +121,11 @@ intersection(...inputs: ShapeOperandInput[]): Shape
 
 ### Edge Features
 
-#### `fillet()` — Apply fillets (rounded edges) to one or more edges of a shape.
+#### `fillet()` — Apply experimental fillets (rounded edges) to one or more edges of a shape.
 
-Works on edge selections from any active backend. Truck and OCCT route edge finishes through native kernel operations; unsupported selections fail as explicit kernel gaps instead of using TypeScript geometry fallbacks.
+**Experimental**: fillets are still backend-sensitive. The Manifold backend is known to produce incorrect results for some edge-finish cases, and the OCCT backend can be very slow, especially with broad edge selections. Prefer targeted edge selectors and inspect the result before treating it as production-ready geometry.
+
+Edge selections compile into backend operations; unsupported selections fail as explicit kernel gaps instead of using TypeScript geometry fallbacks.
 
 The `edges` parameter is flexible:
 
@@ -149,9 +151,11 @@ fillet(myShape, 3, edges)
 fillet(shape: Shape, radius: number, edges?: EdgeSelector, segments?: number): Shape
 ```
 
-#### `chamfer()` — Apply chamfers (beveled edges) to one or more edges of a shape.
+#### `chamfer()` — Apply experimental chamfers (beveled edges) to one or more edges of a shape.
+
+**Experimental**: chamfers are still backend-sensitive. The Manifold backend is known to produce incorrect results for some edge-finish cases, and the OCCT backend can be very slow, especially with broad edge selections. Prefer targeted edge selectors and inspect the result before treating it as production-ready geometry.
 
-Produces a 45° bevel at the specified `size` (distance from edge). Works on edge selections from any active backend. Truck and OCCT route chamfers through native kernel operations; unsupported selections fail as explicit kernel gaps instead of using TypeScript geometry fallbacks.
+Produces a 45° bevel at the specified `size` (distance from edge). Edge selections compile into backend operations; unsupported selections fail as explicit kernel gaps instead of using TypeScript geometry fallbacks.
 
 The `edges` parameter accepts the same options as `fillet()`: inline `EdgeQuery`, pre-selected `EdgeSegment`/`EdgeSegment[]`, or `undefined` (all sharp edges).
 
@@ -376,11 +380,8 @@ selectEdges(shape: Shape, query?: EdgeQuery): EdgeSegment[]
 | `normalA` | `Vec3` | Normal of first adjacent face. |
 | `normalB` | `Vec3` | Normal of second adjacent face (same as normalA for boundary edges). |
 | `boundary` | `boolean` | true if this is a boundary (unmatched) edge — unusual for closed solids. |
-| `nativeTopology?` | `EdgeNativeTopologyRef` | Native kernel topology identity when the active backend can provide one. |
 | `start`, `end`, `midpoint`, `length` | | — |
 
-`EdgeNativeTopologyRef`: `{ backend: "truck", edge: number }`
-
 #### `selectEdge()` — Select the single best-matching edge from a shape.
 
 When `near` is specified, returns the edge whose midpoint is closest to that point. Otherwise returns the first matching edge in mesh order. Throws if no edges match the query — useful as a guard when you expect exactly one result.
@@ -481,7 +482,7 @@ importSvgSketch(fileName: string, options?: SvgImportOptions): Sketch
 importMesh(fileName: string, options?: { scale?: number; center?: boolean; }): Shape
 ```
 
-#### `importStep()` — Import a STEP file (.step, .stp) as an exact OCCT-backed Shape. Preserves NURBS curves, B-spline surfaces, and exact topology. Requires `setActiveBackend('occt')`.
+#### `importStep()` — Import a STEP file (.step, .stp) as an exact OCCT-backed Shape. Preserves NURBS curves, B-spline surfaces, and exact topology. Requires running with the OCCT backend.
 
 ```ts
 importStep(fileName: string): Shape
@@ -617,18 +618,21 @@ Param.list<T extends Record<string, number | boolean | string>>(name: string, de
 
 Unlike union(), child colors and individual identities are preserved. Children can be plain shapes, named descriptors ({ name, shape/sketch/group }), or nested groups. The returned ShapeGroup supports all Shape transforms (translate, rotate, etc.).
 
+Named descriptors can include `tags` for viewport organization. Tags do not affect geometry; they let the command palette hide, show only, or focus all objects with the same tag.
+
 **Local coordinate pattern:** Build child parts at the origin (local coordinates), then group and translate once to place the whole assembly. This eliminates the error-prone pattern of manually adding parent offsets to every sub-part.
 
 ```js
-// BAD — every sub-part repeats the parent's global offset
-const unitX = 0, unitY = -18, unitZ = 70;
-const body = roundedBox(100, 20, 32, 4).translate(unitX, unitY, unitZ);
-const panel = box(98, 2, 18).translate(unitX, unitY - 12, unitZ + 4);
-const louver = box(88, 2, 6).translate(unitX, unitY - 14, unitZ - 11);
+const body = roundedBox(100, 20, 32, 4);
+const panel = box(98, 2, 18).translate(0, -12, 4);
+const louver = box(88, 2, 6).translate(0, -14, -11);
+const indoorUnit = group(
+  { name: 'Body', shape: body },
+  { name: 'Panel', tags: 'cover', shape: panel },
+  { name: 'Louver', tags: ['cover', 'moving'], shape: louver },
+).translate(0, -18, 70);
 ```
 
-// GOOD — build at origin, group, translate once const body = roundedBox(100, 20, 32, 4); const panel = box(98, 2, 18).translate(0, -12, 4); const louver = box(88, 2, 6).translate(0, -14, -11); const indoorUnit = group( { name: 'Body', shape: body }, { name: 'Panel', shape: panel }, { name: 'Louver', shape: louver }, ).translate(0, -18, 70);
-
 ```ts
 group(...items: GroupInput[]): ShapeGroup
 ```
@@ -663,32 +667,6 @@ projectToPlane(shape: Shape, plane: PlaneSpec): Sketch
 composeChain(...steps: TransformInput[]): Transform
 ```
 
-### Backend Runtime
-
-#### `initKernel()`
-
-```ts
-initKernel(): Promise<unknown>
-```
-
-#### `setActiveBackend()`
-
-```ts
-setActiveBackend(backend: ActiveBackend): void
-```
-
-#### `activateBackend()` — Set the active backend and ensure its WASM module is initialized. Call this instead of `setActiveBackend` when you're about to execute code — it guarantees the backend is ready, not just selected.
-
-```ts
-activateBackend(backend: ActiveBackend): Promise<void>
-```
-
-#### `getActiveBackend()`
-
-```ts
-getActiveBackend(): ActiveBackend
-```
-
 ### Verification
 
 #### `spec()` — Create a named, reusable bundle of verification checks.
@@ -1674,6 +1652,82 @@ color(hex: string): ShapeGroup
 | `body` | `string` | Function body: receives (u, v) in surface mm, returns height displacement. |
 | `constants` | `Record<string, number>` | Named constants injected into the function. |
 
+### `Pattern2D`
+
+#### `add()` — Add this pattern to one or more patterns or constant height offsets.
+
+```ts
+add(...patterns: Pattern2DInput[]): Pattern2D
+```
+
+#### `subtract()` — Subtract another pattern or constant height offset from this pattern.
+
+```ts
+subtract(pattern: Pattern2DInput): Pattern2D
+```
+
+#### `multiply()` — Multiply this pattern by one or more patterns or numeric scale factors.
+
+```ts
+multiply(...patterns: Pattern2DInput[]): Pattern2D
+```
+
+#### `min()` — Keep the lower height between this pattern and one or more other patterns.
+
+```ts
+min(...patterns: Pattern2DInput[]): Pattern2D
+```
+
+#### `max()` — Keep the higher height between this pattern and one or more other patterns.
+
+```ts
+max(...patterns: Pattern2DInput[]): Pattern2D
+```
+
+#### `clamp()` — Limit pattern height to the inclusive `[min, max]` range in millimeters.
+
+```ts
+clamp(min: number, max: number): Pattern2D
+```
+
+#### `abs()` — Convert negative heights to positive heights.
+
+```ts
+abs(): Pattern2D
+```
+
+#### `negate()` — Flip the pattern height sign.
+
+```ts
+negate(): Pattern2D
+```
+
+### `Pattern2DBuilder`
+
+#### `constant()` — Create a constant-height pattern in millimeters.
+
+```ts
+constant(value?: number): Pattern2D
+```
+
+#### `sineWave()` — Create a sinusoidal wave pattern in UV space.
+
+```ts
+sineWave(options: Pattern2DSineWaveOptions): Pattern2D
+```
+
+#### `stripes()` — Create recessed stripe bands in UV space.
+
+```ts
+stripes(options: Pattern2DStripesOptions): Pattern2D
+```
+
+#### `overUnderWeave()` — Create an over-under woven relief pattern in UV space.
+
+```ts
+overUnderWeave(options: Pattern2DOverUnderWeaveOptions): Pattern2D
+```
+
 ### `ShapeRef`
 
 A first-class reference path over a shape's semantic faces and face relationships.
@@ -1796,10 +1850,6 @@ toString(): string
 
 ### `ANCHOR3D_NAMES`
 
-### `DEFAULT_ACTIVE_BACKEND`
-
-Default geometry backend when no explicit backend is selected.
-
 ### `verify`
 
 - `that(label: string, check: () => boolean, message?: string): void` — Custom predicate check.