@tscircuit/core 0.0.29 → 0.0.31

package/lib/components/primitive-components/Footprint.ts

@@ -1,4 +1,161 @@
 import type { footprintProps } from "@tscircuit/props"
 import { PrimitiveComponent } from "../base-components/PrimitiveComponent"
+import type { Constraint } from "./Constraint"
+import * as kiwi from "@lume/kiwi"
+import Debug from "debug"
 
-export class Footprint extends PrimitiveComponent<typeof footprintProps> {}
+const debug = Debug("tscircuit:core:footprint")
+
+export class Footprint extends PrimitiveComponent<typeof footprintProps> {
+  /**
+   * A footprint is a constrainedlayout, the db elements are adjusted according
+   * to any constraints that are defined.
+   */
+  doInitialPcbFootprintLayout() {
+    const constraints = this.children.filter(
+      (child) => child.componentName === "Constraint",
+    ) as Constraint[]
+
+    if (constraints.length === 0) return
+
+    const involvedComponents = constraints
+      .flatMap(
+        (constraint) =>
+          constraint._getAllReferencedComponents().componentsWithSelectors,
+      )
+      .map(({ component, selector }) => ({
+        component,
+        selector,
+        bounds: component._getCircuitJsonBounds(),
+      }))
+
+    function getComponentDetails(selector: string) {
+      return involvedComponents.find(({ selector: s }) => s === selector)
+    }
+
+    const solver = new kiwi.Solver()
+
+    const kVars: { [varName: string]: kiwi.Variable } = {}
+    function getKVar(name: string) {
+      if (!(name in kVars)) {
+        kVars[name] = new kiwi.Variable(name)
+      }
+      return kVars[name]
+    }
+
+    // 1. Create kiwi variables to represent each component's center
+    for (const { selector, bounds } of involvedComponents) {
+      const kvx = getKVar(`${selector}_x`)
+      const kvy = getKVar(`${selector}_y`)
+      solver.addEditVariable(kvx, kiwi.Strength.weak)
+      solver.addEditVariable(kvy, kiwi.Strength.weak)
+      solver.suggestValue(kvx, bounds.center.x)
+      solver.suggestValue(kvy, bounds.center.y)
+    }
+
+    // 2. Add kiwi constraints using the parsed constraint properties
+    for (const constraint of constraints) {
+      const props = constraint._parsedProps
+
+      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!
+        const rightBounds = getComponentDetails(right)?.bounds!
+
+        if (centerToCenter) {
+          // right - left = xdist
+          const expr = new kiwi.Expression(rightVar, [-1, leftVar])
+          solver.addConstraint(
+            new kiwi.Constraint(
+              expr,
+              kiwi.Operator.Eq,
+              props.xdist,
+              kiwi.Strength.required,
+            ),
+          )
+        } else if (edgeToEdge) {
+          // rightEdge - leftEdge = xdist
+          // right + rightBounds.width/2 - left - leftBounds.width/2 = xdist
+          const expr = new kiwi.Expression(
+            rightVar,
+            rightBounds.width / 2,
+            [-1, leftVar],
+            -leftBounds.width / 2,
+          )
+          solver.addConstraint(
+            new kiwi.Constraint(
+              expr,
+              kiwi.Operator.Eq,
+              props.xdist,
+              kiwi.Strength.required,
+            ),
+          )
+        }
+      }
+
+      // 3. Solve the system of equations
+      solver.updateVariables()
+      if (debug.enabled) {
+        console.log("Solution to layout constraints:")
+        console.table(
+          Object.entries(kVars).map(([key, kvar]) => ({
+            var: key,
+            val: kvar.value(),
+          })),
+        )
+      }
+
+      // 3.1 Compute the global offset. There are different ways to do this:
+      // - If any component has a fixed position, then that can be used as the
+      //   origin to determine the offset of all other components
+      // - If no component has a fixed position, then we recenter everything
+      //   using the new bounds of all the involved components
+
+      // TODO determine if there's a fixed component
+
+      // Determine the new bounds all the involved components and compute the
+      // bounds of this footprint
+      const bounds = {
+        left: Infinity,
+        right: -Infinity,
+        top: -Infinity,
+        bottom: Infinity,
+      }
+      for (const {
+        selector,
+        bounds: { width, height },
+      } of involvedComponents) {
+        const kvx = getKVar(`${selector}_x`)
+        const kvy = getKVar(`${selector}_y`)
+
+        const newLeft = kvx.value() - width / 2
+        const newRight = kvx.value() + width / 2
+        const newTop = kvy.value() + height / 2
+        const newBottom = kvy.value() - height / 2
+
+        bounds.left = Math.min(bounds.left, newLeft)
+        bounds.right = Math.max(bounds.right, newRight)
+        bounds.top = Math.max(bounds.top, newTop)
+        bounds.bottom = Math.min(bounds.bottom, newBottom)
+      }
+
+      // Compute the global offset, we can use this to recenter each component
+      const globalOffset = {
+        x: -(bounds.right + bounds.left) / 2,
+        y: -(bounds.top + bounds.bottom) / 2,
+      }
+
+      // 4. Update the component positions
+      for (const { component, selector } of involvedComponents) {
+        const kvx = getKVar(`${selector}_x`)
+        const kvy = getKVar(`${selector}_y`)
+        component._setPositionFromLayout({
+          x: kvx.value() + globalOffset.x,
+          y: kvy.value() + globalOffset.y,
+        })
+      }
+    }
+  }
+}

