opengeometry 2.0.9 → 2.0.10

package/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <a href="https://opengeometry.io">
+  <a href="https://opengeometry.io?utm_source=github">
     <img src="https://raw.githubusercontent.com/OpenGeometry-io/.github/main/profile/opengeometryTextLogo.png" alt="OpenGeometry" />
   </a>
 </p>
@@ -7,24 +7,24 @@
 <h1 align="center">OpenGeometry</h1>
 
 <p align="center">
-  <strong>Browser-native CAD kernel built with Rust, WebAssembly, and Three.js.</strong>
+  <strong>Browser-native CAD kernel for Web Apps and AI CAD built with Rust, WebAssembly, and Three.js.</strong>
 </p>
 
 <p align="center">
   <a href="https://www.npmjs.com/package/opengeometry"><img src="https://img.shields.io/npm/v/opengeometry?style=flat-square&color=4460FF&label=npm" alt="npm version" /></a>
   <a href="https://github.com/OpenGeometry-io/OpenGeometry/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/opengeometry-io/opengeometry?style=flat-square" alt="License" /></a>
-  <a href="https://discord.com/invite/cZY2Vm6E"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
+  <a href="https://discord.gg/9wJpbfgGGA"><img src="https://img.shields.io/badge/Discord-Join%20us-5865F2?style=flat-square&logo=discord&logoColor=white" alt="Discord" /></a>
   <a href="https://x.com/openGeometry"><img src="https://img.shields.io/badge/Twitter-Follow-1DA1F2?style=flat-square&logo=x&logoColor=white" alt="Twitter" /></a>
   <a href="https://linkedin.com/company/openGeometry"><img src="https://img.shields.io/badge/LinkedIn-Connect-0A66C2?style=flat-square&logo=linkedin&logoColor=white" alt="LinkedIn" /></a>
 </p>
 
 <p align="center">
-  <a href="https://opengeometry.io">Website</a> · <a href="https://docs.opengeometry.io">Documentation</a> · <a href="https://demo.opengeometry.io">Live Demos</a> · <a href="https://opengeometry.io/blog">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
+  <a href="https://opengeometry.io?utm_source=github">Website</a> · <a href="https://docs.opengeometry.io/OpenGeometry?utm_source=github">Documentation</a> · <a href="https://demos.opengeometry.io?utm_source=github">Live Demos</a> · <a href="https://blog.opengeometry.io?utm_source=github">Blog</a> · <a href="https://www.npmjs.com/package/opengeometry">npm</a>
 </p>
 
 ---
 
