opengeometry 2.0.7 → 2.0.9

package/src/operations/boolean.d.ts

@@ -10,6 +10,23 @@ export type BooleanOperand = string | Record<string, unknown> | {
 };
 /**
  * Kernel-side boolean tuning options.
+ *
+ * `tolerance` is in **model units** (meters by convention). When omitted, the
+ * kernel auto-scales it to `operandsDiagonal * 1e-8` (clamped to a `1e-6`
+ * floor in many-subtract). This drives the kernel-side polygon / face math
+ * (vertex welding, plane coincidence, AABB enforcement).
+ *
+ * **NOTE: this tolerance does NOT control boolmesh's internal snap window.**
+ * Boolmesh has its own welding tolerance that may treat faces within ~1mm
+ * of each other as coincident, regardless of what `tolerance` you pass. If
+ * your cutter face sits within about 0.001 m – 0.01 m of a host face you
+ * may still hit a `DegenerateTriangle` / `CoincidentFaces` error path.
+ *
+ * **Recommended cutter overshoot for through-cuts:** `max(hostThickness *
+ * 0.05, 0.01)` in model units. See `knowledge/boolean-tolerance-guide.md`.
+ *
+ * `mergeCoplanarFaces` (default `true`) controls whether the planar pipeline
+ * merges coplanar adjacent faces in its output.
  */
 export interface BooleanKernelOptions {
     tolerance?: number;
@@ -17,9 +34,16 @@ export interface BooleanKernelOptions {
 }
 /**
  * Rendering options applied to the boolean result mesh.
+ *
+ * `color`, `opacity`, `transparent`, and `side` override the corresponding
+ * fields on the host (LHS) operand's cloned material. Omit them to inherit
+ * the host's appearance unchanged.
  */
 export interface BooleanRenderOptions {
-    color?: number;
+    color?: THREE.ColorRepresentation;
+    opacity?: number;
+    transparent?: boolean;
+    side?: THREE.Side;
     outline?: boolean;
     fatOutlines?: boolean;
     outlineWidth?: number;
@@ -61,11 +85,18 @@ export declare class BooleanResult extends THREE.Mesh {
     private _outlineEnabled;
     private _fatOutlines;
     private _outlineWidth;
-    constructor(kernelResult: KernelBooleanResult, options?: BooleanRenderOptions);
+    constructor(kernelResult: KernelBooleanResult, options?: BooleanRenderOptions, host?: BooleanOperand | null);
+    /**
+     * Updates the result mesh's color in place without re-running the boolean
+     * pipeline. Accepts any value Three.js accepts (`number`, hex string, css
+     * color name, or `THREE.Color`). No-op for materials without a `color` field.
+     */
+    set color(value: THREE.ColorRepresentation);
+    get color(): THREE.Color | null;
     /**
      * Rebuilds the mesh, cached BRep payload, and outline geometry from the kernel output.
      */
-    applyKernelResult(kernelResult: KernelBooleanResult, color?: number): void;
+    applyKernelResult(kernelResult: KernelBooleanResult, options?: BooleanRenderOptions, sourceMaterial?: THREE.Material | null): void;
     /**
      * Returns the parsed BRep object for reuse with scene export or downstream operations.
      */

package/src/operations/index.d.ts

@@ -2,4 +2,5 @@
  * Kernel-backed boolean helpers and renderable result mesh.
  */
 export * from "./boolean.js";
+export * from "./boolean-errors.js";
 export * from "./extrude.js";