Merge pull request #105 from tscircuit/boardthick

offset the 3d model based on board thickness

lib/Project.ts → lib/Circuit.ts

@@ -33,6 +33,17 @@ export class Circuit {
     this.children.push(component)
   }
 
+  /**
+   * Get the main board for this Circuit.
+   */
+  _getBoard(): PrimitiveComponent & { boardThickness: number } {
+    return this.children.find(
+      (c) => c.componentName === "Board",
+    ) as PrimitiveComponent & {
+      boardThickness: number
+    }
+  }
+
   _guessRootComponent() {
     if (this.firstChild) return
     if (this.children.length === 1) {

lib/components/base-components/NormalComponent.ts

@@ -420,6 +420,7 @@ export class NormalComponent<
 
   doInitialCadModelRender(): void {
     const { db } = this.root!
+    const { boardThickness = 0 } = this.root?._getBoard() ?? {}
     const { _parsedProps: props } = this
 
     if (props.cadModel) {
@@ -434,15 +435,24 @@ export class NormalComponent<
 
       const cad_model = db.cad_component.insert({
         // TODO z maybe depends on layer
-        position: { x: bounds.center.x, y: bounds.center.y, z: 0 },
+        position: {
+          x: bounds.center.x,
+          y: bounds.center.y,
+          z:
+            this.props.layer === "bottom"
+              ? -boardThickness / 2
+              : boardThickness / 2,
+        },
         pcb_component_id: this.pcb_component_id!,
         source_component_id: this.source_component_id!,
         model_stl_url: "stlUrl" in cadModel ? cadModel.stlUrl : undefined,
         model_obj_url: "objUrl" in cadModel ? cadModel.objUrl : undefined,
         model_jscad: "jscad" in cadModel ? cadModel.jscad : undefined,
 
-        // TODO
-        // footprinter_string:
+        footprinter_string:
+          typeof this.props.footprint === "string" && !cadModel
+            ? this.props.footprint
+            : undefined,
       })
     }
   }

lib/components/base-components/PrimitiveComponent.ts

@@ -1,5 +1,5 @@
 import type { AnySoupElement, AnySourceComponent } from "@tscircuit/soup"
-import type { Circuit } from "../../Project"
+import type { Circuit } from "../../Circuit"
 import type { ZodType } from "zod"
 import { z } from "zod"
 import { symbols, type SchSymbol, type BaseSymbolName } from "schematic-symbols"

lib/components/normal-components/Board.ts

@@ -17,6 +17,11 @@ export class Board extends Group<typeof boardProps> {
     }
   }
 
+  get boardThickness() {
+    const { _parsedProps: props } = this
+    return 1.4 // TODO use prop
+  }
+
   doInitialPcbComponentRender(): void {
     const { db } = this.root!
     const { _parsedProps: props } = this

lib/index.ts

@@ -1,5 +1,5 @@
 export * from "./components"
-export * from "./Project"
+export * from "./Circuit"
 
 import "./register-catalogue"
 import "./fiber/intrinsic-jsx"

tests/components/base-components/select-methods.test.tsx

@@ -1,5 +1,5 @@
 import { it, expect } from "bun:test"
-import { Circuit } from "lib/Project"
+import { Circuit } from "lib/Circuit"
 import "lib/register-catalogue"
 
 it("should correctly use selectAll and selectOne methods", () => {

tests/components/normal-components/chip-aliases.test.tsx

@@ -1,5 +1,5 @@
 import { it, expect } from "bun:test"
-import { Circuit } from "lib/Project"
+import { Circuit } from "lib/Circuit"
 import { Chip } from "lib/components/normal-components/Chip"
 import "lib/register-catalogue"
 import { getTestFixture } from "tests/fixtures/get-test-fixture"

tests/components/normal-components/chip.test.tsx

@@ -1,5 +1,5 @@
 import { it, expect } from "bun:test"
-import { Circuit } from "lib/Project"
+import { Circuit } from "lib/Circuit"
 import { Chip } from "lib/components/normal-components/Chip"
 import "lib/register-catalogue"
 import { getTestFixture } from "tests/fixtures/get-test-fixture"

tests/fixtures/extend-expect-circuit-snapshot.ts

@@ -4,7 +4,7 @@ import * as fs from "node:fs"
 import * as path from "node:path"
 import looksSame from "looks-same"
 import type { AnySoupElement } from "@tscircuit/soup"
-import { Circuit } from "lib/Project"
+import { Circuit } from "lib/Circuit"
 
 async function saveSnapshotOfSoup({
   soup,

tests/fixtures/get-test-fixture.ts

@@ -1,4 +1,4 @@
-import { Circuit } from "lib/Project"
+import { Circuit } from "lib/Circuit"
 import { logSoup } from "@tscircuit/log-soup"
 import "lib/register-catalogue"
 import "./extend-expect-circuit-snapshot"