Merge pull request #36 from tscircuit/samex

implement sameX/sameY, refactor constraint reference code in prepartion for edge selectors

lib/components/primitive-components/Constraint.ts

@@ -2,6 +2,16 @@ import { constraintProps } from "@tscircuit/props"
 import { z } from "zod"
 import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
 
+const edgeSpecifiers = [
+  "leftedge",
+  "rightedge",
+  "topedge",
+  "bottomedge",
+  "center",
+] as const
+
+export type EdgeSpecifier = (typeof edgeSpecifiers)[number]
+
 export class Constraint extends PrimitiveComponent<typeof constraintProps> {
   get config() {
     return {
@@ -13,34 +23,60 @@ export class Constraint extends PrimitiveComponent<typeof constraintProps> {
     super(props)
     if ("xdist" in props || "ydist" in props) {
       if (!("edgeToEdge" in props) && !("centerToCenter" in props)) {
+        // TODO don't throw an error if the selectors specify an edge
         throw new Error(
-          "edgeToEdge, centerToCenter (or from*/to* props) must be set for xdist or ydist for <constraint />",
+          `edgeToEdge, centerToCenter must be set for xDist or yDist for ${this}`,
         )
       }
     }
+    if ("for" in props && props.for.length < 2) {
+      throw new Error(`"for" must have at least two selectors for ${this}`)
+    }
   }
 
   _getAllReferencedComponents(): {
     componentsWithSelectors: Array<{
       component: PrimitiveComponent<any>
       selector: string
+      componentSelector: string
+      edge: EdgeSpecifier | undefined
     }>
   } {
     const componentsWithSelectors: Array<{
       component: PrimitiveComponent<any>
       selector: string
+      componentSelector: string
+      edge: EdgeSpecifier | undefined
     }> = []
 
+    const subcircuit = this.getSubcircuit()
+
+    function addComponentFromSelector(selector: string) {
+      // TODO this selector has to be modified in case it contains a leftedge,
+      // center/topedge/rightedge indicator
+      const component = subcircuit.selectOne(selector)
+      if (component) {
+        const maybeEdge = selector.split(" ").pop() as EdgeSpecifier
+        const edge = edgeSpecifiers.includes(maybeEdge) ? maybeEdge : undefined
+
+        componentsWithSelectors.push({
+          selector,
+          component,
+          componentSelector: edge ? selector.replace(` ${edge}`, "") : selector,
+          edge,
+        })
+      }
+    }
+
     for (const key of ["left", "right", "top", "bottom"]) {
       if (key in this._parsedProps) {
-        const selector = (this._parsedProps as any)[key] as string
-        const component = this.getSubcircuit().selectOne(selector)
-        if (component) {
-          componentsWithSelectors.push({
-            selector,
-            component,
-          })
-        }
+        addComponentFromSelector((this._parsedProps as any)[key] as string)
+      }
+    }
+
+    if ("for" in this._parsedProps) {
+      for (const selector of this._parsedProps.for) {
+        addComponentFromSelector(selector)
       }
     }
 

lib/components/primitive-components/Footprint.ts

@@ -23,12 +23,20 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
         (constraint) =>
           constraint._getAllReferencedComponents().componentsWithSelectors,
       )
-      .map(({ component, selector }) => ({
+      .map(({ component, selector, componentSelector, edge }) => ({
         component,
         selector,
+        componentSelector,
+        edge,
         bounds: component._getCircuitJsonBounds(),
       }))
 
+    if (involvedComponents.some((c) => c.edge)) {
+      throw new Error(
+        "edge constraints not implemented yet for footprint layout, contributions welcome!",
+      )
+    }
+
     function getComponentDetails(selector: string) {
       return involvedComponents.find(({ selector: s }) => s === selector)
     }
@@ -56,8 +64,8 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
     for (const constraint of constraints) {
       const props = constraint._parsedProps
 
-      if ("xdist" in props) {
-        const { xdist, left, right, edgeToEdge, centerToCenter } = props
+      if ("xDist" in props) {
+        const { xDist, left, right, edgeToEdge, centerToCenter } = props
         const leftVar = getKVar(`${left}_x`)
         const rightVar = getKVar(`${right}_x`)
         const leftBounds = getComponentDetails(left)?.bounds!
@@ -70,7 +78,7 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required,
             ),
           )
@@ -87,13 +95,13 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.xdist,
+              props.xDist,
               kiwi.Strength.required,
             ),
           )
         }
-      } else if ("ydist" in props) {
-        const { ydist, top, bottom, edgeToEdge, centerToCenter } = props
+      } else if ("yDist" in props) {
+        const { yDist, top, bottom, edgeToEdge, centerToCenter } = props
         const topVar = getKVar(`${top}_y`)
         const bottomVar = getKVar(`${bottom}_y`)
         const topBounds = getComponentDetails(top)?.bounds!
@@ -108,7 +116,7 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required,
             ),
           )
@@ -125,11 +133,38 @@ export class Footprint extends PrimitiveComponent<typeof footprintProps> {
             new kiwi.Constraint(
               expr,
               kiwi.Operator.Eq,
-              props.ydist,
+              props.yDist,
               kiwi.Strength.required,
             ),
           )
         }
+      } else if ("sameY" in props) {
+        const { for: selectors } = props
+        if (selectors.length < 2) continue
+        const vars = selectors.map((selector) => getKVar(`${selector}_y`))
+        const expr = new kiwi.Expression(...vars.slice(1))
+
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required,
+          ),
+        )
+      } else if ("sameX" in props) {
+        const { for: selectors } = props
+        if (selectors.length < 2) continue
+        const vars = selectors.map((selector) => getKVar(`${selector}_x`))
+        const expr = new kiwi.Expression(...vars.slice(1))
+        solver.addConstraint(
+          new kiwi.Constraint(
+            expr,
+            kiwi.Operator.Eq,
+            vars[0],
+            kiwi.Strength.required,
+          ),
+        )
       }
     }
 

