OmniSimulator.core.engine.SimulationEngine

class OmniSimulator.core.engine.SimulationEngine(config: Dict[str, Any] | None = None, scene_abilities: List[str] = None)[source]

模拟引擎类 - 整个模拟器的核心控制器

__init__(config: Dict[str, Any] | None = None, scene_abilities: List[str] = None)[source]

初始化模拟引擎

Parameters:
  • config – 全局配置字典,可选

  • scene_abilities – 场景特定的能力列表,用于动态注册需要工具的动作

Methods

__init__([config, scene_abilities])

初始化模拟引擎

get_agent_info(agent_id)

获取智能体信息

get_agent_supported_actions_description(...)

获取智能体支持的所有动作的字符串描述

get_object_info(object_id)

获取物体信息

get_room_info(room_id)

获取房间信息

get_task_info()

获取当前任务信息

get_task_verification_status()

获取任务验证状态

get_visualization_status()

获取可视化系统状态

get_visualization_url()

获取可视化Web界面URL

initialize(scene_file[, agent_file])

初始化模拟器 :param scene_file: 场景文件路径 :param agent_file: 智能体文件路径(已废弃,不再使用)

initialize_with_data(data)

使用数据字典初始化模拟器

initialize_with_task(task_file)

使用任务文件初始化模拟器(包括场景和智能体)

load_agents(agents_config)

加载智能体配置

process_command(agent_id, command)

处理智能体的命令

restart_visualization()

重启可视化系统

set_task_data(task_data)

设置任务数据并创建验证器

stop_visualization()

停止可视化系统

update_scene_abilities(new_abilities)

更新场景能力并重新注册相关动作

validate_environment()

验证当前环境是否合法

__init__(config: Dict[str, Any] | None = None, scene_abilities: List[str] = None)[source]

初始化模拟引擎

Parameters:
  • config – 全局配置字典,可选

  • scene_abilities – 场景特定的能力列表,用于动态注册需要工具的动作

initialize(scene_file: str, agent_file: str | None = None) bool[source]

初始化模拟器 :param scene_file: 场景文件路径 :param agent_file: 智能体文件路径(已废弃,不再使用)

Returns:

是否成功初始化

Return type:

bool

initialize_with_task(task_file: str) bool[source]

使用任务文件初始化模拟器(包括场景和智能体)

Parameters:

task_file – 任务文件路径

Returns:

是否成功初始化

Return type:

bool

initialize_with_data(data: Dict[str, Any]) bool[source]

使用数据字典初始化模拟器

Parameters:

data

包含场景、任务和动作配置的数据字典 格式: {

’scene’: scene_data, # 场景数据 ‘task’: task_data, # 任务数据 (可选) ‘actions’: action_config_data # 动作配置数据 (可选)

}

Returns:

是否成功初始化

Return type:

bool

validate_environment() Tuple[bool, List[str]][source]

验证当前环境是否合法

Returns:

(是否合法, 错误信息列表)

Return type:

Tuple[bool, List[str]]

load_agents(agents_config: List[Dict[str, Any]]) bool[source]

加载智能体配置

Parameters:

agents_config – 智能体配置列表

Returns:

是否成功加载

Return type:

bool

process_command(agent_id: str, command: str)[source]

处理智能体的命令

Parameters:
  • agent_id – 智能体ID

  • command – 命令字符串

Returns:

(执行状态, 反馈消息, 结果数据)

Return type:

Tuple

get_agent_info(agent_id: str) Dict[str, Any] | None[source]

获取智能体信息

Parameters:

agent_id – 智能体ID

Returns:

智能体信息字典

Return type:

Dict

get_visualization_status() Dict[str, Any][source]

获取可视化系统状态

Returns:

可视化系统状态信息

Return type:

Dict

get_visualization_url() str | None[source]

获取可视化Web界面URL

Returns:

可视化URL,如果未启用则返回None

Return type:

str

stop_visualization()[source]

停止可视化系统

restart_visualization() bool[source]

重启可视化系统

Returns:

是否成功重启

Return type:

bool

get_object_info(object_id: str) Dict[str, Any] | None[source]

获取物体信息

Parameters:

object_id – 物体ID

Returns:

物体信息字典

Return type:

Dict

get_room_info(room_id: str) Dict[str, Any] | None[source]

获取房间信息

Parameters:

room_id – 房间ID

Returns:

房间信息字典

Return type:

Dict

get_task_info() Dict[str, Any] | None[source]

获取当前任务信息

Returns:

任务信息字典

Return type:

Dict

update_scene_abilities(new_abilities: List[str])[source]

更新场景能力并重新注册相关动作

Parameters:

new_abilities – 新的能力列表

get_task_verification_status() Dict[str, Any] | None[source]

获取任务验证状态

Returns:

验证状态,如果未启用验证则返回None

Return type:

Optional[Dict[str, Any]]

set_task_data(task_data: Dict[str, Any])[source]

设置任务数据并创建验证器

Parameters:

task_data – 任务数据,来自task.json文件

get_agent_supported_actions_description(agent_ids: List[str]) str[source]

获取智能体支持的所有动作的字符串描述

Parameters:

agent_ids – 智能体ID列表,支持单个或多个智能体

Returns:

包含所有支持动作的描述字符串(英文)

Return type:

str