Files
RCS-3000/docs/custom_path/README.md
CaiXiang af65c2425d initial
2025-11-14 16:09:58 +08:00

166 lines
4.2 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

# AGV 自定义路径功能文档
## 📚 文档导航
本目录包含AGV自定义路径功能的完整文档。
### 🚀 快速开始
**推荐阅读顺序:**
1. **[FINAL_SUMMARY.md](FINAL_SUMMARY.md)** ⭐
- 功能总览和快速了解
- 适合:第一次使用者
2. **[QUICKSTART_CUSTOM_PATH.md](QUICKSTART_CUSTOM_PATH.md)**
- 最简单的使用示例
- 3分钟快速上手
- 适合:想要快速试用
3. **[CUSTOM_PATH_GUIDE.md](CUSTOM_PATH_GUIDE.md)**
- 详细使用教程
- 所有功能说明
- 适合:深入学习
### 🖥️ QT 图形界面
如果你想在QT界面中使用自定义路径
4. **[apply_qt_modifications.md](apply_qt_modifications.md)** ⭐
- 快速修改步骤(最简洁)
- 适合:快速集成
5. **[qt_gui_custom_code_snippet.cpp](qt_gui_custom_code_snippet.cpp)**
- 完整代码示例
- 可直接复制使用
6. **[QT_GUI_CUSTOM_PATH_GUIDE.md](QT_GUI_CUSTOM_PATH_GUIDE.md)**
- 详细修改指南
- 适合:深入理解
### 🔧 安装和实现
7. **[install_custom_path.sh](install_custom_path.sh)**
- 自动安装脚本
- 使用方法:`bash install_custom_path.sh`
8. **[path_curve.h.patch](path_curve.h.patch)**
- 头文件修改补丁
- 供手动安装参考
9. **[CUSTOM_PATH_IMPLEMENTATION_SUMMARY.txt](CUSTOM_PATH_IMPLEMENTATION_SUMMARY.txt)**
- 实现细节和技术文档
- 适合:开发者深入研究
10. **[REFERENCE_PATH_SUMMARY.txt](REFERENCE_PATH_SUMMARY.txt)**
- 原有路径系统分析
- 背景知识
---
## 📖 按使用场景选择
### 场景1: 我想快速试用自定义路径
```
阅读: QUICKSTART_CUSTOM_PATH.md
示例: examples/custom_path.csv
```
### 场景2: 我想在QT界面中使用
```
1. 阅读: apply_qt_modifications.md
2. 参考: qt_gui_custom_code_snippet.cpp
3. 修改: examples/qt_gui_demo.cpp
```
### 场景3: 我想深入了解所有功能
```
1. 总览: FINAL_SUMMARY.md
2. 详细: CUSTOM_PATH_GUIDE.md
3. 实现: CUSTOM_PATH_IMPLEMENTATION_SUMMARY.txt
```
### 场景4: 我想安装功能
```
自动: bash docs/custom_path/install_custom_path.sh
手动: 参考 CUSTOM_PATH_GUIDE.md 的"安装步骤"
```
---
## 📝 文档列表
| 文件名 | 大小 | 说明 | 难度 |
|-------|------|------|------|
| FINAL_SUMMARY.md | 6.9KB | 功能总览 | ⭐ 入门 |
| QUICKSTART_CUSTOM_PATH.md | 5.9KB | 快速开始 | ⭐ 入门 |
| CUSTOM_PATH_GUIDE.md | 8.2KB | 完整教程 | ⭐⭐ 进阶 |
| apply_qt_modifications.md | 2.0KB | QT快速修改 | ⭐ 入门 |
| QT_GUI_CUSTOM_PATH_GUIDE.md | 7.9KB | QT详细指南 | ⭐⭐ 进阶 |
| qt_gui_custom_code_snippet.cpp | 7.2KB | QT代码示例 | ⭐⭐ 进阶 |
| install_custom_path.sh | 2.1KB | 安装脚本 | ⭐ 工具 |
| path_curve.h.patch | 1.4KB | 头文件补丁 | ⭐⭐⭐ 开发 |
| CUSTOM_PATH_IMPLEMENTATION_SUMMARY.txt | 8.4KB | 实现细节 | ⭐⭐⭐ 开发 |
| REFERENCE_PATH_SUMMARY.txt | - | 原系统分析 | ⭐⭐ 背景 |
---
## ✨ 核心功能
本文档库涵盖以下功能:
1. **CSV路径加载** - 从文件加载自定义路径
```cpp
path.loadFromCSV("my_path.csv");
```
2. **CSV路径保存** - 导出路径供重用
```cpp
path.saveToCSV("output.csv");
```
3. **样条插值** - 从关键点生成平滑曲线
```cpp
path.generateSpline(key_points, 200, 0.5);
```
4. **QT界面集成** - 图形化操作和可视化
---
## 🎯 常见问题
**Q: 我应该从哪个文档开始?**
A: 从 `FINAL_SUMMARY.md` 开始,获取整体概览。
**Q: 如何最快上手?**
A: 阅读 `QUICKSTART_CUSTOM_PATH.md`3分钟即可运行示例。
**Q: QT界面怎么修改**
A: 查看 `apply_qt_modifications.md`只需4处简单修改。
**Q: 编译出错怎么办?**
A: 运行 `bash install_custom_path.sh` 自动安装,或查看文档的"故障排除"章节。
**Q: 想要完整示例代码?**
A: 查看 `qt_gui_custom_code_snippet.cpp`。
---
## 📞 获取帮助
- 快速问题: 查看各文档的"常见问题"章节
- 技术细节: `CUSTOM_PATH_IMPLEMENTATION_SUMMARY.txt`
- 代码示例: `examples/` 目录
- 完整教程: `CUSTOM_PATH_GUIDE.md`
---
**最后更新**: 2025-11-13
**版本**: 1.0
**作者**: AGV Path Tracking Team