circuit-json-to-gltf 0.0.113 → 0.0.115

package/README.md

@@ -70,8 +70,13 @@ convertCircuitJsonToGltf(circuitJson: CircuitJson, options?: ConversionOptions):
 - `drawFauxBoard`: Draw a fallback board if no `pcb_board` or `pcb_panel` is present - default: false
 - `includeModels`: Whether to load external 3D models - default: true
 - `modelCache`: Map for caching loaded models
-- `backgroundColor`: Background color for board rendering
-- `showBoundingBoxes`: Show bounding boxes for debugging
+- `backgroundColor`: Board texture background color
+- `boardSideColor`: Physical substrate/edge color (defaults to `backgroundColor` when customized)
+- `copperColor`: Exposed copper color in board textures
+- `silkscreenColor`: Silkscreen color in board textures
+- `solderMaskWithCopperColor`: Color of traces and copper covered by solder mask
+- `drillColor`: Drill opening color in board textures
+- `showBoundingBoxes`: Show bounding boxes for debugging (default: `false`)
 - `projectBaseUrl`: Optional base URL used to resolve `node_modules` model assets via `/package_files/download`
 - `authHeaders`: Optional auth headers for model downloads, e.g. `{ Authorization: "Bearer ..." }`
 

package/dist/index.d.ts

