@windypro-rourou/dsh-eda 0.1.0 → 0.1.1

package/skill/references/classes/PCB_PrimitivePad.md

@@ -0,0 +1,944 @@
+# PCB\_PrimitivePad class
+
+PCB & footprint / pad primitive class
+
+## Signature
+
+```typescript
+class PCB_PrimitivePad implements IPCB_PrimitiveAPI
+```
+**Implements:** [IPCB\_PrimitiveAPI](../interfaces/IPCB_PrimitiveAPI.md)
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+</th><th>
+
+Modifiers
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[create(layer, padNumber, x, y, rotation, pad, net, hole, holeOffsetX, holeOffsetY, holeRotation, metallization, padType, specialPad, solderMaskAndPasteMaskExpansion, heatWelding, primitiveLock)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+Create Pad
+
+</td></tr>
+<tr><td>
+
+[delete(primitiveIds)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Delete Pad
+
+</td></tr>
+<tr><td>
+
+[get(primitiveIds)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get Pad
+
+</td></tr>
+<tr><td>
+
+[get(primitiveIds)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get Pad
+
+</td></tr>
+<tr><td>
+
+[getAll(layer, net, primitiveLock, padType)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get all Pad
+
+</td></tr>
+<tr><td>
+
+[getAllPrimitiveId(layer, net, primitiveLock, padType)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Get all Pad primitive IDs
+
+</td></tr>
+<tr><td>
+
+[modify(primitiveId, property)](./PCB_PrimitivePad.md)
+
+</td><td>
+
+</td><td>
+
+**_(BETA)_** Modify Pad
+
+</td></tr>
+</tbody></table>
+
+---
+
+## 方法详情
+
+### create
+
+# PCB\_PrimitivePad.create() method
+
+Create Pad
+
+## Signature
+
+```typescript
+function create(
+	layer: TPCB_LayersOfPad,
+	padNumber: string,
+	x: number,
+	y: number,
+	rotation?: number,
+	pad?: TPCB_PrimitivePadShape,
+	net?: string,
+	hole?: TPCB_PrimitivePadHole | null,
+	holeOffsetX?: number,
+	holeOffsetY?: number,
+	holeRotation?: number,
+	metallization?: boolean,
+	padType?: EPCB_PrimitivePadType,
+	specialPad?: TPCB_PrimitiveSpecialPadShape,
+	solderMaskAndPasteMaskExpansion?: IPCB_PrimitiveSolderMaskAndPasteMaskExpansion | null,
+	heatWelding?: IPCB_PrimitivePadHeatWelding | null,
+	primitiveLock?: boolean,
+): Promise<IPCB_PrimitivePad | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+layer
+
+</td><td>
+
+[TPCB\_LayersOfPad](../types/TPCB_LayersOfPad.md)
+
+</td><td>
+
+Layer
+
+</td></tr>
+<tr><td>
+
+padNumber
+
+</td><td>
+
+string
+
+</td><td>
+
+Pad number
+
+</td></tr>
+<tr><td>
+
+x
+
+</td><td>
+
+number
+
+</td><td>
+
+X position
+
+</td></tr>
+<tr><td>
+
+y
+
+</td><td>
+
+number
+
+</td><td>
+
+Y position
+
+</td></tr>
+<tr><td>
+
+rotation
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Rotation angle
+
+</td></tr>
+<tr><td>
+
+pad
+
+</td><td>
+
+[TPCB\_PrimitivePadShape](../types/TPCB_PrimitivePadShape.md)
+
+</td><td>
+
+_(Optional)_ Pad shape. This parameter is required before the special pad shape is implemented
+
+</td></tr>
+<tr><td>
+
+net
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Net name
+
+</td></tr>
+<tr><td>
+
+hole
+
+</td><td>
+
+[TPCB\_PrimitivePadHole](../types/TPCB_PrimitivePadHole.md) \| null
+
+</td><td>
+
+_(Optional)_ Hole. `null` indicates no hole
+
+</td></tr>
+<tr><td>
+
+holeOffsetX
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Hole offset X
+
+</td></tr>
+<tr><td>
+
+holeOffsetY
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Hole offset Y
+
+</td></tr>
+<tr><td>
+
+holeRotation
+
+</td><td>
+
+number
+
+</td><td>
+
+_(Optional)_ Rotation angle of the hole relative to the pad
+
+</td></tr>
+<tr><td>
+
+metallization
+
+</td><td>
+
+boolean
+
+</td><td>
+
+_(Optional)_ Whether the hole wall is plated
+
+</td></tr>
+<tr><td>
+
+padType
+
+</td><td>
+
+[EPCB\_PrimitivePadType](../enums/EPCB_PrimitivePadType.md)
+
+</td><td>
+
+_(Optional)_ Pad type
+
+</td></tr>
+<tr><td>
+
+specialPad
+
+</td><td>
+
+[TPCB\_PrimitiveSpecialPadShape](../types/TPCB_PrimitiveSpecialPadShape.md)
+
+</td><td>
+
+_(Optional)_ Special pad shape. Currently not implemented; please do not use it
+
+</td></tr>
+<tr><td>
+
+solderMaskAndPasteMaskExpansion
+
+</td><td>
+
+[IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion](../interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md) \| null
+
+</td><td>
+
+_(Optional)_ Solder mask/paste mask expansion. `null` means following the rules
+
+</td></tr>
+<tr><td>
+
+heatWelding
+
+</td><td>
+
+[IPCB\_PrimitivePadHeatWelding](../interfaces/IPCB_PrimitivePadHeatWelding.md) \| null
+
+</td><td>
+
+_(Optional)_ Thermal relief optimization parameters
+
+</td></tr>
+<tr><td>
+
+primitiveLock
+
+</td><td>
+
+boolean
+
+</td><td>
+
+_(Optional)_ Whether it is locked
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md) \| undefined&gt;
+
+Pad primitive object
+
+## Example
+
+```javascript
+// 1. 生成随机坐标，避免与画布上已有的焊盘重合
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+
+// 2. 在顶层（1）创建一个 60x60 圆形贴片焊盘：外形用 ['ELLIPSE', 宽, 高]，无孔传 null
+const smd = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+
+// 3. 在多层（12）创建一个 80x80 通孔焊盘：圆孔直径 35mil，金属化孔壁（沉铜）
+const thru = await eda.pcb_PrimitivePad.create(12, '2', x, y + 500, 0, ['ELLIPSE', 80, 80], '', ['ROUND', 35], 0, 0, 0, true, 0);
+
+// 4. 创建类保留现场，不删除图元
+console.log('smd padId:', smd.getState_PrimitiveId());
+console.log('smd layer:', smd.getState_Layer());
+console.log('thru padId:', thru.getState_PrimitiveId());
+console.log('thru layer:', thru.getState_Layer());
+```
+
+### delete
+
+# PCB\_PrimitivePad.delete() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Delete Pad
+
+## Signature
+
+```typescript
+function delete(primitiveIds: string | IPCB_PrimitivePad | Array<string> | Array<IPCB_PrimitivePad>): Promise<boolean>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+primitiveIds
+
+</td><td>
+
+string \| [IPCB\_PrimitivePad](./IPCB_PrimitivePad.md) \| Array&lt;string&gt; \| Array&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md)<!-- -->&gt;
+
+</td><td>
+
+Pad primitive ID or Pad primitive object
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;boolean&gt;
+
+Delete Whether the operation is successful
+
+## Example
+
+```javascript
+// 1. 创建两个待删除的测试焊盘（随机坐标避免重合）
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+const pad1 = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+const pad2 = await eda.pcb_PrimitivePad.create(1, '2', x, y + 500, 0, ['OVAL', 80, 50], '', null, 0, 0, 0, false, 0);
+
+// 2. 记录删除前的焊盘数量
+const beforeCount = (await eda.pcb_PrimitivePad.getAll()).length;
+
+// 3. 以 ID 数组形式批量删除两个焊盘
+const deleted = await eda.pcb_PrimitivePad.delete([pad1.getState_PrimitiveId(), pad2.getState_PrimitiveId()]);
+
+// 4. 删除类保留现场（图元已删除，不恢复）
+const afterCount = (await eda.pcb_PrimitivePad.getAll()).length;
+
+console.log('deleted:', deleted);
+console.log('beforeCount:', beforeCount, '→ afterCount:', afterCount);
+```
+
+### get
+
+# PCB\_PrimitivePad.get() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get Pad
+
+## Signature
+
+```typescript
+function get(primitiveIds: string): Promise<IPCB_PrimitivePad | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+primitiveIds
+
+</td><td>
+
+string
+
+</td><td>
+
+Pad primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md) \| undefined&gt;
+
+Pad primitive object, `undefined` indicates that the retrieval failed
+
+## Example
+
+```javascript
+// 1. 创建两个测试焊盘（随机坐标避免重合）
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+const pad1 = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+const pad2 = await eda.pcb_PrimitivePad.create(1, '2', x, y + 500, 0, ['RECT', 80, 40, 0], '', null, 0, 0, 0, false, 0);
+
+// 2. 传单个 ID 字符串，返回单个焊盘对象
+const single = await eda.pcb_PrimitivePad.get(pad1.getState_PrimitiveId());
+
+// 3. 传 ID 数组，返回焊盘对象数组（任一 ID 未匹配不影响其它项返回）
+const arr = await eda.pcb_PrimitivePad.get([pad1.getState_PrimitiveId(), pad2.getState_PrimitiveId()]);
+
+// 4. 清理测试图元（查询类需要清理）
+await eda.pcb_PrimitivePad.delete([pad1.getState_PrimitiveId(), pad2.getState_PrimitiveId()]);
+
+console.log('single padNumber:', single.getState_PadNumber());
+console.log('array length:', arr.length);
+console.log('pad2 layer:', arr[1].getState_Layer());
+```
+
+### get_1
+
+# PCB\_PrimitivePad.get() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get Pad
+
+## Signature
+
+```typescript
+function get(primitiveIds: Array<string>): Promise<Array<IPCB_PrimitivePad>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+primitiveIds
+
+</td><td>
+
+Array&lt;string&gt;
+
+</td><td>
+
+Pad primitive ID, which can be a string or an array of strings. If it is an array, an array is also returned
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md)<!-- -->&gt;&gt;
+
+Pad primitive object; an empty array indicates that the retrieval failed
+
+## Remarks
+
+If multiple primitive IDs are passed in, a primitive ID that is not matched will not affect the return of other primitives; that is, fewer primitive objects than the number of primitive IDs passed in may be returned.
+
+### getall
+
+# PCB\_PrimitivePad.getAll() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get all Pad
+
+## Signature
+
+```typescript
+function getAll(
+	layer?: TPCB_LayersOfPad,
+	net?: string,
+	primitiveLock?: boolean,
+	padType?: EPCB_PrimitivePadType,
+): Promise<Array<IPCB_PrimitivePad>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+layer
+
+</td><td>
+
+[TPCB\_LayersOfPad](../types/TPCB_LayersOfPad.md)
+
+</td><td>
+
+_(Optional)_ Layer
+
+</td></tr>
+<tr><td>
+
+net
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Net name
+
+</td></tr>
+<tr><td>
+
+primitiveLock
+
+</td><td>
+
+boolean
+
+</td><td>
+
+_(Optional)_ Whether it is locked
+
+</td></tr>
+<tr><td>
+
+padType
+
+</td><td>
+
+[EPCB\_PrimitivePadType](../enums/EPCB_PrimitivePadType.md)
+
+</td><td>
+
+_(Optional)_
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md)<!-- -->&gt;&gt;
+
+Array of Pad primitive objects
+
+## Example
+
+```javascript
+// 1. 创建一个顶层测试焊盘作为过滤目标（随机坐标避免重合）
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+const pad = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+const padId = pad.getState_PrimitiveId();
+
+// 2. 不带参数：获取 PCB 上全部焊盘
+const all = await eda.pcb_PrimitivePad.getAll();
+
+// 3. 按层过滤：只取顶层（1）的焊盘
+const topLayer = await eda.pcb_PrimitivePad.getAll(1);
+
+// 4. 清理测试图元（查询类需要清理）
+await eda.pcb_PrimitivePad.delete([padId]);
+
+console.log('total pads:', all.length);
+console.log('top layer pads:', topLayer.length);
+console.log('marker pad found in top layer:', topLayer.some(p => p.getState_PrimitiveId() === padId));
+```
+
+### getallprimitiveid
+
+# PCB\_PrimitivePad.getAllPrimitiveId() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Get all Pad primitive IDs
+
+## Signature
+
+```typescript
+function getAllPrimitiveId(
+	layer?: TPCB_LayersOfPad,
+	net?: string,
+	primitiveLock?: boolean,
+	padType?: EPCB_PrimitivePadType,
+): Promise<Array<string>>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+layer
+
+</td><td>
+
+[TPCB\_LayersOfPad](../types/TPCB_LayersOfPad.md)
+
+</td><td>
+
+_(Optional)_ Layer
+
+</td></tr>
+<tr><td>
+
+net
+
+</td><td>
+
+string
+
+</td><td>
+
+_(Optional)_ Net name
+
+</td></tr>
+<tr><td>
+
+primitiveLock
+
+</td><td>
+
+boolean
+
+</td><td>
+
+_(Optional)_ Whether it is locked
+
+</td></tr>
+<tr><td>
+
+padType
+
+</td><td>
+
+[EPCB\_PrimitivePadType](../enums/EPCB_PrimitivePadType.md)
+
+</td><td>
+
+_(Optional)_
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;Array&lt;string&gt;&gt;
+
+Array of Pad primitive IDs
+
+## Example
+
+```javascript
+// 1. 创建一个顶层测试焊盘作为查找目标（随机坐标避免重合）
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+const pad = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+const padId = pad.getState_PrimitiveId();
+
+// 2. 获取全部焊盘的图元 ID
+const allIds = await eda.pcb_PrimitivePad.getAllPrimitiveId();
+
+// 3. 按层过滤：只取顶层（1）焊盘的图元 ID
+const topLayerIds = await eda.pcb_PrimitivePad.getAllPrimitiveId(1);
+
+// 4. 清理测试图元（查询类需要清理）
+await eda.pcb_PrimitivePad.delete([padId]);
+
+console.log('total pad ids:', allIds.length);
+console.log('top layer pad ids:', topLayerIds.length);
+console.log('marker id in top layer list:', topLayerIds.includes(padId));
+```
+
+### modify
+
+# PCB\_PrimitivePad.modify() method
+
+> This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
+
+Modify Pad
+
+## Signature
+
+```typescript
+function modify(
+	primitiveId: string | IPCB_PrimitivePad,
+	property: {
+		layer?: undefined | EPCB_LayerId.TOP | EPCB_LayerId.BOTTOM | EPCB_LayerId.MULTI;
+		padNumber?: undefined | string;
+		x?: undefined | number;
+		y?: undefined | number;
+		rotation?: undefined | number;
+		pad?: undefined | any | any | any;
+		net?: undefined | string;
+		hole?: undefined | null | any | any;
+		holeOffsetX?: undefined | number;
+		holeOffsetY?: undefined | number;
+		holeRotation?: undefined | number;
+		metallization?: undefined | false | true;
+		specialPad?: undefined | TPCB_PrimitiveSpecialPadShape;
+		solderMaskAndPasteMaskExpansion?:
+			undefined | null | IPCB_PrimitiveSolderMaskAndPasteMaskExpansion;
+		heatWelding?: undefined | null | IPCB_PrimitivePadHeatWelding;
+		primitiveLock?: undefined | false | true;
+	},
+): Promise<IPCB_PrimitivePad | undefined>;
+```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+</th><th>
+
+Type
+
+</th><th>
+
+Description
+
+</th></tr></thead>
+<tbody><tr><td>
+
+primitiveId
+
+</td><td>
+
+string \| [IPCB\_PrimitivePad](./IPCB_PrimitivePad.md)
+
+</td><td>
+
+Primitive ID
+
+</td></tr>
+<tr><td>
+
+property
+
+</td><td>
+
+{ layer?: undefined \| [EPCB\_LayerId.TOP](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.BOTTOM](../enums/EPCB_LayerId.md) \| [EPCB\_LayerId.MULTI](../enums/EPCB_LayerId.md)<!-- -->; padNumber?: undefined \| string; x?: undefined \| number; y?: undefined \| number; rotation?: undefined \| number; pad?: undefined \| any \| any \| any; net?: undefined \| string; hole?: undefined \| null \| any \| any; holeOffsetX?: undefined \| number; holeOffsetY?: undefined \| number; holeRotation?: undefined \| number; metallization?: undefined \| false \| true; specialPad?: undefined \| [TPCB\_PrimitiveSpecialPadShape](../types/TPCB_PrimitiveSpecialPadShape.md)<!-- -->; solderMaskAndPasteMaskExpansion?: undefined \| null \| [IPCB\_PrimitiveSolderMaskAndPasteMaskExpansion](../interfaces/IPCB_PrimitiveSolderMaskAndPasteMaskExpansion.md)<!-- -->; heatWelding?: undefined \| null \| [IPCB\_PrimitivePadHeatWelding](../interfaces/IPCB_PrimitivePadHeatWelding.md)<!-- -->; primitiveLock?: undefined \| false \| true }
+
+</td><td>
+
+Modify Parameter
+
+</td></tr>
+</tbody></table>
+
+## Returns
+
+Promise&lt;[IPCB\_PrimitivePad](./IPCB_PrimitivePad.md) \| undefined&gt;
+
+Pad primitive object
+
+## Example
+
+```javascript
+// 1. 创建待修改的测试焊盘（随机坐标避免与画布已有焊盘重合）
+const x = 2000 + Math.floor(Math.random() * 100000);
+const y = 2000 + Math.floor(Math.random() * 100000);
+const pad = await eda.pcb_PrimitivePad.create(1, '1', x, y, 0, ['ELLIPSE', 60, 60], '', null, 0, 0, 0, false, 0);
+const padId = pad.getState_PrimitiveId();
+
+// 2. 读取修改前的编号与旋转
+const beforeNumber = pad.getState_PadNumber();
+const beforeRotation = pad.getState_Rotation();
+
+// 3. 批量修改：编号 '1' → 'A1'，旋转 0 → 45 度
+await eda.pcb_PrimitivePad.modify(padId, { padNumber: 'A1', rotation: 45 });
+
+// 4. modify 返回后需要重新 get() 才能读到画布上的最新值
+const refreshed = await eda.pcb_PrimitivePad.get(padId);
+
+// 5. 修改类保留现场，供观察修改结果
+console.log('primitiveId:', padId);
+console.log('padNumber:', beforeNumber, '→', refreshed.getState_PadNumber());
+console.log('rotation:', beforeRotation, '→', refreshed.getState_Rotation());
+```