Kicad 5.1 Plugins

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

摘要

文档详细介绍了KiCad 5.1插件系统的实现和使用方法，特别是3D插件的开发流程和接口规范。文档首先展示了KICAD_PLUGIN_LDR_3D类的使用步骤，包括插件的加载、调用和关闭过程。接着，详细阐述了Scenegraph Class API的定义及其与VRML2.0静态场景图的兼容性，包括相关的头文件和功能接口。文档还提供了一个基本的3D插件样例，说明了插件的最小实现要求，包括版本信息的管理、文件扩展和过滤器的定义。最后，文档介绍了构建插件所需的开发环境和CMake配置方法。

AI总结

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

---

# 《KiCad 5.1 Plugins》文档总结

## 1. 插件版本信息与插件信息
- 插件版本信息可以通过 `GetVersion` 函数获取，返回主版本号、次版本号、补丁版本号和修订号。
- 插件信息通过 `GetPluginInfo` 函数获取，返回格式为 `[NAME]:[MAJOR].[MINOR].[PATCH].[REVISION]`，包含插件名称和版本信息。

## 2. 插件加载与使用流程
1. 创建 `KICAD_PLUGIN_LDR_3D` 实例。
2. 调用 `Open("/path/to/myplugin.so")` 加载插件，并检查返回值确认加载成功。
3. 调用 `KICAD_PLUGIN_LDR_3D` 类的 3D 插件相关功能。
4. 调用 `Close()` 关闭并解除插件链接。
5. 销毁 `KICAD_PLUGIN_LDR_3D` 实例。

## 3. Scenegraph 类 API
- 由 `ifsg_all.h` 和相关头文件定义，命名空间为 `S3D`。
- 提供了与 VRML2.0 静态场景图兼容的场景图结构和operate类。
- 主要功能包括加载模型、管理场景图等。

## 4. 3D 插件类教程
### 4.1 基础 3D 插件开发
- 通过开发一个基本的 3D 插件 "PLUGIN_3D_DEMO1"，展示插件的构建过程。
- 插件功能：提供文件扩展名过滤功能，方便用户在 KiCad 中浏览 3D 模型文件。
- 插件代码要求：
- 实现插件名称、版本信息获取功能。
- 提供文件扩展名和过滤字符串。
- 通过 `CanRender` 和 `Load` 函数表示不支持模型渲染。

### 4.2 插件构建
- 所需工具：CMake、KiCad 插件头文件、KiCad Scene Graph 库。
- 通过 `FindPackage` 脚本自动检测 KiCad 头文件和库。
- 示例代码：
- 定义插件版本信息。
- 实现插件名称、版本信息、文件扩展名和过滤字符串的获取函数。
- 定义插件不支持模型渲染的函数。

## 5. CMake 配置示例
- 创建项目目录和 `FindPackage` 脚本。
- 添加插件到编译器的包含路径。
- 创建命名为 `s3d_plugin_demo1` 的插件库。

---

总结后内容涵盖了插件版本信息、加载流程、Scenegraph API、3D 插件开发基础与构建步骤，内容简洁明了，重点突出核心观点和关键信息。