YAML配置语法#

配置文件是一个用于初始化环境的 YAML 文件。它包含用于模拟和可视化世界、障碍物和机器人的配置参数。使用者可以通过使用这些参数简单地自定义场景并定义对象的行为。

参数快速参考#

使用此导航快速跳转到特定参数部分：

快速上手

配置的内容主要分为三部分: world, robot, and obstacle. 下面是个建立的示例:`

基础配置

world:
  height: 10  # the height of the world
  width: 10   # the width of the world
  step_time: 0.1  # 10Hz calculate each step
  sample_time: 0.1  # 10 Hz for render and data extraction 
  offset: [0, 0] # the offset of the world on x and y 
  collision_mode: 'stop'  # 'stop', 'unobstructed', 'unobstructed_obstacles'
  plot:
    show_title: true
    figure_pixels: [1000, 800]

robot:
  - kinematics: {name: 'diff'}  # omni, diff, acker
    shape: {name: 'circle', radius: 0.2}  # radius
    # shape: {name: 'rectangle', length: 0.5, width: 0.2}  # radius
    state: [1, 1, 0]  
    goal: [9, 9, 0] 
    # acce: [3, .inf]   # acce of [linear, angular]  or [v_x, v_y] or [linear, steer]
    behavior: {name: 'dash'} # move toward to the goal directly 
  
obstacle:
  - number: 10
    distribution: {name: 'random'}
    shape: 
      - {name: 'circle', radius: 1.0}  # radius
      - {name: 'rectangle', length: 1.5, width: 1.2}  # radius
    state: 
      - [5, 5, 0]  
      - [4, 4, 0]
  
  - shape: {name: 'rectangle', length: 1.5, width: 1.2}  # radius
    state: [6, 5, 1] 

  - shape: {name: 'linestring', vertices: [[5, 5], [4, 0], [1, 6]] }  # vertices
    state: [0, 0, 0] 
    unobstructed: True

重要

关键内容配置指南

要在配置文件中包含多个机器人或障碍物，请在 robot 和 obstacle 部分下添加单独的条目，并使用 - 标记每个添加的条目。
诸如分布、形状、行为和运动学等参数必须格式化为 {key: value} 对。请确保每个字典都包含 name 键；省略 name 将导致该参数的值为 None。
当处理多个对象（即数量大于 1）时，利用 distribution 参数来定义这些对象的摆放位置的分布方式。
默认情况下，同一组内的所有对象共享相同的配置。要自定义组内的单个对象，请使用 - 添加子参数。任何未显式配置的额外对象将继承组中最后一个指定对象的设置。
对象级别的 name 是可选的，用于标识每个对象。如果省略，默认为 "<role>_<id>"（例如 robot_0，obstacle_3）。名称在所有对象中必须是唯一的；重复的名称会在环境初始化期间引发错误。不要将对象级别的 name 与 shape、kinematics 或 behavior 等字典中使用的 name 键（表示组件类型）混淆。

World 配置#

本节介绍 world 区块可用的配置参数。

World 参数表#

参数	类型	默认值	说明
`name`	`str`	`"world"`	世界名称
`height`	`float`	`10`	长（米）
`width`	`float`	`10`	世界的宽
`step_time`	`float`	`0.1`	决定仿真每一步之间的时间间隔（秒）。
`sample_time`	`float`	`step_time`	渲染和数据提取的采样时间间隔（秒）。如未指定则默认为 `step_time`。
`offset`	`float` 列表	`[0, 0]`	世界位置在 `[x, y]` 坐标上的偏移量
`control_mode`	`str`	`"auto"`	`mode`（str）：转向模式，为 `steer` 或 `angular`，默认 `steer`。
`collision_mode`	`str`	`"stop"`	发生碰撞的处理模式（支持：`"stop"`, `"unobstructed"`, `"unobstructed_obstacles"`）
`status`	`str`	`"None"`	仿真环境状态初始化（支持 `"Running"`、`"Arrived"`、`"Collision"`、`"Pause"`）
`obstacle_map`	`str` (文件路径)	`None`	表示障碍物地图的图片文件路径
`mdownsample`	`int`	`1`	障碍地图的降采样系数，用于降低分辨率并减少计算量。
`plot`	`dict`	`{}`	初始化世界图形的绘制选项。

参数详解#

完整世界配置示例#

world:
  name: "world"                       # Name of the world
  height: 10                          # Height of the world
  width: 10                           # Width of the world
  step_time: 0.1                      # Time interval between steps (10 Hz)
  sample_time: 0.1                    # Time interval for rendering and data extraction (10 Hz)
  offset: [0, 0]                      # Positional offset of the world on the x and y axes
  control_mode: 'keyboard'            # Control mode ('auto' or 'keyboard')
  collision_mode: 'stop'              # Collision handling mode ('stop', 'unobstructed', 'unobstructed_obstacles')
  obstacle_map: "path/to/map.png"     # Path to the obstacle map image file
  mdownsample: 2                      # Downsampling factor for the obstacle map
  status: "Running"                   # Initial simulation status
  plot:                               # Plotting configuration
    show_title: true                  # Show plot title
    title: "Custom Simulation Title"  # Custom title (optional)
    figure_pixels: [1200, 800]        # Figure size in pixels
    viewpoint: "robot_0"              # Camera center: fixed [x, y], object name, or null
    saved_figure:                     # Figure saving options
      dpi: 150                        # Resolution for saved figures
      format: "png"                   # File format

警告

obstacle_map：请将 "path/to/map.png" 替换为真实的障碍地图路径，确保图像格式兼容（如PNG、JPEG）且能正确表示障碍位置。

Object 配置#

仿真中的 robot 与 obstacle 都作为对象进行配置，参数结构类似但默认值可能不同。本节介绍这些对象可用的配置项。

Object Parameters Table#

Parameter	类型	Default	描述
`name`	`str` 或者 `list` of `str`	`None`	对象的唯一标识符；若省略，则会自动分配为`"<role>_<id>"`。当`number > 1`时支持参数列表。
`number`	`int`	`1`	要创建的对象数量。
`distribution`	`dict`	`{name: manual}`	定义多个对象的分布方式。支持的分布方式有：`manual`, `random`, `circle`
`kinematics`	`dict`	`None`	对象的运动学模型。支持的模型有`diff`, `acker`, `omni`。
`shape`	`dict`	`{name: circle}`	对象的几何形状。支持的形状有`circle`, `rectangle`, `polygon` , `linestring`
`state`	`float` 列表	`[0, 0, 0]`	对象的初始状态向量。
`velocity`	`float` 列表	`[0, 0]`	初始速度向量。
`goal`	`float`列表或`float`列表的列表	`None`	目标状态向量。
`behavior`	`dict`	`None`	决定对象运动的行为配置，支持 `dash`、`rvo`。
`group_behavior`	`dict`	`None`	同组对象的群体行为配置，支持 `orca`。
`role`	`str`	`"obstacle"`	对象在仿真中的角色。
`color`	`str`	`'k'`（黑色）	对象在仿真中的显示颜色。
`static`	`bool`	`False`	指示对象是否是静态的。
`vel_min`	`float` 列表	`[-1, -1]`	各控制维度的最小速度限制。
`vel_max`	`float` 列表	`[1, 1]`	各控制维度的最大速度限制。
`acce`	`float` 列表	`[inf, inf]`	加速度限制。
`angle_range`	`float` 列表	`[-pi, pi]`	朝向角的弧度范围。
`goal_threshold`	`float`	`0.1`	判定到达目标的距离阈值。
`sensors`	`dict` 列表	`None`	对象所挂载传感器配置列表，支持 `lidar2d`。
`arrive_mode`	`str`	`'position'`	到达检测模式。
`description`	`str`	`None`	对象的图像描述或标签。
`group`	`int`	`0`	用于组织的分组 ID，使对象可以按组管理。
`unobstructed`	`bool`	`False`	指示对象是否忽略碰撞。
`plot`	`dict`	`{}`	对象可视化的绘图选项。
`state_dim`	`int`	`None`	状态向量维度。
`vel_dim`	`int`	`None`	速度向量维度。
`fov`	`float`	`None`	对象传感器的视场角（弧度）。
`fov_radius`	`float`	`None`	对象传感器的视场半径。

参数详解#

object 运动学

运动学模型

diff — 差速驱动，由线速度和角速度控制（[v, omega]）
omni — 全向移动，由 x 和 y 轴方向的线速度控制（[vx, vy]）
acker — 阿克曼转向，由线速度和转向角控制（[v, phi]）

kinematics（dict，默认 None）

设置控制对象运动的运动学模型。

选项:

'diff'：差速驱动机器人，适用于原地旋转的机器人（如两轮机器人）。通过线速度和角速度控制。可选参数：
- noise（bool）：是否给速度命令添加噪声。默认为 False。
- alpha（列表）：速度命令的噪声参数。默认值为 [0.03, 0, 0, 0.03]。
```
# Example usage
kinematics: {name: 'diff', noise: True, alpha: [0.03, 0, 0, 0.03]}
```
'omni'：全向运动，允许在任意方向移动而无需改变朝向。此类机器人通过沿 x 和 y 轴的速度控制。可选参数：
- noise（bool）：是否给速度命令添加噪声。默认为 False。
- alpha（列表）：速度命令的噪声参数。默认值为 [0.03, 0, 0, 0.03]。
```
# Example usage
kinematics: {name: 'omni', noise: True, alpha: [0.03, 0, 0, 0.03]}
```
'acker'：阿克曼转向，典型用于类车辆，需要转向半径。
- noise（bool）：是否给速度命令添加噪声。默认为 False。
- alpha（列表）：速度命令的噪声参数。默认值为 [0.03, 0, 0, 0.03]。
- mode（str）：转向模式，为 steer 或 angular。默认为 steer。
  - steer：对象通过线速度和转向角控制。
  - angular：对象通过线速度和角速度控制。
```
# Example usage
kinematics: {name: 'acker', noise: True, alpha: [0.03, 0, 0, 0.03], mode: 'steer'}
```

vel_min（float 列表，默认：[-1, -1]）和 vel_max （float 列表，默认：[1, 1]）

设置每个控制维度的最小和最大速度限制（例如线速度和角速度）。这些约束确保对象的运动保持在可行且安全的范围内。

acce（float 列表，默认：[inf, inf]）

定义加速度限制，即每个控制维度在每个时间步内的最大速度变化。此参数模拟对象运动能力的物理限制。

angle_range（float 列表，默认：[-pi, pi]）

指定允许的朝向角范围 [min, max]（弧度）。对象的朝向角 theta 会被归整到此范围内以保持一致性。

goal_threshold（float，默认：0.1）

确定对象被认为已到达目标的距离阈值。一旦在此距离范围内，可能会触发到达行为或状态变化。

# Example usage
vel_min: [-1, -1]
vel_max: [1, 1]
acce: [0.5, 0.1]
angle_range: [-pi, pi]
goal_threshold: 0.1

警告

使用 acker 运动学模型时，请确保在 shape 配置中设置 wheelbase 参数。

object 形状

概述

circle — 圆形（radius、center）
rectangle — 矩形（length、width、wheelbase）
polygon — 自定义多边形（vertices、is_convex）
linestring — 线段（vertices）

shape（dict，默认 {name: circle}）

决定用于碰撞检测与可视化的几何形状。

支持的形状：

'circle'：圆形。
- radius（float）：圆半径，默认 0.2。
- center（列表）：圆心 (x, y)，默认 [0, 0]。
- random_shape（bool）：是否随机半径，默认 False。
- radius_range（列表）：当 random_shape=True 时用于随机半径的范围 [min_radius, max_radius]，默认 [0.1, 1.0]。
- wheelbase（float）：阿克曼转向车辆的轴距，使用 'acker' 时必填，默认 None。
```
# Example usage
shape: {name: 'circle', radius: 0.2, center: [0, 0]}
```
'rectangle'：矩形。
- length（float）：x 轴方向长度，默认 1.0。
- width（float）：y 轴方向宽度，默认 1.0。
- wheelbase（float）：阿克曼转向车辆的轴距，使用 'acker' 时必填，默认 None。
```
# Example usage
shape: {name: 'rectangle', length: 1.0, width: 0.5}
```
'polygon'：由顶点列表定义的多边形。
- vertices（列表）：定义多边形的顶点列表，格式 [[x1, y1], ...]。若未提供则生成随机多边形。
- random_shape（bool）：是否生成一系列随机多边形，默认 False。
- is_convex（bool）：是否生成一系列随机凸多边形，默认 False。
- 随机多边形生成参数详见 random_generate_polygon，包括number、center_range、avg_radius_range、irregularity_range、spikeyness_range、num_vertices_range。
```
# Example usage
shape:
  name: 'polygon'
  vertices: 
    - [4.5, 4.5]
    - [5.5, 4.5]
    - [5.5, 5.5]
    - [4.5, 5.5]