-> **Actively maintained and growing.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving, we are actively improving and expanding the project. Star the repo to follow along. If you have questions or want to get involved, join the [Discord](https://discord.com/invite/cZY2Vm6E) or check out the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)
+> **Actively maintained and growing.** We're building OpenGeometry in the open. APIs, examples, and package structure are evolving, we are actively improving and expanding the project. Star the repo to follow along. If you have questions or want to get involved, join the [Discord](https://discord.com/invite/9wJpbfgGGA) or check out the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)
 
 ---
 
@@ -55,15 +55,15 @@ Good examples include:
 
 - AI copilots that translate user intent into concrete modeling operations
 - prompt-to-geometry or agent-driven editing flows inside browser CAD tools
-- AI-assisted design interfaces that still need reliable extrusion, boolean, projection, and export workflows
+- AI first design interfaces that still need reliable extrusion, boolean, projection, and export workflows
 
 ## Good fit / Not the right fit
 
 **Good fit**
 
-- browser CAD, AEC/BIM, and geometry-heavy web applications
+- browser CAD, AEC/BIM, Mechanical, and geometry-heavy web applications
 - Three.js-based modeling tools that need a real kernel behind them
-- AI-assisted CAD frontends that need deterministic geometry execution in the browser
+- AI first CAD frontends that need deterministic geometry execution in the browser
 
 **Not the default fit**
 
@@ -77,10 +77,10 @@ If you are using ChatGPT, Claude, Gemini, Copilot, or other coding agents on thi
 
 - [AGENTS.md](./AGENTS.md) - single source of truth for all coding agents (architecture, commands, gotchas, behavioral rules)
 - [README.md](./README.md) - product overview, positioning, and quick start
-- [Quickstart](https://docs.opengeometry.io/quickstart)
-- [Three.js integration](https://docs.opengeometry.io/integration/threejs)
-- [Boolean operations](https://docs.opengeometry.io/api/operations/boolean-operations)
-- [Extrude](https://docs.opengeometry.io/api/operations/extrude)
+- [Quickstart](https://docs.opengeometry.io/OpenGeometry/quickstart)
+- [Installation](https://docs.opengeometry.io/OpenGeometry/installation)
+- [Boolean operations](https://docs.opengeometry.io/OpenGeometry/concepts/booleans)
+- [Extrude](https://docs.opengeometry.io/OpenGeometry/api/operations/extrude)
 
 ### What you can do today
 
@@ -96,7 +96,7 @@ If you are using ChatGPT, Claude, Gemini, Copilot, or other coding agents on thi
 
 See OpenGeometry in action — interactive, browser-based demos showcasing the kernel's capabilities:
 
-**[demo.opengeometry.io](https://demo.opengeometry.io)**
+**[demos.opengeometry.io](https://demos.opengeometry.io)**
 
 Demos include primitives rendering, shape generation, sweep operations, boolean operations, file exports, and more. All running client-side via WebAssembly.
 
@@ -139,7 +139,7 @@ cuboid.setPlacement({
 
 Scenegraph behavior is snapshot-based: `add*ToScene` captures geometry at insert time. If you change placement/config later, push updates explicitly via `replaceBrepEntityInScene` or `refreshBrepEntityInScene`.
 
-For a complete walkthrough, see the [Quick Start guide](https://docs.opengeometry.io/quickstart) or clone the [quickstart-js](https://github.com/OpenGeometry-io/quickstart-js) repo.
+For a complete walkthrough, see the [Quick Start guide](https://docs.opengeometry.io/OpenGeometry/quickstart) or clone the [quickstart-js](https://github.com/OpenGeometry-io/quickstart-js) repo.
 
 ## Documentation
 
@@ -148,10 +148,10 @@ Full API reference, guides, and concepts are available at:
 **[docs.opengeometry.io](https://docs.opengeometry.io)**
 
 Key pages:
-- [Installation](https://docs.opengeometry.io/installation)
-- [Quick Start](https://docs.opengeometry.io/quickstart)
-- [Architecture & Concepts](https://docs.opengeometry.io/concepts/architecture)
-- [API Reference](https://docs.opengeometry.io/api)
+- [Installation](https://docs.opengeometry.io/OpenGeometry/installation)
+- [Quick Start](https://docs.opengeometry.io/OpenGeometry/quickstart)
+- [Architecture & Concepts](https://docs.opengeometry.io/OpenGeometry/concepts/architecture)
+- [API Reference](https://docs.opengeometry.io/OpenGeometry/api/)
 
 ## Repository Structure
 
@@ -165,7 +165,7 @@ docs/                      Documentation source (Mintlify)
 
 ## Building from Source
 
-**Prerequisites:** Node.js, npm, Rust toolchain, `wasm-pack`
+**Prerequisites:** Node.js, npm, Rust 1.89.0+ with `wasm32-unknown-unknown`, `wasm-pack`
 
 ```bash
 # Install dependencies
@@ -191,28 +191,25 @@ npm test
 - Contributors interested in the **Rust → WASM geometry pipeline**
 - Anyone exploring **open-source CAD kernel internals**
 
-If you just want a quick look, start with the [hosted demos](https://demo.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
+If you just want a quick look, start with the [hosted demos](https://demos.opengeometry.io) or the [quickstart repo](https://github.com/OpenGeometry-io/quickstart-js).
 
 ## Community
 
 We'd love to have you involved — whether you're using OpenGeometry, building on it, or just curious.
 
-- **[Discord](https://discord.com/invite/cZY2Vm6E)** — Chat with the team and community
+- **[Discord](https://discord.com/invite/9wJpbfgGGA)** — Chat with the team and community
 - **[Twitter / X](https://x.com/openGeometry)** — Updates and announcements
 - **[LinkedIn](https://linkedin.com/company/openGeometry)** — Company updates
 - **[GitHub Issues](https://github.com/OpenGeometry-io/OpenGeometry/issues)** — Bug reports and feature requests
-- **[Blog](https://opengeometry.io/blog)** — Deep dives and release notes
+- **[Blog](https://blog.opengeometry.io?utm_source=github)** — Deep dives and release notes
 
 ## Contributing
 
-OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contributions are welcome — check the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues) for good starting points or open a discussion on [Discord](https://discord.com/invite/cZY2Vm6E).
+OpenGeometry is open source under the [MPL-2.0 license](./LICENSE.md). Contributions are welcome — check the [issues](https://github.com/OpenGeometry-io/OpenGeometry/issues) for good starting points or open a discussion on [Discord](https://discord.com/invite/9wJpbfgGGA).
 
 ## AI Agent Docs Policy
 
-- All AI coding agent instructions live in a single file: [AGENTS.md](./AGENTS.md).
-  `CLAUDE.md` and `.github/copilot-instructions.md` are thin redirects to it.
-- Stable architecture and domain notes are tracked in [`knowledge/`](./knowledge/).
-- User-facing docs live in [`docs/`](./docs/) (Mintlify source).
+- If you're an AI agent, start with [AGENTS.md](./AGENTS.md) for architecture, commands, and behavioral rules.
 - Agents should not create planning, handoff, or runbook files during a task. The
   conversation, the diff, and the commit message are the handoff.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "opengeometry",
-  "version": "2.0.9",
+  "version": "2.0.10",
   "description": "CAD kernel for the web built with Rust, WebAssembly, and Three.js for browser CAD, AEC/BIM, and geometry-heavy tools.",
   "author": "Vishwajeet Vinayak Mane",
   "license": "MPL-2.0",
@@ -50,7 +50,6 @@
     "three": ">=0.168.0"
   },
   "dependencies": {
-    "tsc": "^2.0.4",
     "uuid": "^10.0.0"
   }
 }

package/src/operations/chamfer.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Chamfers (bevels) the specified edges of a BRep by a given distance.
+ *
+ * edgeIds: array of edge indices to chamfer (0-based, from brep.edges).
+ * distance: retraction distance along each adjacent face.
+ *
+ * Returns a JSON-serialized BRep of the result.
+ * Throws if the distance exceeds a face extent or an edge id is invalid.
+ */
+export declare function chamferEdges(brepJson: string, edgeIds: number[], distance: number): string;

package/src/operations/draft.d.ts

@@ -0,0 +1,14 @@
+/**
+ * Applies a draft angle to the specified faces of a BRep.
+ *
+ * faceIds: array of face indices (0-based) to draft.
+ * neutralPlaneNormal: normal of the neutral plane (pull direction).
+ * angleRad: draft angle in radians (must be < π/2).
+ *
+ * Returns a JSON-serialized BRep of the result.
+ */
+export declare function draftFaces(brepJson: string, faceIds: number[], neutralPlaneNormal: {
+    x: number;
+    y: number;
+    z: number;
+}, angleRad: number): string;

package/src/operations/fillet.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Rounds (fillets) the specified edges of a closed solid BRep with a constant
+ * radius. Each filleted edge becomes a curved tangent strip of radius `radius`.
+ *
+ * edgeIds: array of edge indices to fillet (0-based, from brep.edges).
+ * radius: fillet radius in model units. Must be positive and less than the
+ *   inradius of both adjacent faces along the edge.
+ * segments: angular resolution of the cylindrical cutter (default 16).
+ *
+ * Returns a JSON-serialized BRep of the result.
+ * Throws if the radius exceeds the safe bound or an edge id is invalid.
+ */
+export declare function filletEdges(brepJson: string, edgeIds: number[], radius: number, segments?: number): string;

package/src/operations/loft.d.ts

@@ -0,0 +1,16 @@
+export interface LoftOptions {
+    closed?: boolean;
+    tolerance?: number;
+}
+/**
+ * Lofts between N profiles with G0 (positional) continuity.
+ *
+ * Each profile is a flat array of xyz coordinates (3 floats per point).
+ * All profiles must have the same vertex count.
+ *
+ * Returns a JSON-serialized BRep of the lofted solid.
+ *
+ * On failure the kernel throws a structured LoftError string. Handle it with
+ * try/catch and inspect the message for the error variant.
+ */
+export declare function loftProfiles(profiles: number[][], options?: LoftOptions): string;

package/src/operations/mirror.d.ts

@@ -0,0 +1,21 @@
+/**
+ * Mirrors a BRep about a plane defined by an origin and a normal.
+ *
+ * planeOrigin: any point on the mirror plane.
+ * planeNormal: unit normal of the mirror plane.
+ * weld: if true, attempt to merge the original and mirrored BReps into a
+ *   single solid by stitching the parting faces.
+ *
+ * Returns a JSON-serialized BRep of the result.
+ * Throws MirrorError::PlaneIntersectsSolid if weld=true and the plane
+ * cuts through the interior.
+ */
+export declare function mirrorAboutPlane(brepJson: string, planeOrigin: {
+    x: number;
+    y: number;
+    z: number;
+}, planeNormal: {
+    x: number;
+    y: number;
+    z: number;
+}, weld: boolean): string;

package/src/operations/pattern-circular.d.ts

@@ -0,0 +1,19 @@
+/**
+ * Creates a circular pattern of a BRep around an axis.
+ *
+ * axisOrigin: a point on the rotation axis.
+ * axisDirection: unit vector along the rotation axis.
+ * sweepRad: total angular span to distribute instances over (2*PI = full circle).
+ * count: number of instances.
+ *
+ * Returns a JSON-serialized array of BReps (Vec<Brep>).
+ */
+export declare function patternCircular(brepJson: string, axisOrigin: {
+    x: number;
+    y: number;
+    z: number;
+}, axisDirection: {
+    x: number;
+    y: number;
+    z: number;
+}, sweepRad: number, count: number): string;

package/src/operations/pattern-linear.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Creates a linear pattern of a BRep along a direction vector.
+ *
+ * direction: step vector (does not need to be unit-length; its magnitude
+ *   sets the per-instance offset when combined with pitch).
+ * pitch: spacing between instances along the direction vector.
+ * count: number of instances to produce (including the original position).
+ *
+ * Returns a JSON-serialized array of BReps (Vec<Brep>).
+ */
+export declare function patternLinear(brepJson: string, direction: {
+    x: number;
+    y: number;
+    z: number;
+}, pitch: number, count: number): string;

package/src/operations/pipe.d.ts

@@ -0,0 +1,17 @@
+export interface PipeOptions {
+    /** Number of segments around each circular cross-section (default 32). */
+    segments?: number;
+}
+/**
+ * Sweeps a circle along a 3D path, producing a pipe solid.
+ *
+ * `pathFlat` is a flat array of xyz coordinates: [x0,y0,z0, x1,y1,z1, …].
+ * The path must contain at least 3 points.
+ *
+ * `radiusCurve` is either a single number (constant radius along the whole
+ * path) or an array of numbers with the same length as the path point count
+ * (variable radius — one value per station).
+ *
+ * Returns a JSON-serialised BRep of the pipe solid.
+ */
+export declare function pipe(pathFlat: number[], radiusCurve: number | number[], options?: PipeOptions): string;

package/src/operations/revolve.d.ts

@@ -0,0 +1,29 @@
+export interface RevolveProfileOptions {
+    axisOrigin?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    axisDirection?: {
+        x: number;
+        y: number;
+        z: number;
+    };
+    startAngleRad?: number;
+    sweepAngleRad?: number;
+    segments?: number;
+    capStart?: boolean;
+    capEnd?: boolean;
+    tolerance?: number;
+}
+/**
+ * Sweeps a planar generatrix profile around an axis by the given angle.
+ *
+ * The profile is a flat array of xyz coordinates (3 floats per point).
+ * Returns a JSON-serialized BRep of the revolved surface.
+ *
+ * For full 2π sweeps, angular-seam caps are elided — the surface closes by
+ * periodicity. Axis is defined by an origin point and a unit-length direction.
+ * On-axis points generate triangle fans rather than degenerate quads.
+ */
+export declare function revolveProfile(profileFlat: number[], options?: RevolveProfileOptions): string;

package/src/operations/sweep.d.ts

@@ -0,0 +1,13 @@
+export interface SweepOptions {
+    capStart?: boolean;
+    capEnd?: boolean;
+}
+/**
+ * Sweeps a planar profile along a 3D path, producing a solid BRep.
+ *
+ * `pathFlat` is a flat array of xyz coordinates: [x0,y0,z0, x1,y1,z1, …].
+ * `profileFlat` is a flat array of xyz coordinates for the cross-section.
+ *
+ * Returns a JSON-serialised BRep of the swept solid.
+ */
+export declare function sweepProfileAlongPath(pathFlat: number[], profileFlat: number[], options?: SweepOptions): string;

package/src/primitives/helix.d.ts

@@ -0,0 +1,31 @@
+import { Vector3 } from "../../opengeometry/pkg/opengeometry.js";
+import * as THREE from "three";
+/**
+ * Construction options for a helix path primitive.
+ */
+export interface IHelixOptions {
+    ogid?: string;
+    axisOrigin: Vector3;
+    axisDirection: Vector3;
+    radius: number;
+    pitch: number;
+    turns: number;
+    samplesPerTurn: number;
+    color: number;
+}
+/**
+ * Partial config payload accepted by `OGHelix.setConfig(...)`.
+ */
+export type HelixConfigUpdate = Partial<IHelixOptions>;
+/**
+ * Helix path primitive rendered as a Three.js line.
+ */
+export declare class OGHelix extends THREE.Line {
+    ogid: string;
+    options: IHelixOptions;
+    constructor(options?: Partial<IHelixOptions>);
+    setConfig(options: HelixConfigUpdate): void;
+    getConfig(): IHelixOptions;
+    getSamples(): Vector3[];
+    private generateGeometry;
+}

package/src/shapes/cone.d.ts

@@ -0,0 +1,64 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a cone shape.
+ */
+export interface IConeOptions {
+    ogid?: string;
+    /** Apex position in world space. */
+    apex: [number, number, number];
+    /** Base centre position in world space. */
+    baseCenter: [number, number, number];
+    baseRadius: number;
+    segments: number;
+    /** Sweep angle in degrees (default 360). */
+    angle: number;
+    color: number;
+    fatOutlines?: boolean;
+    outlineWidth?: number;
+}
+/**
+ * Partial config payload accepted by `Cone.setConfig(...)`.
+ */
+export type ConeConfigUpdate = Partial<IConeOptions>;
+/**
+ * Cone wrapper backed by the kernel `OGCone` revolve primitive.
+ */
+export declare class Cone extends THREE.Mesh {
+    #private;
+    ogid: string;
+    options: IConeOptions;
+    private cone;
+    private _outlineEnabled;
+    private _fatOutlines;
+    private _outlineWidth;
+    set color(color: number);
+    constructor(options?: Partial<IConeOptions>);
+    setConfig(options: ConeConfigUpdate): void;
+    getConfig(): IConeOptions;
+    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
+    canConvertToFreeform(): boolean;
+    toFreeform(id?: string): import("../freeform.js").FreeformGeometry;
+    cleanGeometry(): void;
+    generateGeometry(): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this cone.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    set outline(enable: boolean);
+    get outline(): boolean;
+    set fatOutlines(value: boolean);
+    get fatOutlines(): boolean;
+    set outlineWidth(value: number);
+    get outlineWidth(): number;
+    /** Sets position/rotation/scale placement. */
+    setPlacement(placement: {
+        translation?: THREE.Vector3Like;
+        rotation?: THREE.Vector3Like;
+        scale?: THREE.Vector3Like;
+    }): void;
+    private clearOutlineMesh;
+    discardGeometry(): void;
+    private writePositionsToGeometry;
+}

package/src/shapes/ellipsoid.d.ts

@@ -0,0 +1,86 @@
+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 { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for an ellipsoid shape.
+ */
+export interface IEllipsoidOptions {
+    ogid?: string;
+    center: Vector3;
+    semiA: number;
+    semiB: number;
+    semiC: number;
+    longitudeSegments: number;
+    latitudeSegments: number;
+    color: number;
+    fatOutlines?: boolean;
+    outlineWidth?: number;
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+/**
+ * Placement updates accepted by `Ellipsoid`.
+ */
+export interface EllipsoidPlacementOptions {
+    translation?: Vector3;
+    rotation?: Vector3;
+    scale?: Vector3;
+}
+/**
+ * Partial config payload accepted by `Ellipsoid.setConfig(...)`.
+ */
+export type EllipsoidConfigUpdate = Partial<Omit<IEllipsoidOptions, "translation" | "rotation" | "scale">>;
+/**
+ * Alias for `Ellipsoid` placement updates.
+ */
+export type EllipsoidPlacementUpdate = EllipsoidPlacementOptions;
+/**
+ * Ellipsoid wrapper backed by the kernel OGEllipsoid primitive.
+ *
+ * All three semi-axes (a, b, c) are independently configurable.
+ * When a === b === c the shape degenerates to a sphere.
+ */
+export declare class Ellipsoid extends THREE.Mesh {
+    #private;
+    ogid: string;
+    options: IEllipsoidOptions;
+    private ellipsoid;
+    private _outlineEnabled;
+    private _fatOutlines;
+    private _outlineWidth;
+    set color(color: number);
+    constructor(options?: IEllipsoidOptions);
+    validateOptions(): void;
+    setConfig(options: EllipsoidConfigUpdate): void;
+    getConfig(): IEllipsoidOptions;
+    getAnchor(): OGKernel.Vector3;
+    setPlacement(placement: EllipsoidPlacementUpdate): void;
+    setTransform(translation: Vector3, rotation: Vector3, scale: Vector3): void;
+    setTranslation(translation: Vector3): void;
+    setRotation(rotation: Vector3): void;
+    setScale(scale: Vector3): void;
+    getPlacement(): import("../editor.js").ParametricPlacement;
+    getEditCapabilities(): import("../editor.js").ParametricEditCapabilities;
+    canConvertToFreeform(): boolean;
+    toFreeform(id?: string): import("../freeform.js").FreeformGeometry;
+    cleanGeometry(): void;
+    generateGeometry(): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands, such as Opening volumes, from this ellipsoid.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    set outline(enable: boolean);
+    get outline(): boolean;
+    set fatOutlines(value: boolean);
+    get fatOutlines(): boolean;
+    set outlineWidth(value: number);
+    get outlineWidth(): number;
+    get outlineMesh(): ShapeOutlineMesh | null;
+    private clearOutlineMesh;
+    discardGeometry(): void;
+    private writePositionsToGeometry;
+}

package/src/shapes/frustum.d.ts

@@ -0,0 +1,44 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a frustum (truncated cone) shape.
+ */
+export interface IFrustumOptions {
+    ogid?: string;
+    baseCenter?: [number, number, number];
+    baseRadius: number;
+    topRadius: number;
+    height: number;
+    segments?: number;
+    angle?: number;
+    color: number;
+}
+/**
+ * Placement updates accepted by `Frustum`.
+ */
+export interface FrustumPlacementOptions {
+    translation?: THREE.Vector3;
+    rotation?: THREE.Vector3;
+    scale?: THREE.Vector3;
+}
+/**
+ * Partial config payload accepted by `Frustum.setConfig(...)`.
+ */
+export type FrustumConfigUpdate = Partial<IFrustumOptions>;
+/**
+ * Frustum (truncated cone) wrapper backed by the kernel OGFrustum primitive.
+ */
+export declare class Frustum extends THREE.Mesh {
+    ogid: string;
+    options: Required<IFrustumOptions>;
+    private frustum;
+    constructor(options?: IFrustumOptions);
+    setConfig(options: FrustumConfigUpdate): void;
+    setPlacement(placement: FrustumPlacementOptions): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this frustum.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    private generateGeometry;
+}

package/src/shapes/torus.d.ts

@@ -0,0 +1,44 @@
+import * as THREE from "three";
+import type { ShapeSubtractOperands, ShapeSubtractOptions, ShapeSubtractResult } from "./boolean-subtract.js";
+/**
+ * Construction options for a torus shape.
+ */
+export interface ITorusOptions {
+    ogid?: string;
+    center?: [number, number, number];
+    axis?: [number, number, number];
+    majorRadius: number;
+    minorRadius: number;
+    majorSegments?: number;
+    minorSegments?: number;
+    color: number;
+}
+/**
+ * Placement updates accepted by `Torus`.
+ */
+export interface TorusPlacementOptions {
+    translation?: THREE.Vector3;
+    rotation?: THREE.Vector3;
+    scale?: THREE.Vector3;
+}
+/**
+ * Partial config payload accepted by `Torus.setConfig(...)`.
+ */
+export type TorusConfigUpdate = Partial<ITorusOptions>;
+/**
+ * Torus wrapper backed by the kernel OGTorus primitive.
+ */
+export declare class Torus extends THREE.Mesh {
+    ogid: string;
+    options: Required<ITorusOptions>;
+    private torus;
+    constructor(options?: ITorusOptions);
+    setConfig(options: TorusConfigUpdate): void;
+    setPlacement(placement: TorusPlacementOptions): void;
+    getBrep(): any;
+    /**
+     * Subtracts one or more boolean operands from this torus.
+     */
+    subtract(operands: ShapeSubtractOperands, options?: ShapeSubtractOptions): ShapeSubtractResult;
+    private generateGeometry;
+}