altium-to-circuit-json 0.0.13 → 0.0.15

package/dist/index.js

@@ -695,6 +695,11 @@ var CARDINAL_DIRECTIONS = [
 ];
 var SYMBOL_CATALOG = symbols;
 var SYMBOL_NAMES = Object.keys(SYMBOL_CATALOG);
+var INLINE_NET_LABEL_COLOR = "rgb(132, 0, 0)";
+var DEFAULT_INLINE_NET_LABEL_FONT_SIZE = 0.18;
+var MIN_INLINE_NET_LABEL_FONT_SIZE = 0.1;
+var INLINE_NET_LABEL_CHARACTER_WIDTH = 0.12;
+var INLINE_NET_LABEL_HORIZONTAL_PADDING = 0.12;
 function convertSemanticSchematic(document, options) {
   const handledRecords = /* @__PURE__ */ new Set();
   const elements = [];
@@ -742,6 +747,12 @@ function convertComponents(params) {
       (record) => record.recordKind === "2" && (!isPinHidden(record) || options.includeHidden === true)
     );
     if (pins.length === 0) continue;
+    const visibleSymbolLabels = new Set(
+      visibleOwnedRecords.filter((record) => record.recordKind === "4").flatMap((record) => {
+        const text = record.getDecoded("TEXT")?.trim().toUpperCase();
+        return text ? [text] : [];
+      })
+    );
     const designator = findOwnedText(ownedRecords, "34", "Designator") ?? componentRecord.getDecoded("DESIGNATOR") ?? `U${componentIndex}`;
     const value = findOwnedText(ownedRecords, "41", "Comment") ?? componentRecord.getDecoded("COMMENT") ?? componentRecord.getDecoded("DESIGNITEMID") ?? componentRecord.getDecoded("LIBREFERENCE") ?? "";
     const libraryReference = componentRecord.getDecoded("LIBREFERENCE") ?? componentRecord.getDecoded("DESIGNITEMID") ?? designator;
@@ -774,7 +785,8 @@ function convertComponents(params) {
         pin,
         pinIndex,
         schematicComponentId,
-        sourceComponentId
+        sourceComponentId,
+        visibleSymbolLabels
       })
     );
     const bodyBounds = getComponentBodyBounds(
@@ -863,7 +875,8 @@ function convertComponentPin(params) {
     pin,
     pinIndex,
     schematicComponentId,
-    sourceComponentId
+    sourceComponentId,
+    visibleSymbolLabels
   } = params;
   const recordIndex = document.records.indexOf(pin);
   const pinConglomerate = pin.getNumber("PINCONGLOMERATE");
@@ -894,10 +907,13 @@ function convertComponentPin(params) {
     ...pinNumber === void 0 ? {} : { pin_number: pinNumber }
   };
   const electricalType = pin.getNumber("ELECTRICAL");
+  const normalizedName = name.trim().toUpperCase();
+  const functionalName = normalizedName.replace(/\d+$/u, "");
+  const showName = pinConglomerate === void 0 || (pinConglomerate & 8) !== 0 || visibleSymbolLabels.has(normalizedName) || visibleSymbolLabels.has(functionalName);
   const schematicPort = {
     type: "schematic_port",
     center: scalePoint(terminalPoint, options.scale),
-    display_pin_label: name,
+    ...showName && name ? { display_pin_label: name } : {},
     distance_from_component_edge: pinLength * options.scale,
     facing_direction: direction,
     is_connected: false,
@@ -1030,7 +1046,7 @@ function buildSemanticNetGraph(document, convertedPorts) {
     if (!["4", "17", "18", "25", "29"].includes(record.recordKind ?? "")) {
       return [];
     }
-    const point = getLocation(record);
+    const point = record.recordKind === "18" ? getPortConnectionGeometry(record, segments)?.anchor : getLocation(record);
     return point ? [{ point, record }] : [];
   });
   const positionedPins = convertedPorts.map(({ point, record }) => ({
@@ -1201,6 +1217,8 @@ function convertConnectivity(params) {
   } = params;
   const sourceNetIdByName = /* @__PURE__ */ new Map();
   const sourceNetIdByRecord = /* @__PURE__ */ new Map();
+  const sourcePortCountByRecord = /* @__PURE__ */ new Map();
+  const sourceTraceIdByRecord = /* @__PURE__ */ new Map();
   const schematicTraceIdByRecord = /* @__PURE__ */ new Map();
   const portsByPoint = groupByPoint(convertedPorts);
   for (const [netIndex, net] of graph.nets.entries()) {
@@ -1226,6 +1244,10 @@ function convertConnectivity(params) {
       if (firstSourceNetId) sourceNetIdByRecord.set(record, firstSourceNetId);
     }
     const sourceTraceId = `source_trace_altium_${netIndex}`;
+    for (const record of net.records) {
+      sourcePortCountByRecord.set(record, connectedPorts.length);
+      sourceTraceIdByRecord.set(record, sourceTraceId);
+    }
     const sourceTrace = {
       type: "source_trace",
       connected_source_net_ids: sourceNetIds,
@@ -1324,19 +1346,22 @@ function convertConnectivity(params) {
   return {
     schematicTraceIdByRecord,
     sourceNetIdByName,
-    sourceNetIdByRecord
+    sourceNetIdByRecord,
+    sourcePortCountByRecord,
+    sourceTraceIdByRecord
   };
 }
 function getEquivalentPortPrunedSegmentKeys(params) {
   const { convertedPorts, net, wires } = params;
   const hiddenPortPoints = convertedPorts.filter((port) => !port.isSchematicVisible).map((port) => port.point);
   if (hiddenPortPoints.length === 0) return /* @__PURE__ */ new Set();
+  const wireSegments = getWireSegments(wires);
   const protectedPointKeys = new Set(
     convertedPorts.filter((port) => port.isSchematicVisible).map((port) => pointKey(port.point))
   );
   for (const record of net.records) {
     if (!["4", "17", "18", "25"].includes(record.recordKind ?? "")) continue;
-    const location = getLocation(record);
+    const location = record.recordKind === "18" ? getPortConnectionGeometry(record, wireSegments)?.anchor : getLocation(record);
     if (location) protectedPointKeys.add(pointKey(location));
   }
   const segments = /* @__PURE__ */ new Map();
@@ -1421,6 +1446,9 @@ function convertNetLabels(params) {
     options,
     semanticNetGraph: graph
   } = params;
+  const allWireSegments = getWireSegments(
+    document.records.filter((record) => record.recordKind === "27")
+  );
   for (const [recordIndex, record] of document.records.entries()) {
     const recordKind = record.recordKind;
     if (!recordKind || !["4", "17", "18", "25"].includes(recordKind)) {
@@ -1431,10 +1459,30 @@ function convertNetLabels(params) {
       continue;
     }
     const name = record.recordKind === "18" ? record.getDecoded("NAME") : record.getDecoded("TEXT");
-    const location = getLocation(record);
+    const portConnection = recordKind === "18" ? getPortConnectionGeometry(record, allWireSegments) : void 0;
+    const location = portConnection?.anchor ?? getLocation(record);
     if (!name || !location) continue;
-    const wire = graph.getConnectedWiresForRecord(record)[0];
+    const connectedWires = graph.getConnectedWiresForRecord(record);
+    const wire = connectedWires[0];
     if (recordKind === "4" && !wire) continue;
+    const sourceTraceId = connectivity.sourceTraceIdByRecord.get(record);
+    const shouldRenderInline = Boolean(sourceTraceId) && (recordKind === "25" || recordKind === "18" && (record.getNumber("IOTYPE") ?? 0) === 0 && connectivity.sourcePortCountByRecord.get(record) === 2 && !isPowerNet(name));
+    if (shouldRenderInline && sourceTraceId) {
+      handledRecords.add(record);
+      elements.push(
+        createInlineNetLabelText({
+          connectedWires,
+          document,
+          location,
+          name,
+          options,
+          record,
+          recordIndex,
+          sourceTraceId
+        })
+      );
+      continue;
+    }
     handledRecords.add(record);
     const sourceNetId = connectivity.sourceNetIdByRecord.get(record) ?? getOrCreateSourceNet({
       elements,
@@ -1447,7 +1495,9 @@ function convertNetLabels(params) {
     const schematicNetLabel = {
       type: "schematic_net_label",
       anchor_position: scalePoint(location, options.scale),
-      anchor_side: record.recordKind === "18" || record.recordKind === "4" ? "left" : directionToOppositeSide(direction),
+      anchor_side: directionToOppositeSide(
+        portConnection?.bodyDirection ?? direction
+      ),
       center: scalePoint(location, options.scale),
       schematic_net_label_id: `schematic_net_label_altium_${recordIndex}`,
       schematic_sheet_id: options.schematicSheetId,
@@ -1459,6 +1509,125 @@ function convertNetLabels(params) {
     elements.push(schematicNetLabel);
   }
 }
+function createInlineNetLabelText(params) {
+  const {
+    connectedWires,
+    document,
+    location,
+    name,
+    options,
+    record,
+    recordIndex,
+    sourceTraceId
+  } = params;
+  const direction = getInlineNetLabelDirection(record, location, connectedWires);
+  const scaledLocation = scalePoint(location, options.scale);
+  const fontSize = getInlineNetLabelFontSize(record, document, options.scale);
+  const fontScale = fontSize / DEFAULT_INLINE_NET_LABEL_FONT_SIZE;
+  const textWidth = (name.length * INLINE_NET_LABEL_CHARACTER_WIDTH + INLINE_NET_LABEL_HORIZONTAL_PADDING) * fontScale;
+  const isVertical = direction === "up" || direction === "down";
+  const directionSign = direction === "left" || direction === "down" ? -1 : 1;
+  const isTerminalPort = record.recordKind === "18";
+  const anchor = isTerminalPort ? directionSign > 0 ? "left" : "right" : "center";
+  const position = isTerminalPort ? isVertical ? {
+    x: scaledLocation.x - fontSize / 2,
+    y: scaledLocation.y
+  } : {
+    x: scaledLocation.x,
+    y: scaledLocation.y + fontSize / 2
+  } : isVertical ? {
+    x: scaledLocation.x - fontSize / 2,
+    y: scaledLocation.y + directionSign * textWidth / 2
+  } : {
+    x: scaledLocation.x + directionSign * textWidth / 2,
+    y: scaledLocation.y + fontSize / 2
+  };
+  return {
+    type: "schematic_text",
+    anchor,
+    color: INLINE_NET_LABEL_COLOR,
+    font_size: fontSize,
+    position,
+    rotation: isVertical ? -90 : 0,
+    schematic_sheet_id: options.schematicSheetId,
+    schematic_text_id: `schematic_inline_net_label_altium_${recordIndex}`,
+    source_trace_id: sourceTraceId,
+    text: name
+  };
+}
+function getInlineNetLabelFontSize(record, document, scale) {
+  const fontId = Math.max(
+    Math.round(Number(record.getCaseInsensitive("FONTID") ?? 1)),
+    1
+  );
+  const sheetRecord = document.records.find(
+    (candidate) => candidate.recordKind === "31"
+  );
+  const sourceFontSize = Number(
+    sheetRecord?.getCaseInsensitive(`SIZE${fontId}`) ?? DEFAULT_INLINE_NET_LABEL_FONT_SIZE / scale
+  );
+  return Math.min(
+    DEFAULT_INLINE_NET_LABEL_FONT_SIZE,
+    Math.max(MIN_INLINE_NET_LABEL_FONT_SIZE, sourceFontSize * scale)
+  );
+}
+function getInlineNetLabelDirection(record, location, connectedWires) {
+  if (record.recordKind !== "18") return getRecordDirection(record);
+  for (const wire of connectedWires) {
+    const points = getSchematicRecordPoints(wire);
+    for (let pointIndex = 1; pointIndex < points.length; pointIndex++) {
+      const start = points[pointIndex - 1];
+      const end = points[pointIndex];
+      if (!start || !end || !isPointOnSegment(location, start, end)) continue;
+      const other = pointsEqual(location, start) ? end : pointsEqual(location, end) ? start : void 0;
+      if (!other) continue;
+      const dx = location.x - other.x;
+      const dy = location.y - other.y;
+      if (Math.abs(dx) >= Math.abs(dy)) return dx < 0 ? "left" : "right";
+      return dy < 0 ? "down" : "up";
+    }
+  }
+  return getRecordDirection(record);
+}
+function getWireSegments(wires) {
+  return wires.flatMap((wire) => {
+    const points = getSchematicRecordPoints(wire);
+    const segments = [];
+    for (let pointIndex = 1; pointIndex < points.length; pointIndex++) {
+      const start = points[pointIndex - 1];
+      const end = points[pointIndex];
+      if (start && end) segments.push({ end, start });
+    }
+    return segments;
+  });
+}
+function getPortConnectionGeometry(record, wireSegments) {
+  const origin = getLocation(record);
+  if (!origin) return void 0;
+  const originToExtremity = getRecordDirection(record);
+  const directionVector = VECTOR_BY_DIRECTION[originToExtremity];
+  const width = Math.max(record.getNumber("WIDTH") ?? 16, 0);
+  const extremity = {
+    x: origin.x + directionVector.x * width,
+    y: origin.y + directionVector.y * width
+  };
+  const touchesWire = (point) => wireSegments.some(
+    (segment) => isPointOnSegment(point, segment.start, segment.end)
+  );
+  const originConnected = touchesWire(origin);
+  const extremityConnected = touchesWire(extremity);
+  const connectedEnd = record.getNumber("CONNECTEDEND");
+  const connectsAtExtremity = connectedEnd === 2 || connectedEnd !== 1 && connectedEnd !== 3 && !originConnected && extremityConnected;
+  return connectsAtExtremity ? {
+    anchor: extremity,
+    bodyDirection: getOppositeDirection(originToExtremity)
+  } : { anchor: origin, bodyDirection: originToExtremity };
+}
+function getOppositeDirection(direction) {
+  if (direction === "up") return "down";
+  if (direction === "down") return "up";
+  return direction === "left" ? "right" : "left";
+}
 function getOrCreateSourceNet(params) {
   const { elements, name, sourceNetIdByName } = params;
   const normalizedName = name.trim().toUpperCase();