Kicad 4.0 Plugins

• 语言: 英语
• 格式: .pdf
• 来源: 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 the entire KiCad suite, focusing on the 3D plugin class. The document details the structure of plugin classes, including the base plugin class and the 3D-specific plugin class, and provides tutorials for creating basic 3D plugins. It also covers the application programming interfaces (APIs) for plugin development, including the base plugin class API and the 3D plugin class API, as well as the scenegraph class APIs.

AI总结

# KiCad 4.0 插件系统总结

## 1. 插件系统简介
KiCad 的插件系统是一个用于扩展 KiCad 功能的框架，允许开发者通过共享库形式扩展软件功能。插件开发无需重建整个 KiCad 项目，仅需少量 KiCad 源代码头文件，极大提升了开发效率。插件最初用于支持更多类型的 3D 模型，现已被扩展为通用插件框架。

## 2. 插件类
插件按功能领域划分为不同的类（Class），目前主要实现的是 3D 插件类（PLUGIN_3D）。未来计划开发 PCB 插件类，用于支持数据导入/导出功能。

### 2.1 3D 插件类
3D 插件负责加载和显示 3D 模型数据，主要功能包括：
- 提供文件扩展名支持
- 提供文件过滤器
- 检查是否支持渲染
- 加载模型并返回场景图数据

### 2.2 插件开发基础
插件开发需要实现以下通用接口：
- `GetKicadPluginClass`：返回插件类名称
- `GetClassVersion`：返回插件类版本信息
- `GetNFilters`：返回文件过滤器数量
- `GetFileFilter`：返回指定索引的文件过滤器
- `CanRender`：检查是否支持渲染
- `Load`：加载模型并返回场景图指针

## 3. 开发教程
文档提供了两个简单的 3D 插件开发示例：

### 3.1 示例 1：PLUGIN_3D_DEMO1
- 功能：仅提供文件扩展名和过滤器支持，不渲染模型。
- 开发步骤：
1. 创建项目目录和 CMakeLists.txt。
2. 编写插件源文件。
3. 使用 CMake 编译生成插件。

### 3.2 示例 2：PLUGIN_3D_DEMO2
- 功能：创建简单的场景图，渲染两个四面体。
- 开发步骤：
1. 延续示例 1 的 CMake 配置。
2. 新增场景图功能代码。
3. 编译并测试插件。

## 4. 应用编程接口（API）
- **基类 API**：定义所有插件通用接口。
- **3D 插件 API**：扩展 3D 模型处理功能。
- **场景图 API**：提供 3D 视图数据接口。

## 5. 开发注意事项
- 插件开发需使用 KiCad 的场景图库（kicad_3dsg）。
- 插件通过 `S3D_CACHE` 类在 KiCad 中发现和调用。
- 插件版本兼容性检查通过基类实现。

## 6. 总结
KiCad 插件系统为开发者提供了灵活的扩展机制，目前主要支持 3D 模型插件开发，未来计划扩展至 PCB 插件。开发者可通过文档提供的教程和 API 快速上手插件开发，提升 KiCad 的功能和使用体验。