@tscircuit/find-convex-regions 0.0.1

package/README.md

@@ -0,0 +1,44 @@
+# @tscircuit/find-convex-regions
+
+Use `ConvexRegionsSolver` to compute convex regions from your own bounds and vias.
+
+## Usage
+
+```ts
+import { ConvexRegionsSolver } from "@tscircuit/find-convex-regions"
+
+const bounds = { minX: 0, maxX: 450, minY: 0, maxY: 450 }
+
+const vias = [
+  { center: { x: 120, y: 150 }, diameter: 30 },
+  { center: { x: 250, y: 100 }, diameter: 25 },
+  { center: { x: 200, y: 280 }, diameter: 35 },
+]
+
+const solver = new ConvexRegionsSolver({
+  bounds,
+  vias,
+  clearance: 8,
+  concavityTolerance: 0,
+})
+
+solver.solve()
+
+const output = solver.getOutput()
+if (!output) throw new Error("Failed to compute convex regions")
+
+console.log(output.regions)
+```
+
+## Input Shape
+
+```ts
+type Point = { x: number; y: number }
+type Via = { center: Point; diameter: number }
+type Bounds = { minX: number; maxX: number; minY: number; maxY: number }
+```
+
+- `bounds`: your board/area rectangle.
+- `vias`: your own keepouts (bring your own vias).
+- `clearance`: extra radius added around each via.
+- `concavityTolerance`: `0` for strict convex regions; higher values allow shallow concavity when merging.

package/dist/index.d.ts

@@ -0,0 +1,144 @@
+import * as _tscircuit_solver_utils from '@tscircuit/solver-utils';
+import { BaseSolver, BasePipelineSolver } from '@tscircuit/solver-utils';
+import { GraphicsObject } from 'graphics-debug';
+
+type Point = {
+    x: number;
+    y: number;
+};
+type Via = {
+    center: Point;
+    diameter: number;
+};
+type Bounds = {
+    minX: number;
+    maxX: number;
+    minY: number;
+    maxY: number;
+};
+type Triangle = [number, number, number];
+type ConvexRegionsComputeInput = {
+    bounds: Bounds;
+    vias: Via[];
+    clearance: number;
+    concavityTolerance: number;
+};
+type ConvexRegionsComputeResult = {
+    pts: Point[];
+    validTris: Triangle[];
+    regions: Point[][];
+    hulls: Point[][];
+    depths: number[];
+};
+type RegionPort = {
+    x: number;
+    y: number;
+    region: number;
+};
+type GeneratePointsStageOutput = {
+    pts: Point[];
+};
+type TriangulateStageInput = GeneratePointsStageOutput & {
+    bounds: Bounds;
+    vias: Via[];
+    clearance: number;
+};
+type TriangulateStageOutput = GeneratePointsStageOutput & {
+    validTris: Triangle[];
+};
+type MergeCellsStageInput = TriangulateStageOutput & {
+    concavityTolerance: number;
+};
+type MergeCellsStageOutput = TriangulateStageOutput & {
+    cells: number[][];
+    depths: number[];
+};
+
+declare class BuildRegionsSolver extends BaseSolver {
+    private readonly input;
+    private output;
+    constructor(input: MergeCellsStageOutput);
+    _step(): void;
+    getConstructorParams(): [MergeCellsStageOutput];
+    getOutput(): ConvexRegionsComputeResult | null;
+    visualize(): GraphicsObject;
+}
+
+declare const buildRegionsFromCells: (merged: MergeCellsStageOutput) => {
+    regions: Point[][];
+    hulls: Point[][];
+};
+
+declare class GeneratePointsSolver extends BaseSolver {
+    private readonly input;
+    private output;
+    constructor(input: ConvexRegionsComputeInput);
+    _step(): void;
+    getConstructorParams(): [ConvexRegionsComputeInput];
+    getOutput(): GeneratePointsStageOutput | null;
+    visualize(): GraphicsObject;
+}
+
+declare class MergeCellsSolver extends BaseSolver {
+    private readonly input;
+    private output;
+    constructor(input: MergeCellsStageInput);
+    _step(): void;
+    getConstructorParams(): [MergeCellsStageInput];
+    getOutput(): MergeCellsStageOutput | null;
+    visualize(): GraphicsObject;
+}
+
+declare class TriangulateSolver extends BaseSolver {
+    private readonly input;
+    private output;
+    constructor(input: TriangulateStageInput);
+    _step(): void;
+    getConstructorParams(): [TriangulateStageInput];
+    getOutput(): TriangulateStageOutput | null;
+    visualize(): GraphicsObject;
+}
+
+declare class ConvexRegionsSolver extends BasePipelineSolver<ConvexRegionsComputeInput> {
+    pipelineDef: (_tscircuit_solver_utils.PipelineStep<GeneratePointsSolver> | _tscircuit_solver_utils.PipelineStep<TriangulateSolver> | _tscircuit_solver_utils.PipelineStep<MergeCellsSolver> | _tscircuit_solver_utils.PipelineStep<BuildRegionsSolver>)[];
+    getConstructorParams(): [ConvexRegionsComputeInput];
+    getOutput(): ConvexRegionsComputeResult | null;
+    visualize(): GraphicsObject;
+}
+
+declare const computeConvexRegions: (input: ConvexRegionsComputeInput) => ConvexRegionsComputeResult;
+
+declare const computeRegionPorts: (regions: Point[][], bounds: Bounds, vias: Via[], clearance: number) => RegionPort[];
+
+declare const concavityDepth: (ring: number[], pts: Point[]) => number;
+
+declare const cross: (o: Point, a: Point, b: Point) => number;
+
+declare const delaunay: (rawPoints: Point[]) => Triangle[];
+
+declare const dist2: (a: Point, b: Point) => number;
+
+declare const filterTris: (triangles: Triangle[], pts: Point[], bounds: Bounds, vias: Via[], clearance: number) => Triangle[];
+
+declare const genPoints: (bounds: Bounds, vias: Via[], clearance: number) => Point[];
+
+declare const hullIdx: (indices: number[], pts: Point[]) => number[];
+
+declare const inFreeSpace: (px: number, py: number, bounds: Bounds, vias: Via[], clearance: number) => boolean;
+
+declare const isDefined: <T>(value: T | undefined) => value is T;
+
+declare const mergeCells: (triangles: Triangle[], pts: Point[], concavityTolerance: number) => {
+    cells: number[][];
+    depths: number[];
+};
+
+declare const polyArea: (ring: Point[]) => number;
+
+declare const ptSegDist: (p: Point, a: Point, b: Point) => number;
+
+declare const regionPath: (region: Point[]) => string;
+
+declare const stitchRings: (ringA: number[], ringB: number[]) => number[] | null;
+
+export { type Bounds, BuildRegionsSolver, type ConvexRegionsComputeInput, type ConvexRegionsComputeResult, ConvexRegionsSolver, GeneratePointsSolver, type GeneratePointsStageOutput, MergeCellsSolver, type MergeCellsStageInput, type MergeCellsStageOutput, type Point, type RegionPort, type Triangle, TriangulateSolver, type TriangulateStageInput, type TriangulateStageOutput, type Via, buildRegionsFromCells, computeConvexRegions, computeRegionPorts, concavityDepth, cross, delaunay, dist2, filterTris, genPoints, hullIdx, inFreeSpace, isDefined, mergeCells, polyArea, ptSegDist, regionPath, stitchRings };