@tscircuit/checks 0.0.157 → 0.0.159

package/dist/index.d.ts

@@ -23,6 +23,12 @@ declare function checkViasOffBoard(circuitJson: AnyCircuitElement[]): PcbPlaceme
  */
 declare function checkPcbComponentsOutOfBoard(circuitJson: AnyCircuitElement[]): PcbComponentOutsideBoardError[];
 
+/**
+ * Cutouts remove PCB material on every layer, so a component body or SMT pad
+ * overlapping a cutout is invalid on both top and bottom.
+ */
+declare function checkPcbComponentOverCutout(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
+
 declare function checkSameNetViaSpacing(circuitJson: AnyCircuitElement[], { connMap, minClearance, }?: {
     connMap?: ConnectivityMap;
     minClearance?: number;
@@ -166,4 +172,4 @@ declare function checkConnectorAccessibleOrientation(circuitJson: AnyCircuitElem
  */
 declare function checkTestPointAccessibility(circuitJson: AnyCircuitElement[]): PcbPlacementError[];
 
-export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };
+export { NetManager, checkAllPinsInComponentAreUnderspecified, checkConnectorAccessibleOrientation, checkDifferentNetViaSpacing, checkEachPcbPortConnectedToPcbTraces, checkEachPcbTraceNonOverlapping, checkNoGroundPinDefined, checkNoPowerPinDefined, checkPadPadClearance, checkPadTraceClearance, checkPcbComponentOverCutout, checkPcbComponentOverlap, checkPcbComponentsOutOfBoard, checkPcbTraceLengths, checkPcbTracesOutOfBoard, checkPinMustBeConnected, checkSameNetViaSpacing, checkSourceTracesHavePcbTraces, checkSourceTracesMatchPcbTraceThickness, checkTestPointAccessibility, checkTracesAreContiguous, checkViaPadClearance, checkViaTraceClearance, checkViasInPads, checkViasOffBoard, dedupePcbDrcErrors, runAllChecks, runAllNetlistChecks, runAllPinSpecificationChecks, runAllPlacementChecks, runAllRoutingChecks };

package/dist/index.js

@@ -1789,6 +1789,132 @@ function checkPcbComponentsOutOfBoard(circuitJson) {
   return errors;
 }
 
+// lib/check-pcb-component-over-cutout.ts
+import { doBoundsOverlap } from "@tscircuit/math-utils";
+import * as Flatten2 from "@flatten-js/core";
+import { applyToPoint as applyToPoint2, rotateDEG as rotateDEG2 } from "transformation-matrix";
+var CUTOUT_CIRCLE_SEGMENTS = 32;
+function rectanglePolygon2({
+  center,
+  width,
+  height,
+  rotation = 0
+}) {
+  const halfWidth = width / 2;
+  const halfHeight = height / 2;
+  const corners = [
+    { x: center.x - halfWidth, y: center.y - halfHeight },
+    { x: center.x + halfWidth, y: center.y - halfHeight },
+    { x: center.x + halfWidth, y: center.y + halfHeight },
+    { x: center.x - halfWidth, y: center.y + halfHeight }
+  ];
+  const matrix = rotateDEG2(rotation, center.x, center.y);
+  return new Flatten2.Polygon(
+    corners.map((corner) => {
+      const rotated = rotation ? applyToPoint2(matrix, corner) : corner;
+      return new Flatten2.Point(rotated.x, rotated.y);
+    })
+  );
+}
+function circlePolygon({
+  center,
+  radius
+}) {
+  return new Flatten2.Polygon(
+    Array.from({ length: CUTOUT_CIRCLE_SEGMENTS }, (_, index) => {
+      const angle = 2 * Math.PI * index / CUTOUT_CIRCLE_SEGMENTS;
+      return new Flatten2.Point(
+        center.x + Math.cos(angle) * radius,
+        center.y + Math.sin(angle) * radius
+      );
+    })
+  );
+}
+function cutoutToPolygon(cutout) {
+  if (cutout.shape === "rect") {
+    return rectanglePolygon2({
+      center: cutout.center,
+      width: cutout.width,
+      height: cutout.height,
+      rotation: cutout.rotation ?? 0
+    });
+  }
+  if (cutout.shape === "circle") {
+    return circlePolygon({ center: cutout.center, radius: cutout.radius });
+  }
+  if (cutout.shape === "polygon") {
+    return new Flatten2.Polygon(
+      cutout.points.map((point) => new Flatten2.Point(point.x, point.y))
+    );
+  }
+  return null;
+}
+function polygonBoxToBounds(polygon) {
+  return {
+    minX: polygon.box.xmin,
+    minY: polygon.box.ymin,
+    maxX: polygon.box.xmax,
+    maxY: polygon.box.ymax
+  };
+}
+function doPolygonsOverlap(polygonA, polygonB) {
+  if (!doBoundsOverlap(polygonBoxToBounds(polygonA), polygonBoxToBounds(polygonB))) {
+    return false;
+  }
+  if (polygonA.contains(polygonB) || polygonB.contains(polygonA)) return true;
+  try {
+    const intersections = Flatten2.BooleanOperations.intersect(
+      polygonA,
+      polygonB
+    );
+    if (Array.isArray(intersections)) {
+      return intersections.some((polygon) => polygon.area() > 0);
+    }
+    return intersections.area() > 0;
+  } catch {
+    return false;
+  }
+}
+function checkPcbComponentOverCutout(circuitJson) {
+  const cutouts = circuitJson.filter(
+    (element) => element.type === "pcb_cutout"
+  );
+  const components = circuitJson.filter(
+    (element) => element.type === "pcb_component"
+  );
+  if (cutouts.length === 0 || components.length === 0) return [];
+  const cutoutPolygons = cutouts.map((cutout) => ({ cutout, polygon: cutoutToPolygon(cutout) })).filter(
+    (entry) => entry.polygon !== null && entry.polygon.area() > 0
+  );
+  const errors = [];
+  for (const component of components) {
+    if (!component.center || component.width <= 0 || component.height <= 0) {
+      continue;
+    }
+    const componentPolygon = rectanglePolygon2({
+      center: component.center,
+      width: component.width,
+      height: component.height
+    });
+    for (const { cutout, polygon: cutoutPolygon } of cutoutPolygons) {
+      if (!doPolygonsOverlap(componentPolygon, cutoutPolygon)) continue;
+      const componentName = getReadableNameForComponent(
+        circuitJson,
+        component.pcb_component_id
+      );
+      const cutoutId = cutout.pcb_cutout_id;
+      errors.push({
+        type: "pcb_placement_error",
+        pcb_placement_error_id: `component_over_cutout_${component.pcb_component_id}_${cutoutId}`,
+        error_type: "pcb_placement_error",
+        message: `Component ${componentName} overlaps with pcb_cutout [${cutoutId}]`,
+        subcircuit_id: component.subcircuit_id
+      });
+    }
+  }
+  return errors;
+}
+
 // lib/check-same-net-via-spacing.ts
 import { getReadableNameForElement as getReadableNameForElement4 } from "@tscircuit/circuit-json-util";
 import {
@@ -2377,12 +2503,12 @@ import {
   getBoundsOfPcbElements as getBoundsOfPcbElements5,
   getPrimaryId as getPrimaryId2
 } from "@tscircuit/circuit-json-util";
-import { doBoundsOverlap as doBoundsOverlap2 } from "@tscircuit/math-utils";
+import { doBoundsOverlap as doBoundsOverlap3 } from "@tscircuit/math-utils";
 import { getFullConnectivityMapFromCircuitJson as getFullConnectivityMapFromCircuitJson7 } from "circuit-json-to-connectivity-map";
 
 // lib/check-pcb-components-overlap/doPcbElementsOverlap.ts
 import { getBoundsOfPcbElements as getBoundsOfPcbElements4 } from "@tscircuit/circuit-json-util";
-import { doBoundsOverlap } from "@tscircuit/math-utils";
+import { doBoundsOverlap as doBoundsOverlap2 } from "@tscircuit/math-utils";
 function getElementLayers(elem) {
   if (elem.type === "pcb_courtyard_circle" || elem.type === "pcb_courtyard_outline" || elem.type === "pcb_courtyard_polygon" || elem.type === "pcb_courtyard_rect") {
     return [elem.layer];
@@ -2402,7 +2528,7 @@ function doPcbElementsOverlap(elem1, elem2) {
   }
   const bounds1 = getBoundsOfPcbElements4([elem1]);
   const bounds2 = getBoundsOfPcbElements4([elem2]);
-  return doBoundsOverlap(bounds1, bounds2);
+  return doBoundsOverlap2(bounds1, bounds2);
 }
 
 // lib/check-pcb-components-overlap/checkPcbComponentOverlap.ts
@@ -2475,7 +2601,7 @@ function checkPcbComponentOverlap(circuitJson) {
       if (!comp1.bounds || !comp2.bounds) {
         continue;
       }
-      if (!doBoundsOverlap2(comp1.bounds, comp2.bounds)) {
+      if (!doBoundsOverlap3(comp1.bounds, comp2.bounds)) {
         continue;
       }
       for (const elem1 of comp1.elements) {
@@ -3385,6 +3511,7 @@ async function runAllPlacementChecks(circuitJson) {
     ...checkViasOffBoard(circuitJson),
     ...checkViasInPads(circuitJson),
     ...checkPcbComponentsOutOfBoard(circuitJson),
+    ...checkPcbComponentOverCutout(circuitJson),
     ...checkPcbComponentOverlap(circuitJson),
     ...checkPadPadClearance(circuitJson),
     ...checkCourtyardOverlap(circuitJson),
@@ -3436,6 +3563,7 @@ export {
   checkNoPowerPinDefined,
   checkPadPadClearance,
   checkPadTraceClearance,
+  checkPcbComponentOverCutout,
   checkPcbComponentOverlap,
   checkPcbComponentsOutOfBoard,
   checkPcbTraceLengths,