tess-extrude 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Evangelos Karatzaferis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,112 @@
+# tess-extrude
+
+Extrude 2D polygon outlines into `THREE.BufferGeometry` using poly2tri Delaunay tessellation.
+
+## Install
+
+```bash
+npm install tess-extrude
+# three is a peer dependency
+npm install three
+```
+
+## Quick Start — points input
+
+```typescript
+import * as THREE from 'three';
+import { extrude } from 'tess-extrude';
+
+const points = [
+  { x: 0,   y: 0 },
+  { x: 100, y: 0 },
+  { x: 100, y: 100 },
+  { x: 0,   y: 100 },
+];
+
+const geometry = extrude({ type: 'points', points });
+if (geometry) {
+  const mesh = new THREE.Mesh(geometry, new THREE.MeshStandardMaterial());
+  scene.add(mesh);
+}
+```
+
+## Quick Start — SVG input
+
+```typescript
+import { extrude } from 'tess-extrude';
+
+// base64-encoded SVG string (data URI prefix optional)
+const geometry = extrude({ type: 'svg', data: base64SvgString }, { depth: 30 });
+```
+
+> **Note:** SVG input requires a browser environment (SVGLoader uses `DOMParser` internally).
+
+## API
+
+### `extrude(input, options?)`
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `input` | `PointInput \| SVGInput` | Shape to extrude |
+| `options` | `Partial<ExtrudeOptions>` | See options table |
+
+Returns `THREE.BufferGeometry | null`. Never throws — returns `null` for degenerate input or triangulation failure.
+
+### Input types
+
+```typescript
+// Raw polygon points
+{ type: 'points'; points: Point2D[] }
+
+// base64-encoded SVG string
+{ type: 'svg'; data: string }
+```
+
+### Options
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `depth` | `number` | `20` | Extrusion depth along Z axis |
+| `depthSegments` | `number` | `4` | Number of side-wall segments along depth |
+| `capDensity` | `number` | `5` | Interior Steiner point density (1–20). Higher = more triangles in caps |
+| `edgeSubdivisions` | `number` | `2` | Subdivisions per boundary edge |
+
+### Utility exports
+
+```typescript
+import { simplifyPath, deduplicatePoints, subdivideBoundary, ensureCCW } from 'tess-extrude';
+```
+
+| Function | Signature | Description |
+|----------|-----------|-------------|
+| `simplifyPath` | `(points, tolerance) => Point2D[]` | Douglas-Peucker path simplification |
+| `deduplicatePoints` | `(points, eps?) => Point2D[]` | Remove consecutive near-duplicate points |
+| `subdivideBoundary` | `(points, subdivisions) => Point2D[]` | Subdivide each edge |
+| `ensureCCW` | `(points) => Point2D[]` | Ensure counter-clockwise winding |
+
+## Memory management
+
+Dispose of geometries when no longer needed to free GPU memory:
+
+```typescript
+geometry.dispose();
+```
+
+For SVG input with multiple paths, all paths are merged into a single geometry automatically.
+
+## Browser / Node compatibility
+
+| Feature | Browser | Node |
+|---------|---------|------|
+| Points input | ✅ | ✅ |
+| SVG input | ✅ | ❌ (requires DOMParser) |
+
+## Development
+
+```bash
+npm install
+npm run dev      # demo at http://localhost:5173
+npm run build    # build library to dist/
+npm run test     # run vitest tests
+npm run lint     # eslint
+```

package/dist/index.d.ts

@@ -0,0 +1,61 @@
+import * as THREE from 'three';
+
+/** Remove consecutive near-duplicate points (including last≈first wrap). */
+export declare function deduplicatePoints(points: Point2D[], eps?: number): Point2D[];
+
+/**
+ * Ensure the polygon winding is counter-clockwise (positive signed area via
+ * the shoelace formula). poly2tri requires CCW contours.
+ */
+export declare function ensureCCW(points: Point2D[]): Point2D[];
+
+/**
+ * Extrude a 2D shape into a THREE.BufferGeometry.
+ *
+ * Accepts raw polygon points or a base64-encoded SVG.
+ * Returns `null` (never throws) on degenerate input or triangulation failure.
+ */
+export declare function extrude(input: ExtrudeInput, options?: Partial<ExtrudeOptions>): THREE.BufferGeometry | null;
+
+export declare type ExtrudeInput = PointInput | SVGInput;
+
+export declare interface ExtrudeOptions {
+    /** Extrusion depth. Default: 20 */
+    depth: number;
+    /** Number of depth segments for side walls. Default: 4 */
+    depthSegments: number;
+    /** Cap triangulation density (1–20). Default: 5 */
+    capDensity: number;
+    /** Number of edge subdivisions for boundary. Default: 2 */
+    edgeSubdivisions: number;
+}
+
+export declare interface Point2D {
+    x: number;
+    y: number;
+}
+
+export declare interface PointInput {
+    type: 'points';
+    points: Point2D[];
+}
+
+/**
+ * Iterative Douglas-Peucker simplification.
+ * Avoids recursion and array slicing for better performance on large inputs.
+ */
+export declare function simplifyPath(points: Point2D[], tolerance: number): Point2D[];
+
+/**
+ * Subdivide each boundary edge into `subdivisions` equal segments.
+ * Returns a pre-allocated flat array of the new boundary points.
+ */
+export declare function subdivideBoundary(points: Point2D[], subdivisions: number): Point2D[];
+
+export declare interface SVGInput {
+    type: 'svg';
+    /** base64-encoded SVG string, with or without data URI prefix */
+    data: string;
+}
+
+export { }