问题背景与挑战
在使用pydrake进行机器人项目开发时，我们经常需要集成自定义的sdf（simulation description format）文件与pydrake或manipulation包中提供的模型。传统的sdf文件引用方式主要面临以下挑战：
- 绝对路径引用 (file://absolute/path/to/file.sdf)： 这种方式虽然能够使模型被加载，但路径硬编码了本地文件系统结构。这意味着当项目在不同开发环境、不同用户计算机上运行，或进行版本合并时，YAML文件中的路径将变得难以维护和移植，极易引发错误。
- 包路径引用 (package://package_name/path/to/file.sdf)： 这是pydrake推荐且广泛使用的标准方式，它要求SDF文件存在于已知的软件包结构中。对于我们自己编写的、非pydrake内置的SDF文件，直接使用这种方式并不直观，因为它们不属于任何已定义的pydrake包。
尝试使用file://./relative/path/to/file.sdf形式的相对路径会抛出错误，无法直接解决路径可移植性问题。为了解决这些问题，开发者有时会采取一些权宜之计，例如动态生成YAML文件以嵌入绝对路径，或者直接将自定义SDF文件复制到pydrake/manipulation包的目录中。这些方法都不够优雅，且可能引入版本控制或维护上的复杂性。
解决方案：创建本地SDF包
pydrake底层依赖的sdformat库支持通过“包”机制来解析SDF文件路径，这与ROS中的包管理概念类似。我们可以利用这一特性，为本地SDF文件创建一个“虚拟”的本地包，从而以标准且可移植的package:// URI格式引用它们。
步骤一：组织SDF文件与创建package.xml
首先，将所有需要作为本地包引用的自定义SDF文件放置在一个独立的目录中。然后，在该目录下创建一个名为package.xml的文件。这个package.xml文件是定义本地包的关键。
例如，如果你的SDF文件my_robot.sdf和another_object.sdf都位于/path/to/my_project/my_models/目录下，那么package.xml也应该创建在这个目录下。
步骤二：编写package.xml文件内容
package.xml文件的内容非常简洁，对于本地SDF引用而言，只需指定包的名称即可。请确保
my_local_sdf_package 0.0.1 A local package for custom SDF models in pydrake projects. Your Name MIT
在上述示例中，我们将本地包命名为my_local_sdf_package。这个名称将在后续的YAML引用中用到。
步骤三：在pydrake场景YAML中引用SDF文件
完成上述设置后，你就可以在你的pydrake场景YAML文件中，使用package:// URI格式来引用该目录下的任何SDF文件了。
示例代码：
假设你的项目结构如下：
my_project/ ├── my_models/ │ ├── package.xml │ ├── my_robot.sdf │ └── another_object.sdf └── my_scene.yaml
my_models/package.xml内容如上所示。
my_scene.yaml文件内容示例：
- add model:
name: my_custom_robot
file: package://my_local_sdf_package/my_robot.sdf
# 其他模型配置，例如：
# X_WM:
# base_frame: world
# translation: [0, 0, 0.5]
# rotation: !Rpy {deg: [0, 0, 0]}
- add model:
name: custom_object
file: package://my_local_sdf_package/another_object.sdf
# 其他模型配置...
# 你也可以同时引用pydrake内置的模型
- add model:
name: manipulation_box
file: package://drake_manipulation_models/box.sdf
# 其他模型配置...工作原理与优势
当pydrake尝试加载场景YAML文件并解析package:// URI时，它会通过sdformat的资源查找机制来定位文件。通过在SDF文件所在的目录中添加package.xml，我们实际上是告诉sdformat这个目录是一个“包”的根目录，其名称由package.xml中的
这种方法的优势显而易见：
- 可移植性： YAML文件不再包含硬编码的绝对路径，可以在不同系统和开发环境中无缝共享。
- 维护性： 简化了版本控制，合并代码时冲突更少。
- 一致性： 与pydrake/manipulation包中模型的引用方式保持一致，提高了代码的可读性和统一性。
- 优雅性： 避免了动态生成YAML或修改pydrake包目录等不优雅的解决方案。
注意事项
-
包名唯一性： 确保你选择的本地包名（
标签内容）不会与pydrake或任何其他已安装的包冲突。 - 资源查找路径： 在大多数标准项目结构中，package.xml的存在已足够让sdformat在当前工作目录或其子目录中找到它。但在某些复杂环境下，如果pydrake无法自动发现你的本地包，你可能需要显式地将包含你本地包的父目录添加到pydrake的资源查找路径中。这通常通过设置DRAKE_RESOURCE_ROOT环境变量或在Python代码中调用drake.findResource相关的API来实现。
- 版本控制： 确保package.xml文件与你的SDF文件一同被版本控制系统管理，以保证项目配置的完整性和可重现性。
总结
通过在本地SDF文件目录中创建简洁的package.xml文件，我们能够将自定义SDF模型封装成一个“本地包”，进而利用package:// URI在pydrake场景YAML中进行优雅、可移植且易于维护的引用。这不仅解决了路径管理上的难题，也提升了整个项目配置的专业性和一致性，是管理自定义SDF文件的推荐实践。
