opengeometry 2.0.3 → 2.0.5

package/src/shapes/polygon.d.ts

@@ -1,7 +1,7 @@
 import * as THREE from "three";
 import { OGPolygon, Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import { Solid } from "./solid.js";
-import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
 /**
  * Construction options for a planar polygon.
  */
@@ -74,6 +74,9 @@ export declare class Polygon extends THREE.Mesh {
     addHole(holeVertices: Vector3[]): void;
     /**
      * Builds a kernel-backed `Solid` by extruding this polygon face by `height`.
+     *
+     * This is the recommended public path when a browser CAD or AEC workflow
+     * starts from a planar profile and needs a boolean-ready solid.
      */
     extrude(height: number): Solid;
     /**
@@ -81,9 +84,9 @@ export declare class Polygon extends THREE.Mesh {
      */
     getBrepData(): string | null;
     /**
-     * Subtracts another boolean operand from this polygon.
+     * Subtracts one or more boolean operands from this polygon.
      */
-    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
     set outlineColor(color: number);
     get outlineColor(): number;
     set outline(enable: boolean);

package/src/shapes/solid.d.ts

@@ -2,7 +2,7 @@ import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { type FreeformGeometry } from "../freeform.js";
 import type { FreeformSource } from "../freeform/types.js";
-import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
 /**
  * Construction options for a generic BRep-backed solid.
  */
@@ -53,6 +53,8 @@ export declare class Solid extends THREE.Mesh {
     constructor(options: ISolidOptions);
     /**
      * Extrudes a face-like BRep source and wraps the result as a renderable solid.
+     *
+     * Prefer `polygon.extrude(height)` when the source is already a `Polygon`.
      */
     static extrude(source: FreeformSource, height: number, options: ExtrudeSolidOptions): Solid;
     /**
@@ -90,9 +92,12 @@ export declare class Solid extends THREE.Mesh {
      */
     getBrepData(): any;
     /**
-     * Subtracts another boolean operand from this solid.
+     * Subtracts one or more boolean operands from this solid.
+     *
+     * This is the main shape-level boolean workflow after operations like
+     * `polygon.extrude(height)` or `Solid.extrude(...)`.
      */
-    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
     /**
      * Rebuilds the visible mesh and outline from the current freeform geometry.
      */

package/src/shapes/sphere.d.ts

@@ -2,7 +2,7 @@ import * as OGKernel from "../../opengeometry/pkg/opengeometry.js";
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
-import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
 /**
  * Construction options for a sphere shape.
  */
@@ -66,9 +66,9 @@ export declare class Sphere extends THREE.Mesh {
     generateGeometry(): void;
     getBrep(): any;
     /**
-     * Subtracts another boolean operand, such as an Opening, from this sphere.
+     * Subtracts one or more boolean operands, such as Opening volumes, from this sphere.
      */
-    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
     set outline(enable: boolean);
     get outline(): boolean;
     set fatOutlines(value: boolean);

package/src/shapes/sweep.d.ts

@@ -1,7 +1,7 @@
 import * as OGKernel from "../../opengeometry/pkg/opengeometry.js";
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
-import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
 /**
  * Construction options for a swept solid.
  */
@@ -66,9 +66,9 @@ export declare class Sweep extends THREE.Mesh {
     generateGeometry(): void;
     getBrep(): any;
     /**
-     * Subtracts another boolean operand, such as an Opening, from this sweep.
+     * Subtracts one or more boolean operands, such as Opening volumes, from this sweep.
      */
-    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
     set outline(enable: boolean);
     get outline(): boolean;
     set fatOutlines(value: boolean);

package/src/shapes/wedge.d.ts

@@ -1,7 +1,7 @@
 import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
 import * as THREE from "three";
 import { ShapeOutlineMesh } from "./outline-utils.js";
-import type { ShapeSubtractOperand, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
 /**
  * Construction options for a wedge/prism shape.
  */
@@ -64,9 +64,9 @@ export declare class Wedge extends THREE.Mesh {
     generateGeometry(): void;
     getBrepData(): any;
     /**
-     * Subtracts another boolean operand, such as an Opening, from this wedge.
+     * Subtracts one or more boolean operands, such as Opening volumes, from this wedge.
      */
-    subtract(operand: ShapeSubtractOperand, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
     set outline(enable: boolean);
     get outline(): boolean;
     set fatOutlines(value: boolean);