package/lib/components/primitive-components/Net.ts

@@ -18,7 +18,7 @@ export class Net extends PrimitiveComponent<typeof netProps> {
   }
 
   doInitialSourceComponentRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const net = db.source_net.insert({
@@ -77,7 +77,7 @@ export class Net extends PrimitiveComponent<typeof netProps> {
    * such that the nets are fully connected
    */
   doInitialPcbRouteNetIslands(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const traces = this._getAllDirectlyConnectedTraces().filter(
@@ -109,10 +109,10 @@ export class Net extends PrimitiveComponent<typeof netProps> {
     for (const [A, B] of islandPairs) {
       // Find two closest ports on the island
       const Apositions: Array<{ x: number; y: number }> = A.ports.map((port) =>
-        port.getGlobalPcbPosition(),
+        port._getGlobalPcbPositionBeforeLayout(),
       )
       const Bpositions: Array<{ x: number; y: number }> = B.ports.map((port) =>
-        port.getGlobalPcbPosition(),
+        port._getGlobalPcbPositionBeforeLayout(),
       )
 
       let closestDist = Infinity

package/lib/components/primitive-components/PlatedHole.ts

@@ -46,10 +46,10 @@ export class PlatedHole extends PrimitiveComponent<typeof platedHoleProps> {
   }
 
   doInitialPcbPrimitiveRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     if (!props.portHints) return
-    const position = this.getGlobalPcbPosition()
+    const position = this._getGlobalPcbPositionBeforeLayout()
     if (props.shape === "circle") {
       const plated_hole_input: PCBPlatedHoleInput = {
         pcb_component_id: this.parent?.pcb_component_id!,

package/lib/components/primitive-components/Port.ts

@@ -32,7 +32,7 @@ export class Port extends PrimitiveComponent<typeof portProps> {
     this.matchedComponents = []
   }
 
-  getGlobalPcbPosition(): { x: number; y: number } {
+  _getGlobalPcbPositionBeforeLayout(): { x: number; y: number } {
     const matchedPcbElm = this.matchedComponents.find((c) => c.isPcbPrimitive)
 
     if (!matchedPcbElm) {
@@ -41,10 +41,10 @@ export class Port extends PrimitiveComponent<typeof portProps> {
       )
     }
 
-    return matchedPcbElm?.getGlobalPcbPosition() ?? { x: 0, y: 0 }
+    return matchedPcbElm?._getGlobalPcbPositionBeforeLayout() ?? { x: 0, y: 0 }
   }
 
-  getGlobalSchematicPosition(): { x: number; y: number } {
+  _getGlobalSchematicPositionBeforeLayout(): { x: number; y: number } {
     if (!this.schematicSymbolPortDef) {
       return applyToPoint(this.parent!.computeSchematicGlobalTransform(), {
         x: 0,
@@ -116,7 +116,7 @@ export class Port extends PrimitiveComponent<typeof portProps> {
   }
 
   doInitialSourceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const port_hints = this.getNameAndAliases()
@@ -132,7 +132,7 @@ export class Port extends PrimitiveComponent<typeof portProps> {
   }
 
   doInitialSourceParentAttachment(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     if (!this.parent?.source_component_id) {
       throw new Error(
         `${this.getString()} has no parent source component (parent: ${this.parent?.getString()})`,
@@ -146,13 +146,8 @@ export class Port extends PrimitiveComponent<typeof portProps> {
     this.source_component_id = this.parent?.source_component_id
   }
 
-  /**
-   * For PcbPorts, we use the parent attachment phase to determine where to place
-   * the pcb_port (prior to this phase, the smtpad/platedhole isn't guaranteed
-   * to exist)
-   */
   doInitialPcbPortRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { matchedComponents } = this
 
     if (!this.parent?.pcb_component_id) {
@@ -173,31 +168,31 @@ export class Port extends PrimitiveComponent<typeof portProps> {
 
     const pcbMatch: any = pcbMatches[0]
 
-    if ("getGlobalPcbPosition" in pcbMatch) {
+    if ("_getCircuitJsonBounds" in pcbMatch) {
       const pcb_port = db.pcb_port.insert({
         pcb_component_id: this.parent?.pcb_component_id!,
         layers: ["top"],
 
-        ...pcbMatch.getGlobalPcbPosition(),
+        ...pcbMatch._getCircuitJsonBounds().center,
 
         source_port_id: this.source_port_id!,
       })
       this.pcb_port_id = pcb_port.pcb_port_id
     } else {
       throw new Error(
-        `${pcbMatch.getString()} does not have a getGlobalPcbPosition method (needed for pcb_port placement)`,
+        `${pcbMatch.getString()} does not have a _getGlobalPcbPositionBeforeLayout method (needed for pcb_port placement)`,
       )
     }
   }
 
   doInitialSchematicPortRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     if (!this.parent) return
 
-    const center = this.getGlobalSchematicPosition()
-    const parentCenter = this.parent?.getGlobalSchematicPosition()
+    const center = this._getGlobalSchematicPositionBeforeLayout()
+    const parentCenter = this.parent?._getGlobalSchematicPositionBeforeLayout()
 
     this.facingDirection = getRelativeDirection(parentCenter, center)
 

package/lib/components/primitive-components/SilkscreenPath.ts

@@ -14,7 +14,7 @@ export class SilkscreenPath extends PrimitiveComponent<
   }
 
   doInitialPcbPrimitiveRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
 
     const layer = props.layer ?? "top"
@@ -24,7 +24,7 @@ export class SilkscreenPath extends PrimitiveComponent<
       )
     }
 
-    const transform = this.computePcbGlobalTransform()
+    const transform = this._computePcbGlobalTransformBeforeLayout()
 
     const pcb_silkscreen_path = db.pcb_silkscreen_path.insert({
       pcb_component_id: this.parent?.pcb_component_id!,

package/lib/components/primitive-components/SmtPad.ts

@@ -32,8 +32,8 @@ export class SmtPad extends PrimitiveComponent<typeof smtPadProps> {
   }
 
   doInitialPortMatching(): void {
-    const parentPorts = (this.parent?.children ?? []).filter(
-      (c) => c.componentName === "Port",
+    const parentPorts = this.getPrimitiveContainer()?.selectAll(
+      "port",
     ) as Port[]
 
     if (!this.props.portHints) {
@@ -50,11 +50,13 @@ export class SmtPad extends PrimitiveComponent<typeof smtPadProps> {
   }
 
   doInitialPcbPrimitiveRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props } = this
     if (!props.portHints) return
-    const position = this.getGlobalPcbPosition()
-    const decomposedMat = decomposeTSR(this.computePcbGlobalTransform())
+    const position = this._getGlobalPcbPositionBeforeLayout()
+    const decomposedMat = decomposeTSR(
+      this._computePcbGlobalTransformBeforeLayout(),
+    )
     const isRotated90 =
       Math.abs(decomposedMat.rotation.angle * (180 / Math.PI) - 90) < 0.01
     let pcb_smtpad: PCBSMTPad | null = null
@@ -94,4 +96,52 @@ export class SmtPad extends PrimitiveComponent<typeof smtPadProps> {
       this.pcb_smtpad_id = pcb_smtpad.pcb_smtpad_id
     }
   }
+
+  _getCircuitJsonBounds(): {
+    center: { x: number; y: number }
+    bounds: { left: number; top: number; right: number; bottom: number }
+    width: number
+    height: number
+  } {
+    const { db } = this.root!
+    const smtpad = db.pcb_smtpad.get(this.pcb_smtpad_id!)!
+
+    if (smtpad.shape === "rect") {
+      return {
+        center: { x: smtpad.x, y: smtpad.y },
+        bounds: {
+          left: smtpad.x - smtpad.width / 2,
+          top: smtpad.y - smtpad.height / 2,
+          right: smtpad.x + smtpad.width / 2,
+          bottom: smtpad.y + smtpad.height / 2,
+        },
+        width: smtpad.width,
+        height: smtpad.height,
+      }
+    }
+    if (smtpad.shape === "circle") {
+      return {
+        center: { x: smtpad.x, y: smtpad.y },
+        bounds: {
+          left: smtpad.x - smtpad.radius,
+          top: smtpad.y - smtpad.radius,
+          right: smtpad.x + smtpad.radius,
+          bottom: smtpad.y + smtpad.radius,
+        },
+        width: smtpad.radius * 2,
+        height: smtpad.radius * 2,
+      }
+    }
+    throw new Error(
+      `circuitJson bounds calculation not implemented for shape "${(smtpad as any).shape}"`,
+    )
+  }
+
+  _setPositionFromLayout(newCenter: { x: number; y: number }) {
+    const { db } = this.root!
+    db.pcb_smtpad.update(this.pcb_smtpad_id!, {
+      x: newCenter.x,
+      y: newCenter.y,
+    })
+  }
 }

package/lib/components/primitive-components/Trace.ts

@@ -38,7 +38,7 @@ type PcbRouteObjective =
   | { layers: string[]; x: number; y: number; via?: boolean }
 
 const portToObjective = (port: Port): PcbRouteObjective => {
-  const portPosition = port.getGlobalPcbPosition()
+  const portPosition = port._getGlobalPcbPositionBeforeLayout()
   return {
     ...portPosition,
     layers: port.getAvailablePcbLayers(),
@@ -104,7 +104,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
         ports?: undefined
         portsWithSelectors?: undefined
       } {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props, parent } = this
 
     if (!parent) throw new Error("Trace has no parent")
@@ -215,7 +215,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
   }
 
   doInitialSourceTraceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props, parent } = this
 
     if (!parent) {
@@ -238,7 +238,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
   }
 
   doInitialPcbTraceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props, parent } = this
 
     if (!parent) throw new Error("Trace has no parent")
@@ -365,7 +365,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
 
     // Cache the PCB obstacles, they'll be needed for each segment between
     // ports/hints
-    const obstacles = getObstaclesFromSoup(this.project!.db.toArray())
+    const obstacles = getObstaclesFromSoup(this.root!.db.toArray())
     markObstaclesAsConnected(
       obstacles,
       orderedRouteObjectives,
@@ -445,7 +445,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
   }
 
   doInitialSchematicTraceRender(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props, parent } = this
 
     if (!parent) throw new Error("Trace has no parent")
@@ -476,7 +476,7 @@ export class Trace extends PrimitiveComponent<typeof traceProps> {
     for (const { port } of ports) {
       connection.pointsToConnect.push(
         projectPointInDirection(
-          port.getGlobalSchematicPosition(),
+          port._getGlobalSchematicPositionBeforeLayout(),
           port.facingDirection!,
           0.1501,
         ),

package/lib/components/primitive-components/TraceHint.ts

@@ -8,7 +8,7 @@ export class TraceHint extends PrimitiveComponent<typeof traceHintProps> {
   matchedPort: Port | null = null
 
   doInitialPortMatching(): void {
-    const { db } = this.project!
+    const { db } = this.root!
     const { _parsedProps: props, parent } = this
 
     if (!parent) return
@@ -46,7 +46,7 @@ export class TraceHint extends PrimitiveComponent<typeof traceHintProps> {
 
     if (!offsets) return []
 
-    const globalTransform = this.computePcbGlobalTransform()
+    const globalTransform = this._computePcbGlobalTransformBeforeLayout()
 
     return offsets.map(
       (offset): RouteHintPoint => ({

package/lib/fiber/intrinsic-jsx.ts

@@ -39,6 +39,8 @@ declare global {
       pcbtrace: Props.PcbTraceProps
       fabricationnotetext: Props.FabricationNoteTextProps
       fabricationnotepath: Props.FabricationNotePathProps
+      constraint: Props.ConstraintProps
+      constrainedlayout: Props.ConstrainedLayoutProps
       jscad: any
     }
   }

package/lib/utils/getClosest.ts

@@ -1,10 +1,16 @@
 export type PointLike =
-  | { getGlobalPcbPosition: () => { x: number; y: number } }
+  | { _getGlobalPcbPositionBeforeLayout: () => { x: number; y: number } }
   | { x: number; y: number }
 
 const getDistance = (a: PointLike, b: PointLike) => {
-  const aPos = "getGlobalPcbPosition" in a ? a.getGlobalPcbPosition() : a
-  const bPos = "getGlobalPcbPosition" in b ? b.getGlobalPcbPosition() : b
+  const aPos =
+    "_getGlobalPcbPositionBeforeLayout" in a
+      ? a._getGlobalPcbPositionBeforeLayout()
+      : a
+  const bPos =
+    "_getGlobalPcbPositionBeforeLayout" in b
+      ? b._getGlobalPcbPositionBeforeLayout()
+      : b
   return Math.sqrt((aPos.x - bPos.x) ** 2 + (aPos.y - bPos.y) ** 2)
 }
 

package/package.json

@@ -2,7 +2,7 @@
   "name": "@tscircuit/core",
   "module": "index.ts",
   "type": "module",
-  "version": "0.0.29",
+  "version": "0.0.31",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "files": [
@@ -19,10 +19,12 @@
     "@tscircuit/layout": "^0.0.28",
     "@tscircuit/log-soup": "^1.0.2",
     "@types/bun": "latest",
+    "@types/debug": "^4.1.12",
     "@types/react": "^18.3.3",
     "@types/react-reconciler": "^0.28.8",
     "bun-match-svg": "0.0.2",
     "circuit-to-svg": "^0.0.18",
+    "debug": "^4.3.6",
     "howfat": "^0.3.8",
     "looks-same": "^9.0.1",
     "tsup": "^8.2.4"
@@ -31,8 +33,9 @@
     "typescript": "^5.0.0"
   },
   "dependencies": {
+    "@lume/kiwi": "^0.4.3",
     "@tscircuit/infgrid-ijump-astar": "^0.0.6",
-    "@tscircuit/props": "^0.0.51",
+    "@tscircuit/props": "^0.0.58",
     "@tscircuit/soup": "^0.0.58",
     "@tscircuit/soup-util": "0.0.18",
     "footprinter": "^0.0.44",