Kicad 5.1 插件

• 语言: 中文（简体）
• 格式: .pdf
• 来源: docs.kicad.org

摘要

文档详细介绍了KiCad 5.1插件系统的结构和实现，特别是3D插件类的开发。插件通过应用程序编程接口(API)实现其功能，并与 Scene Graph API 交互以支持模型可视化。文档涵盖了插件加载器的工作原理、插件类的实现步骤以及如何构建和安装插件，包括构建基本插件、创建场景图和扩展文件过滤器等内容。

AI总结

以下是对文档内容的中文总结：

---

# 《KiCad 5.1 插件》总结

## 1. 插件系统概述
KiCad 5.1 插件通过应用程序编程接口（API）实现，其插件类需要实现头文件中声明的基本功能。所有插件类都必须包含在头文件 `kicad_plugin.h` 中，并依赖 KiCad 源代码树中的其他 API。

- **3D 插件特性**: 支持模型可视化的插件必须与 `ifsg_all.h` 中声明的 Scene Graph API 交互，用于将模型数据转换为场景图格式。
- **插件加载器**: 插件加载器通过实现 Plugin 加载器类来提供插件服务。插件加载器实例化后，通过调用插件的 API 函数来实现功能。

## 2. 插件类 API
目前 KiCad 声明的插件类主要是 3D 插件类，开发者需在 `kicad_plugin.h` 中实现以下功能：
- 插件类 API：包括获取插件名称、版本信息、插件信息等基本功能。
- 插件加载器 API：通过 Plugin Loader 类实现插件的加载、调用和关闭。

### 2.1 API 功能
- **`GetKicadPluginClass()`**: 返回插件类名称。
- **`GetClassVersion()`**: 返回插件类 API 版本。
- **`GetPluginVersion()`**: 返回插件的版本信息。
- **`GetPluginInfo()`**: 返回插件的信息字符串。

### 2.2 插件加载流程
1. 创建插件加载器实例。
2. 调用 `Open()` 函数加载插件。
3. 调用插件的 API 函数。
4. 调用 `Close()` 函数关闭插件。
5. 销毁插件加载器实例。

## 3. 场景图类 API
场景图库（`kicad_3dsg`）提供了构建场景图的类和函数，用于将模型数据转换为 3D 缓存管理器可视化的中间数据格式。重要功能包括：
- **`New3DModel()`**: 创建并初始化 3D 模型。
- **`Init3DMaterial()`**: 初始化材质结构。
- **`Init3DMesh()`**: 创建并初始化网格结构。
- **`Free3DMesh()`**: 释放网格所占用的内存。

## 4. 插件构建与扩展
1. **构建插件**:
- 确保 KiCad 根目录 (`KICAD_ROOT_DIR`) 已设置。
- 通过 CMake 构建插件项目。
- 插件文件需复制到 KiCad 的插件目录中。

2. **扩展插件**:
- 修改 `CMakeLists.txt` 文件，添加目标库并链接到 KiCad 的场景图库。
- 插件需提供文件扩展名和过滤器列表，以增强 3D 模型文件选择对话框的功能。

---

以上是文档的核心内容总结，涵盖了插件系统的实现、插件类和场景图 API 的功能，以及插件的构建和扩展方法。