@@ -12,6 +12,11 @@ interface ConversionOptions {
     includeModels?: boolean;
     modelCache?: Map<string, STLMesh | OBJMesh>;
     backgroundColor?: string;
+    boardSideColor?: Color;
+    copperColor?: string;
+    silkscreenColor?: string;
+    solderMaskWithCopperColor?: string;
+    drillColor?: string;
     showBoundingBoxes?: boolean;
     coordinateTransform?: CoordinateTransformConfig;
     projectBaseUrl?: string;
@@ -74,6 +79,7 @@ interface Box3D {
     size: Size3;
     rotation?: Point3;
     color?: Color;
+    sideColor?: Color;
     texture?: {
         top?: string;
         bottom?: string;
@@ -121,8 +127,12 @@ interface GLTFExportOptions {
 }
 interface CircuitTo3DOptions {
     pcbColor?: Color;
+    boardSideColor?: Color;
     componentColor?: Color;
     copperColor?: Color;
+    silkscreenColor?: string;
+    solderMaskWithCopperColor?: string;
+    drillColor?: string;
     boardThickness?: number;
     boardDrillQuality?: "high" | "fast";
     drawFauxBoard?: boolean;
@@ -141,16 +151,14 @@ interface BoardRenderOptions {
     backgroundColor?: string;
     copperColor?: string;
     silkscreenColor?: string;
+    solderMaskWithCopperColor?: string;
     padColor?: string;
     drillColor?: string;
     showPcbNotes?: boolean;
 }
 
 declare function renderBoardLayer(circuitJson: CircuitJson, options: BoardRenderOptions): Promise<string>;
-declare function renderBoardTextures(circuitJson: CircuitJson, { resolution, showPcbNotes }: {
-    resolution?: number | undefined;
-    showPcbNotes?: boolean | undefined;
-}): Promise<{
+declare function renderBoardTextures(circuitJson: CircuitJson, { resolution, backgroundColor, copperColor, silkscreenColor, solderMaskWithCopperColor, drillColor, showPcbNotes, }: Omit<BoardRenderOptions, "layer">): Promise<{
     top: string;
     bottom: string;
 }>;

package/dist/index.js

@@ -16530,6 +16530,7 @@ async function renderBoardLayer(circuitJson, options) {
     backgroundColor = "transparent",
     copperColor = "#ffe066",
     silkscreenColor = "#ffffff",
+    solderMaskWithCopperColor = "#69e778ff",
     drillColor = "rgba(0,0,0,0.5)",
     showPcbNotes = false
   } = options;
@@ -16550,8 +16551,8 @@ async function renderBoardLayer(circuitJson, options) {
         bottom: silkscreenColor
       },
       soldermaskWithCopperUnderneath: {
-        top: "#69e778ff",
-        bottom: "#69e778ff"
+        top: solderMaskWithCopperColor,
+        bottom: solderMaskWithCopperColor
       },
       drill: drillColor
     }
@@ -16607,19 +16608,33 @@ async function convertSvgToCanvasBrowser(svgString, resolution, backgroundColor)
     img.src = svgDataUrl;
   });
 }
-async function renderBoardTextures(circuitJson, { resolution = 1024, showPcbNotes = false }) {
+async function renderBoardTextures(circuitJson, {
+  resolution = 1024,
+  backgroundColor = "#0F3812",
+  copperColor,
+  silkscreenColor,
+  solderMaskWithCopperColor,
+  drillColor,
+  showPcbNotes = false
+}) {
   const top = await renderBoardLayer(circuitJson, {
     layer: "top",
     resolution,
-    backgroundColor: "#0F3812",
-    // Green PCB background
+    backgroundColor,
+    copperColor,
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor,
     showPcbNotes
   });
   const bottom = await renderBoardLayer(circuitJson, {
     layer: "bottom",
     resolution,
-    backgroundColor: "#0F3812",
-    // Darker green for bottom layer
+    backgroundColor,
+    copperColor,
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor,
     showPcbNotes
   });
   return { top, bottom };
@@ -16647,8 +16662,12 @@ function convertCadSizeToSceneSize(size) {
 async function convertCircuitJsonTo3D(circuitJson, options = {}) {
   const {
     pcbColor = "rgba(0,140,0,0.8)",
+    boardSideColor,
     componentColor = "rgba(128,128,128,0.5)",
     copperColor = "#C87B4B",
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor,
     boardThickness = DEFAULT_BOARD_THICKNESS,
     boardDrillQuality = "fast",
     drawFauxBoard = false,
@@ -16657,12 +16676,20 @@ async function convertCircuitJsonTo3D(circuitJson, options = {}) {
     textureResolution = 1024,
     showPcbNotes = false,
     coordinateTransform,
-    showBoundingBoxes = true,
+    showBoundingBoxes = false,
     projectBaseUrl,
     authHeaders
   } = options;
   const db = cju(circuitJson);
   const boxes = [];
+  const resolvedBoardSideColor = boardSideColor ?? (options.pcbColor !== void 0 ? pcbColor : void 0);
+  const boardTextureColors = {
+    ...typeof options.pcbColor === "string" ? { backgroundColor: options.pcbColor } : {},
+    ...typeof options.copperColor === "string" ? { copperColor: options.copperColor } : {},
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor
+  };
   const pcbPanel = db.pcb_panel?.list?.()[0];
   const pcbBoard = db.pcb_board?.list?.()[0];
   const pcbComponents = db.pcb_component?.list?.() ?? [];
@@ -16693,13 +16720,15 @@ async function convertCircuitJsonTo3D(circuitJson, options = {}) {
         z: Number.isFinite(meshHeight) ? meshHeight : pcbPanel.height
       },
       mesh: panelMesh,
-      color: pcbColor
+      color: pcbColor,
+      sideColor: resolvedBoardSideColor
     };
     if (shouldRenderTextures && textureResolution > 0) {
       try {
         const textures = await renderBoardTextures(circuitJson, {
           resolution: textureResolution,
-          showPcbNotes
+          showPcbNotes,
+          ...boardTextureColors
         });
         panelBox.texture = {
           top: textures.top,
@@ -16739,13 +16768,15 @@ async function convertCircuitJsonTo3D(circuitJson, options = {}) {
         z: Number.isFinite(meshHeight) ? meshHeight : pcbBoard.height
       },
       mesh: boardMesh,
-      color: pcbColor
+      color: pcbColor,
+      sideColor: resolvedBoardSideColor
     };
     if (shouldRenderTextures && textureResolution > 0) {
       try {
         const textures = await renderBoardTextures(circuitJson, {
           resolution: textureResolution,
-          showPcbNotes
+          showPcbNotes,
+          ...boardTextureColors
         });
         boardBox.texture = {
           top: textures.top,
@@ -16783,7 +16814,8 @@ async function convertCircuitJsonTo3D(circuitJson, options = {}) {
         y: effectiveBoardThickness,
         z: fauxHeight
       },
-      color: pcbColor
+      color: pcbColor,
+      sideColor: resolvedBoardSideColor
     };
     if (shouldRenderTextures && textureResolution > 0) {
       try {
@@ -16803,7 +16835,8 @@ async function convertCircuitJsonTo3D(circuitJson, options = {}) {
         ];
         const textures = await renderBoardTextures(fauxBoardCircuitJson, {
           resolution: textureResolution,
-          showPcbNotes
+          showPcbNotes,
+          ...boardTextureColors
         });
         fauxBoardBox.texture = {
           top: textures.top,
@@ -17880,7 +17913,7 @@ var GLTFBuilder = class {
       });
     }
     if (sideTriangles.length > 0) {
-      const sideMaterialIndex = this.addMaterial({
+      const sideMaterialIndex = box.sideColor ? this.addMaterialFromColor({ color: box.sideColor }) : this.addMaterial({
         name: `GreenSideMaterial_${this.materials.length}`,
         pbrMetallicRoughness: {
           baseColorFactor: [0.04, 0.16, 0.08, 1],
@@ -18037,20 +18070,19 @@ var GLTFBuilder = class {
     } else {
       faceMaterials.bottom = defaultMaterialIndex;
     }
-    const greenMaterialIndex = this.addMaterial({
+    const sideMaterialIndex = box.sideColor ? this.addMaterialFromColor({ color: box.sideColor }) : this.addMaterial({
       name: `GreenSideMaterial_${this.materials.length}`,
       pbrMetallicRoughness: {
         baseColorFactor: [0.04, 0.16, 0.08, 1],
-        // Green color for PCB sides
         metallicFactor: 0,
         roughnessFactor: 0.8
       },
       alphaMode: "OPAQUE"
     });
-    faceMaterials.front = greenMaterialIndex;
-    faceMaterials.back = greenMaterialIndex;
-    faceMaterials.left = greenMaterialIndex;
-    faceMaterials.right = greenMaterialIndex;
+    faceMaterials.front = sideMaterialIndex;
+    faceMaterials.back = sideMaterialIndex;
+    faceMaterials.left = sideMaterialIndex;
+    faceMaterials.right = sideMaterialIndex;
     const meshIndex = this.meshes.length;
     const primitives = [];
     for (const [faceName, faceData] of Object.entries(faceMeshes)) {
@@ -18636,6 +18668,11 @@ async function convertCircuitJsonToGltf(circuitJson, options = {}) {
     includeModels = true,
     modelCache,
     backgroundColor,
+    boardSideColor,
+    copperColor,
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor,
     showBoundingBoxes = false
   } = options;
   const scene3D = await convertCircuitJsonTo3D(circuitJson, {
@@ -18644,6 +18681,12 @@ async function convertCircuitJsonToGltf(circuitJson, options = {}) {
     showPcbNotes,
     boardDrillQuality,
     drawFauxBoard,
+    pcbColor: backgroundColor,
+    boardSideColor,
+    copperColor,
+    silkscreenColor,
+    solderMaskWithCopperColor,
+    drillColor,
     coordinateTransform: options.coordinateTransform,
     showBoundingBoxes,
     projectBaseUrl: options.projectBaseUrl,

package/package.json

@@ -2,7 +2,7 @@
   "name": "circuit-json-to-gltf",
   "main": "dist/index.js",
   "type": "module",
-  "version": "0.0.113",
+  "version": "0.0.115",
   "scripts": {
     "test": "bun test tests/",
     "test:playwright": "playwright test",