PCB设计软件：Altium NEXUS二次开发_（8）.常用API介绍.docx

PAGE1

PAGE1

常用API介绍

在进行AltiumNEXUS二次开发时，了解和掌握常用API（ApplicationProgrammingInterface，应用程序编程接口）是至关重要的。API提供了与软件交互的能力，使得开发者能够编写自定义脚本和插件来扩展软件的功能。本节将详细介绍AltiumNEXUS中常用的API，包括其功能、使用方法以及具体的代码示例。

1.基础API

1.1获取和设置文档

获取当前打开的PCB文档

在AltiumNEXUS中，可以通过API获取当前打开的PCB文档对象。这是进行后续操作的基础。

uses

PCBServer;

functionGetCurrentPCBDocument:IPCB_Board;

var

Board:IPCB_Board;

begin

Board:=Client.GetBoard;//获取当前PCB文档对象

ifBoard=nilthen

begin

ShowMessage(没有打开的PCB文档。);

Exit;

end;

Result:=Board;

end;

设置当前PCB文档

设置当前PCB文档对象，以便进行后续操作。

uses

PCBServer;

procedureSetCurrentPCBDocument(Board:IPCB_Board);

begin

Client.SetBoard(Board);//设置当前PCB文档对象

end;

1.2获取和设置项目

获取当前项目

获取当前项目对象，以便进行项目级别的操作。

uses

Project;

functionGetCurrentProject:IProject;

var

Project:IProject;

begin

Project:=Client.Project;//获取当前项目对象

ifProject=nilthen

begin

ShowMessage(没有打开的项目。);

Exit;

end;

Result:=Project;

end;

设置当前项目

设置当前项目对象，以便进行后续操作。

uses

Project;

procedureSetCurrentProject(Project:IProject);

begin

Client.SetProject(Project);//设置当前项目对象

end;

2.PCB对象API

2.1获取和操作PCB对象

获取PCB对象

获取PCB中的各种对象，如元器件、网络、焊盘等。

uses

PCBServer,PCBObject;

functionGetPCBObject(ObjectType:TPCBObjectClass):IPCB_BoardObject;

var

Board:IPCB_Board;

Iterator:IPCB_BoardIterator;

Object:IPCB_BoardObject;

begin

Board:=GetCurrentPCBDocument;

Iterator:=Board.BoardObjectIterator_Create;//创建迭代器

Iterator.SetState_Hierarchy(ObjectType,eCreateIteratorasc);//设置迭代器状态

Object:=Iterator.NextPCBObject;//获取第一个对象

Board.BoardObjectIterator_Destroy(Iterator);//销毁迭代器

Result:=Object;

end;

添加PCB对象

向PCB中添加新的对象，如元器件、网络等。

uses

PCBServer,PCBObject,PCBComponent;

procedureAddPCBComponent(FileName:string;X,Y:Double);

var

Board:IPCB_Board;

Component:IPCB_Component;

begin

Board:=GetCurrentPCBDocument;

Component:=Client.PCBComponentFactory.CreateComponent(Board,Fil