Kicad 5.1 Plugins

• 语言: 英语
• 格式: .epub
• 来源: docs.kicad.org

摘要

The document introduces the KiCad plugin system, a framework for extending KiCad's capabilities using shared libraries. It explains how plugins can be developed without rebuilding KiCad, focusing on the 3D model viewer and PCB plugin development. The document details the plugin classes, their APIs, and provides tutorials for creating basic and advanced 3D plugins. It covers the necessary steps to build and integrate plugins, including version compatibility checks and API implementations.

AI总结

### 文档总结：KiCad 5.1 插件系统

#### 1. 插件系统概述
KiCad 的插件系统是一个用于扩展软件功能的框架，通过共享库实现功能扩展。插件开发无需重新编译 KiCad，仅需少量 KiCad 源代码头文件，从而提高开发效率。插件最初用于支持更多类型的 3D 模型，现已扩展为通用插件框架，未来计划支持 PCB 数据导入/导出插件。

#### 2. 插件分类
插件按功能领域分为不同的插件类（Plugin Classes），例如：
- **3D 插件类**：用于加载和显示 3D 模型数据。
- **PCB 插件类**（未来计划）：用于实现 PCB 数据的导入和导出。

目前仅实现了 3D 插件类，文档重点介绍该类插件的开发。

#### 3. 插件开发基础
- **插件加载器**：KiCad 源码树中的 `plugins/ldr/pluginldr.h` 声明了所有插件的基础类，用于管理插件的加载和调用。
- **API 接口**：插件通过特定的 API 实现功能。3D 插件需使用 KiCad 的场景图 API（`ifsg_all.h`）来处理模型数据。
- **基类插件 API**：所有 KiCad 插件必须实现一组基础函数，包括插件类标识、版本信息和兼容性检查等。

#### 4. 开发流程
- **基本 3D 插件**：通过提供文件扩展名和过滤器，增强 KiCad 的文件选择对话框功能。
- **高级 3D 插件**：创建可被 KiCad 预览器渲染的场景图，展示 3D 模型。

#### 5. 示例教程
- **PLUGIN_3D_DEMO1**：演示最简单的 3D 插件开发，仅提供文件扩展名和过滤器。
- **PLUGIN_3D_DEMO2**：演示创建场景图并渲染 3D 模型，展示更复杂的插件功能。

#### 6. 其他信息
- **版本控制**：插件需提供版本信息，确保与 KiCad 的兼容性。
- **依赖管理**：插件开发需链接 KiCad 的场景图库（`kicad_3dsg`）。
- **构建工具**：使用 CMake 管理构建过程，自动检测 KiCad 头文件和库。

#### 7. 版权与贡献
文档由 KiCad 团队编写，采用 GNU GPL 或 Creative Commons 许可证，允许自由分发和修改。贡献者可通过指定链接提交反馈和问题。

### 总结
KiCad 插件系统为用户提供了灵活的功能扩展能力，支持 3D 模型和未来 PCB 数据的导入/导出。插件开发通过特定的 API 和加载器实现，文档提供了详细的开发流程和示例教程，帮助开发者快速上手。