```
```
# Example usage - random polygon
shape:
  - {name: 'polygon', random_shape: true, center_range: [5, 10, 40, 30], avg_radius_range: [0.5, 2], irregularity_range: [0, 1], spikeyness_range: [0, 1], num_vertices_range: [4, 5]} 
```
'linestring'：由顶点列表定义的折线，类似多边形但生成的是一串线。
- vertices（列表）：定义线串的顶点列表，格式 [[x1, y1], ...]。
- random_shape（bool）：是否生成随机线串（多边形），默认 False。
- is_convex（bool）：是否生成随机凸线串（多边形），默认 False。
- 随机线串（多边形）生成参数详见 random_generate_polygon，包括 number、center_range、avg_radius_range、irregularity_range、spikeyness_range、num_vertices_range。
```
# Example usage
shape:
  name: 'linestring'
  vertices: 
    - [4.5, 4.5]
    - [5.5, 4.5]
    - [5.5, 5.5]
    - [4.5, 5.5]
```
```
# Example usage - random linestring
shape:
  - {name: 'linestring', random_shape: true, center_range: [5, 10, 40, 30], avg_radius_range: [0.5, 2], irregularity_range: [0, 1], spikeyness_range: [0, 1], num_vertices_range: [4, 5]} 
```

object 行为

行为系统

behavior：dash（直接朝目标移动）、rvo（碰撞避让算法）
group_behavior: orca (optimal reciprocal collision avoidance)
static — 静止对象（True/False）

behavior（dict，默认 None）

配置对象的运动行为，可为简单或复杂策略，并可包含额外参数。

选项:

'dash'：以最大允许速度直接朝目标移动。
- wander（bool/False）：是否加入随机游走。若为 True，对象到达当前目标后会随机分配新目标。
- target_roles（str/all）：仅对具有目标角色的对象应用该行为。当前可设为 robot 或 obstacle。
- range_low（列表）：随机游走下界，默认 [0, 0, -3.14]。
- range_high（列表）：随机游走上界，默认 [10, 10, 3.14]。
- angle_tolerance（float）：diff、acker 运动学的朝向校准容差，默认 0.1。
示例：
```
behavior: {name: 'dash', wander: True, range_low: [0, 0, -3.14], range_high: [10, 10, 3.14], angle_tolerance: 0.1}
```
'rvo'：实现多动态体避碰的 RVO 算法，支持 diff 与 omni 运动学。
- wander（bool/False）：是否加入随机游走。若为 True，对象到达当前目标后会随机分配新目标。
- target_roles（str/all）：仅对具有目标角色的对象应用该行为。当前可设为 robot 或 obstacle。
- range_low（列表）：随机游走下界，默认 [0, 0, -3.14]。
- range_high（列表）：随机游走上界，默认 [10, 10, 3.14]。
- vxmax（float）：x 轴最大线速度，默认 1.5。
- vymax（float）：y 轴最大线速度，默认 1.5。
- acce（float）：最大加速度，默认 1.0。
- factor（float）：RVO 算法因子，默认 1.0。
- mode（str）：RVO 算法模式，可选 rvo、hrvo、vo，默认 rvo。
  - rvo：互惠速度障碍法，用于多智能体避碰。
  - hrvo：混合 RVO，将 RVO 与 VO 结合以减少死锁。
  - vo：速度障碍，用于避障。
- neighbor_threshold（float）：筛选邻居的距离阈值，默认 3.0。
示例：
```
behavior: {name: 'rvo', vxmax: 1.5, vymax: 1.5, acce: 1.0, factor: 1.0, mode: 'rvo', wander: False}
```

group_behavior（dict，默认 None）

同组内所有对象的群体行为。对于协同行为（如群体或人群仿真）更高效，因为它在单步中为所有成员计算动作。必须包含 name 及行为特定参数。

选项:

'orca'：最优互惠碰撞避让（ORCA），用于多智能体导航。需要 pyrvo 包（pip install pyrvo）。仿真仅在使用此行为时尝试导入。
- wander（bool/False）：是否加入随机游走。若为 True，对象到达当前目标后会随机分配新目标。
- range_low（列表）：随机游走下界，默认 [0, 0, -3.14]。
- range_high（列表）：随机游走上界，默认 [10, 10, 3.14]。
- neighborDist（float/15.0）：搜索邻居的最大距离。
- maxNeighbors（int/10）：考虑的邻居数量上限。
- timeHorizon（float/20.0）：相对于其他智能体计算安全速度的时间范围。
- timeHorizonObst（float/10.0）：相对于静态障碍物计算安全速度的时间范围。
- safe_radius（float/0.1）：额外的安全半径填充。
- maxSpeed（float/None）：智能体最大速度。若为 None，使用对象的 vel_max。
示例：
```
group_behavior: 
  name: 'orca'
  neighborDist: 10.0
  maxNeighbors: 10
  timeHorizon: 10.0
  timeHorizonObst: 10.0
  safe_radius: 0.1
