okgeometry-api 1.1.5 → 1.1.7

package/wasm/README.md

@@ -1,104 +0,0 @@
-# OkGeometryCore
-
-A production-grade geometry engine written in Rust, compiled to WebAssembly. Built for [OkNodes](https://orkestra.online), a visual programming tool for the AEC (Architecture, Engineering, Construction) industry.
-
-## Features
-
-### Mesh Primitives
-- Box, Cylinder, Sphere, Prism, Cone, Torus
-
-### Mesh Operations
-- **Transforms** - translate, rotate, scale, mirror, arbitrary matrix
-- **Extrude** - linear extrusion with optional end caps
-- **Loft** - surface generation between multiple curves
-- **Sweep** - curve along path
-- **Boolean** - union, intersection, subtraction (~95% reliable on manifold meshes)
-- **Subdivision** - Catmull-Clark (quad meshes) and Loop (triangle meshes)
-- **Offset / Shell** - inward/outward mesh offset
-- **Bevel / Chamfer** - flat bevel on all edges or selected edges
-- **Triangulation** - ear clipping and fan triangulation
-
-### Curve Primitives
-- Line, Arc, Circle, Polyline, Polycurve (mixed segments)
-
-### Curve Operations
-- Evaluate, tangent, length, closest point, bounds
-- Chamfer corners, fillet corners (arc), offset polyline
-
-### Intersection
-- Line-Line, Line-Plane, Line-Circle, Circle-Circle
-- Ray-Mesh (BVH-accelerated), closest point on mesh
-
-### Spatial Indexing
-- BVH (Bounding Volume Hierarchy) for O(log n) ray casting and proximity queries
-
-### I/O
-- OBJ import/export
-
-## Architecture
-
-```
-OkNodes (TypeScript)
-  |  ArrayBuffer / TypedArray
-  v
-OkGeometryCore (Rust -> WASM)
-  |- math/          Vector3, Matrix4, Quaternion, Plane, Ray, AABB
-  |- curves/        Line, Arc, Circle, Polyline, Polycurve
-  |- intersection/  Curve-curve intersections
-  |- mesh/          Half-edge data structure, primitives
-  |- ops/           Boolean, extrude, loft, sweep, subdivide, bevel...
-  |- spatial/       BVH, ray casting, closest point
-  |- io/            OBJ format
-```
-
-The engine uses an **index-based half-edge mesh** data structure for cache-friendly traversal and easy WASM serialization. All data crosses the WASM boundary as flat typed arrays to minimize overhead.
-
-## Building
-
-### Prerequisites
-- [Rust](https://rustup.rs/)
-- [wasm-pack](https://rustwasm.github.io/wasm-pack/installer/)
-
-### Build WASM
-```bash
-wasm-pack build --target web
-```
-
-### Run tests
-```bash
-cargo test
-```
-
-### Viewer
-The `okgeometry-viewer/` directory contains interactive Three.js viewers for visual verification:
-
-```bash
-# Serve the viewer directory with any static file server, e.g.:
-npx serve okgeometry-viewer
-```
-
-Available viewers:
-- **Curves** - Line, Circle, Arc, Polyline visualization
-- **Intersections** - All curve-curve intersection scenarios
-- **Meshes** - Primitives, wireframe, OBJ import/export
-- **Booleans** - Union, intersection, subtraction with position controls
-- **Subdivision** - Catmull-Clark and Loop with iteration slider
-- **Ray Casting** - Interactive ray cast and closest point queries
-- **Bevel / Chamfer** - Flat bevel on box, cylinder, prism
-
-## Dependencies
-
-| Crate | Purpose |
-|-------|---------|
-| `wasm-bindgen` | Rust-WASM interop |
-| `js-sys` / `web-sys` | Browser API access |
-| `robust` | Exact geometric predicates (orient2d, orient3d, incircle) |
-| `spade` | Constrained Delaunay triangulation |
-| `serde` | Serialization |
-| `nalgebra` | Linear algebra (optional feature) |
-
-## License
-
-Copyright Mostafa El Ayoubi / Orkestra Online. All rights reserved.
-
-Boolean-kernel structural ports inspired by Manifold are tracked in [`MANIFOLD_PORT_ATTRIBUTION.md`](./MANIFOLD_PORT_ATTRIBUTION.md).