lib/components/primitive-components/PlatedHole.ts

@@ -79,7 +79,6 @@ export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
   doInitialPcbPrimitiveRender(): void {
     const { db } = this.root!
     const { _parsedProps: props } = this
-    if (!props.portHints) return
     const position = this._getGlobalPcbPositionBeforeLayout()
     if (props.shape === "circle") {
       const pcb_plated_hole = db.pcb_plated_hole.insert({

package.json

@@ -35,7 +35,7 @@
   "dependencies": {
     "@lume/kiwi": "^0.4.3",
     "@tscircuit/infgrid-ijump-astar": "^0.0.6",
-    "@tscircuit/props": "^0.0.61",
+    "@tscircuit/props": "^0.0.62",
     "@tscircuit/soup": "^0.0.66",
     "@tscircuit/soup-util": "0.0.18",
     "footprinter": "^0.0.44",

tests/components/primitive-components/footprint-layout.test.tsx

@@ -22,16 +22,22 @@ test("footprint layout", () => {
               height="1mm"
               portHints={["pin2"]}
             />
-            <hole name="H1" diameter="1mm" />
-            <constraint pcb edgeToEdge xdist="4mm" left=".pin1" right=".pin2" />
+            <platedhole
+              name="H1"
+              holeDiameter="0.75mm"
+              outerDiameter="1mm"
+              shape="circle"
+            />
+            <constraint pcb edgeToEdge xDist="4mm" left=".pin1" right=".pin2" />
             <constraint
               pcb
               centerToCenter
-              xdist="2.5mm"
+              xDist="2.5mm"
               left=".pin1"
               right=".H1"
             />
-            <constraint centerToCenter ydist="2.5mm" top=".pin1" bottom=".H1" />
+            <constraint centerToCenter yDist="2.5mm" top=".pin1" bottom=".H1" />
+            <constraint sameY for={[".pin1", ".pin2"]} />
           </footprint>
         }
       />
@@ -56,7 +62,7 @@ test("footprint layout", () => {
   expect(pcbPorts[1].x).toBeOneOf([-2.5, 2.5])
 
   // Check hole position
-  const hole = circuit.db.pcb_hole.list()[0]
+  const hole = circuit.db.pcb_plated_hole.list()[0]
 
   expect(hole.x).toBeCloseTo(0, 1)
   expect(hole.y).toBeCloseTo(-1.25, 1)