```

static：布尔值，表示对象是否静止。静止对象忽略运动学与行为，保持初始状态。

示例：

static: True

object 可视化

概述

color — 对象颜色（'r'、'blue'、'k' 等）
description — 图像文件（如 'car_blue.png'、'diff_robot0.png'）
plot — 进阶显示选项
- Object — 外观（obj_color、obj_alpha、obj_linestyle）
- Goal — 目标标记（show_goal、goal_color）
- Trail — 轨迹点（show_trail、keep_trail_length）
- Trajectory — 路径线（show_trajectory、keep_traj_length）
- Sensors — 传感器显示（show_sensor、show_fov）

color（str，默认 'k' 黑色）

指定可视化中的对象颜色，便于区分。更多色彩见 matplotlib color。

示例：

color: 'r'

description（str，默认 None）

提供用于图形展示的图像，可使用 world/description 下的文件，或自定义绝对路径。

可用图像：

car_green.png：阿克曼车辆默认图。
car_blue.png
car_red.png
diff_robot0.png
diff_robot1.png

示例：

description: 'car_blue.png'

plot：包含控制对象显示的绘图选项。所有绘图元素初始创建在原点，并在动画更新时通过变换与数据更新定位。

对象可视化属性：

obj_linestyle（str）：对象轮廓线型（如 '-', '--', ':', '-.'），默认 '-'.
obj_zorder（int）：对象元素的绘制层级，机器人默认 3、障碍物默认 1。
obj_color（str）：对象颜色，默认沿用 color。
obj_alpha（float）：对象透明度（0.0-1.0），默认 1.0。
obj_linewidth（float）：轮廓线宽，默认随对象类型而定。

目标可视化：

show_goal（bool）：是否显示目标位置，默认 False。
- goal_color（str）：目标标记颜色，默认与对象一致。
- goal_alpha（float）：目标透明度，默认 0.5。
- goal_zorder（int）：目标层级，默认 1。

文本标签可视化：

show_text（bool）：是否显示文本信息，默认 False。
- text_color（str）：文本颜色，默认 'k'（黑）。
- text_size（int）：字体大小，默认 10。
- text_alpha（float）：文本透明度，默认 1.0。
- text_zorder（int）：文本层级，默认 2。
- text_position（列表）：相对对象中心的偏移 [dx, dy]，默认 [-radius-0.1, radius+0.1]。

速度箭头可视化：

show_arrow（bool）：是否显示速度箭头，默认 False。
- arrow_color（str）：箭头颜色，默认 "gold"。
- arrow_length（float）：箭头长度，默认 0.4。
- arrow_width（float）：箭头宽度，默认 0.6。
- arrow_alpha（float）：箭头透明度，默认 1.0。
- arrow_zorder（int）：箭头层级，默认 4。

轨迹线可视化：

show_trajectory（bool）：是否显示路径线，默认 False。
- traj_color（str）：路径颜色，默认继承对象颜色。
- traj_style（str）：路径线型（如 '-', '--', ':', '-.'），默认 "-"。
- traj_width（float）：路径线宽，默认为对象宽度。
- traj_alpha（float）：路径透明度，默认 0.5。
- traj_zorder（int）：路径层级，默认 0。
- keep_traj_length（int）：保留的尾段步数，默认 0（保留全部）。

对象轨迹点可视化：

show_trail（bool）：是否显示轨迹点，默认 False。
- trail_freq（int）：轨迹显示频率（每 N 步），默认 2。
- trail_type（str）：轨迹形状类型，默认与对象形状相同。
- trail_edgecolor（str）：轨迹边缘颜色，默认为对象颜色。
- trail_linewidth（float）：轨迹线宽，默认 0.8。
- trail_alpha（float）：轨迹透明度，默认 0.7。
- trail_fill（bool）：是否填充轨迹形状，默认 False。
- trail_color（str）：轨迹填充色，默认为对象颜色。
- trail_zorder（int）：轨迹层级，默认 0。
- keep_trail_length（int）：保留的轨迹尾段步数，默认 0（保留全部）。

传感器可视化：

show_sensor（bool）：是否显示传感器，默认 True。

视场可视化：

show_fov（bool）：是否显示视场，默认 False。
- fov_color（str）：视场填充色，默认 "lightblue"。
- fov_edge_color（str）：视场边缘色，默认 "blue"。
- fov_alpha（float）：视场透明度，默认 0.5。
- fov_zorder（int）：视场层级，默认 1。

注意： 所有可视化元素在初始化时创建于原点，并在动画期间通过 matplotlib 的变换（patch）与 set_data（线）定位。

示例：

plot:
  # Object appearance
  obj_linestyle: '--'
  obj_zorder: 3
  obj_color: 'blue'
  obj_alpha: 0.8
  obj_linewidth: 2.0
  
  # Goal visualization
  show_goal: True
  goal_color: 'red'
  goal_alpha: 0.7
  goal_zorder: 2
  
  # Text labels
  show_text: True
  text_color: 'black'
  text_size: 12
  text_alpha: 0.9
  text_zorder: 5
  
  # Velocity arrows
  show_arrow: True
  arrow_color: 'gold'
  arrow_length: 0.5
  arrow_width: 0.8
  arrow_alpha: 0.9
  arrow_zorder: 4
  
  # Trajectory path
  show_trajectory: True
  traj_color: 'green'
  traj_style: '-'
  traj_width: 0.6
  traj_alpha: 0.6
  traj_zorder: 1
  
  # Object trails
  show_trail: True
  trail_freq: 3
  trail_edgecolor: 'purple'
  trail_linewidth: 1.0
  trail_alpha: 0.5
  trail_fill: False
  trail_color: 'purple'
  trail_zorder: 0
  
  # Sensors and FOV
  show_sensor: True
  show_fov: True
  fov_color: 'lightblue'
  fov_edge_color: 'blue'
  fov_alpha: 0.3
  fov_zorder: 1

GUI 配置#

GUI 参数表#

Parameter	类型	Default	描述
`keyboard`	`dict`	`{}`	键盘控制选项（当 `world.control_mode: keyboard` 时生效）。
`mouse`	`dict`	`{}`	鼠标控制选项。

配置示例#

下面通过多个配置示例展示 IR-SIM 的灵活性与能力：

多机器人 RVO

robot:
  - number: 10
    distribution: {name: 'circle', radius: 4.0, center: [5, 5]}  
    kinematics: {name: 'diff'}
    shape: 
      - {name: 'circle', radius: 0.2}  
    behavior: {name: 'rvo', vxmax: 1.5, vymax: 1.5, acce: 1.0, factor: 1.0}
    vel_min: [-3, -3.0]
    vel_max: [3, 3.0]
    color: ['royalblue', 'red', 'green', 'orange', 'purple', 'yellow', 'cyan', 'magenta', 'lime', 'pink', 'brown'] 
    arrive_mode: position
    goal_threshold: 0.15
    plot:
      show_trail: true
      show_goal: true
      trail_fill: true
      trail_alpha: 0.2
      show_trajectory: false

多机器人ORCA

robot:
  - number: 10
    distribution: {name: 'circle', radius: 4.0, center: [5, 5]}
    kinematics: {name: 'omni'}
    shape: {name: 'circle', radius: 0.2}
    group_behavior: 
      name: 'orca'
      neighborDist: 10.0
      maxNeighbors: 10
      timeHorizon: 10.0
      timeHorizonObst: 10.0
      safe_radius: 0.1
    vel_max: [2.0, 2.0]
    goal: [9, 9, 0]
    plot:
      show_trail: true
      trail_alpha: 0.5

混合障碍

obstacle:
  - shape: {name: 'circle', radius: 1.0}  # radius
    state: [5, 5, 0]  
  
  - shape: {name: 'rectangle', length: 1.5, width: 1.2}  # radius
    state: [6, 5, 1] 

  - shape: {name: 'linestring', vertices: [[5, 5], [4, 0], [1, 6]] }  # vertices
    state: [0, 0, 0] 
    unobstructed: True

  - shape:
      name: 'polygon'
      vertices: 
        - [4.5, 4.5]
        - [5.5, 4.5]
        - [5.5, 5.5]
        - [4.5, 5.5]

阿克曼车辆

robot:  
  - kinematics: {name: 'acker'}  
    shape: {name: 'rectangle', length: 4.6, width: 1.6, wheelbase: 3}
    state: [1, 1, 0, 0]
    goal: [40, 40, 0]
    vel_max: [4, 1]
    behavior: {name: 'dash'}
    plot:
      show_trajectory: True

传感器集成

robot:
  - kinematics: {name: 'diff'}
    shape: {name: 'circle', radius: 0.3}
    state: [2, 2, 0]
    goal: [8, 8, 0]
    behavior: {name: 'rvo'}
    sensors:
      - name: 'lidar2d'
        range_min: 0.1
        range_max: 8.0
        angle_range: 6.28  # Full 360 degrees
        number: 360
        noise: True
        std: 0.1
        offset: [0, 0, 0]
        color: 'red'
    plot:
      show_sensor: True
      show_fov: True
      fov_color: 'lightgreen'
      fov_alpha: 0.3

小技巧

配置最佳实践：

多对象：配置多个对象时，结合 number 与 distribution 高效生成。例如设定 number: 10 且 distribution: 'random' 可快速随机填充场景。
字典参数：所有字典类型参数（如 distribution、shape、kinematics、behavior）必须包含 'name' 键以声明类型，否则会退回默认值或引发错误。
分组配置：同组对象默认共享配置。若需定制，请使用 - 添加子参数；未显式配置的对象会继承组内最后一个配置。
运动学与速度：确保 velocity 与 vel_max 的格式与运动学模型匹配，例如差速 ('diff') 使用 [v, omega]，全向 ('omni') 使用 [vx, vy]。
绘图选项：若 plot 位于对象配置内部，可为单个对象定制可视化；若位于对象配置的根级，则应用于所有对象。

YAML配置语法#

参数快速参考#

World 配置#

World 参数表#

参数详解#

完整世界配置示例#

Object 配置#

Object Parameters Table#

参数详解#

GUI 配置#

GUI 参数表#

配置示例#

本页