应用程序接口

欢迎阅读 IR-SIM API 参考。本节提供该软件包中所有模块、类与函数的详细说明。

核心仿真循环

最常用的几个入口；其余功能都可以从下面的模块进入。

• irsim.make()：从 YAML 场景创建环境。

• step()：将仿真推进一步。

• render()：绘制当前状态。

• done()：检查是否达到终止条件。

• reset()：将对象恢复到初始状态。

• end()：关闭环境并释放资源。

• get_robot_state()：读取主机器人的状态。

• get_lidar_scan()：读取机器人的激光雷达扫描。

• get_msg()：捕获完整的 ROS 风格仿真消息。

• receive_msg()：将外部 ROS 风格里程计应用到仿真对象。

如何阅读本参考

下面的 API 页面由 AutoAPI 从 Python 包自动生成。编写仿真时请从高层入口开始；扩展 IR-SIM 本身时再使用底层模块。

任务	主要 API	说明
创建并运行环境	irsim.make(), EnvBase	大多数用户首选的公共入口。
查看或控制对象	ObjectBase	机器人、障碍物和地图对象的公共基类。
从 YAML 创建对象	ObjectFactory	由 YAML 加载器内部使用；也适用于高级的编程式搭建。
添加运动学模型	register_kinematics(), KinematicsHandler	以 YAML kinematics 使用的名称注册模型。
添加对象几何	GeometryFactory	将 YAML shape 字典转换为 Shapely 几何。
添加传感器	SensorFactory	根据 YAML sensors 条目创建具体传感器。
交换仿真消息	WorldState、Odometry、LaserScan	与 ROS 版本无关的快照，用于桥接端序列化和状态接收。
使用路径规划器	irsim.lib.path_planners	栅格与采样规划器基于 EnvGridMap 工作。

生成的页面可能包含继承成员，以便再导出的公共 API 依然可以查到。当 YAML 配置与底层构造函数的默认值不同时，YAML 参考描述 YAML 的行为，API 参考描述直接使用 Python 构造函数的行为。

API 文档

• 概览（irsim.make、EnvBase）
• irsim.msg
• irsim.env
• irsim.world
• irsim.lib
• irsim.gui
• irsim.util
• irsim.config