vrImmersiveUiService() 类

（继承 vrBaseService）

用于使用交互式虚拟现实窗口和工具的接口。

有关使用示例，请参见向虚拟现实菜单添加按钮和在虚拟现实中移动对象、在协作会话中聚集所有用户和在协作会话中隐藏头像。

摘要

函数：

• createMenu(name) → vrdImmersiveMenu
• createTool(name) → vrdImmersiveTool
• deleteMenu(menu)
• deleteMenu(name)
• deleteTool(tool)
• deleteTool(name)
• findMenu(name) → vrdImmersiveMenu
• findTool(name) → vrdImmersiveTool
• getHideParticipantsVRPanel() → bool
• getHideStatusVRPanel() → bool
• getTools() → List[vrdImmersiveTool]
• openToolsSubMenu(content)
• openToolsSubMenu(widget)
• openToolsSubMenu(tool)
• setHideParticipantsVRPanel(value)
• setHideStatusVRPanel(value)
• showToolsMenu(show, rightHand)
• toggleToolsMenu(rightHand) → bool

信号：

• toolChecked(tool)
• toolClicked(tool)
• toolSubMenuClosed(tool)
• toolSubMenuOpened(tool)
• toolUnchecked(tool)

函数

vrImmersiveUiService.createMenu(name="")

创建新的虚拟现实菜单。

• 参数

  name (string) - 菜单名称

• 返回值

  具有给定名称的新菜单或现有菜单

• 返回值类型

  vrdImmersiveMenu

vrImmersiveUiService.createTool(name="")

创建在虚拟现实工具菜单上可见的新虚拟现实工具。

• 参数

  name (string) - 新工具的名称

• 返回值

  具有给定名称的新工具或现有工具

• 返回值类型

  vrdImmersiveTool

vrImmersiveUiService.deleteMenu(menu)

移除虚拟现实菜单。

• 参数

  menu (vrdImmersiveMenu) - 要删除的菜单

vrImmersiveUiService.deleteMenu(name)

按名称移除虚拟现实菜单。

• 参数

  name (string) - 要移除的菜单的名称

vrImmersiveUiService.deleteTool(tool)

移除虚拟现实工具。

此函数不能用于删除默认创建的工具。

• 参数

  tool (vrdImmersiveTool) - 要移除的工具

vrImmersiveUiService.deleteTool(name)

按名称移除虚拟现实工具。

此函数不能用于删除默认创建的工具。

• 参数

  name (string) - 要移除的工具的名称

vrImmersiveUiService.findMenu(name)

按名称查找虚拟现实菜单。

要查找主虚拟现实菜单面板，请使用：

vrImmersiveUiService.findMenu("ToolsMenu")

• 参数

  name (string) - 要搜索的名称。

• 返回值

  如果找到，则返回菜单，否则返回无效对象

• 返回值类型

  vrdImmersiveMenu

vrImmersiveUiService.findTool(name)

按名称查找虚拟现实工具。

• 参数

  name (string) - 要搜索的名称

• 返回值

  如果找到，则返回工具，否则返回无效对象

• 返回值类型

  vrdImmersiveTool

vrImmersiveUiService.getHideParticipantsVRPanel()

获取参与者隐藏选项。

• 返回值

  如果已隐藏面板，则为 True

• 返回值类型

  bool

vrImmersiveUiService.getHideStatusVRPanel()

获取状态面板隐藏选项。

• 返回值

  如果已隐藏面板，则为 True

• 返回值类型

  bool

vrImmersiveUiService.getTools()

• 返回值

  所有现有虚拟现实工具列表

• 返回值类型

  List[vrdImmersiveTool]

vrImmersiveUiService.openToolsSubMenu(content)

打开具有给定 HTML 内容的新工具子菜单。

• 参数

  content (string) - 内容可以是 http 链接、模块名称或者预定义虚拟现实面板“variantSets”或“viewpoints”之一

vrImmersiveUiService.openToolsSubMenu(widget)

打开具有给定控件的新工具子菜单。

• 参数

  widget (QWidget) - 将显示给定控件

vrImmersiveUiService.openToolsSubMenu(tool)

打开给定 vrdImmersiveTool 的工具子菜单。

按下工具按钮时自动调用此函数。

• 参数

  tool (vrdImmersiveTool) - 子菜单的类型由给定工具确定

vrImmersiveUiService.setHideParticipantsVRPanel(value)

在虚拟现实菜单中隐藏参与者面板。

• 参数

  value (bool) - 为 True 时隐藏面板

vrImmersiveUiService.setHideStatusVRPanel(value)

在虚拟现实菜单中隐藏包含当前时间的状态面板。

• 参数

  value (bool) - 为 True 时隐藏面板

vrImmersiveUiService.showToolsMenu(show, rightHand=False)

打开或关闭虚拟现实工具菜单。

• 参数

  • show (bool) - 为 True 时显示菜单，为 False 时隐藏菜单

  • rightHand (bool) - 在右手 (True) 或左手 (False) 上显示菜单。

vrImmersiveUiService.toggleToolsMenu(rightHand=False)

切换显示/隐藏虚拟现实工具菜单。

• 参数

  rightHand (bool) - 在右手或左手上显示它。

• 返回值

  如果已打开菜单，则为 True

• 返回值类型

  bool

信号

vrImmersiveUiService.toolChecked(tool)

打开工具按钮时发出信号。

• 参数

  tool (vrdImmersiveTool) - 触发信号的 vrdImmersiveTool

vrImmersiveUiService.toolClicked(tool)

单击工具按钮时发出信号。

• 参数

  tool (vrdImmersiveTool) - 触发信号的 vrdImmersiveTool

vrImmersiveUiService.toolSubMenuClosed(tool)

关闭工具子菜单时发出信号。

• 参数

  tool (vrdImmersiveTool) - 触发信号的 vrdImmersiveTool

vrImmersiveUiService.toolSubMenuOpened(tool)

打开工具子菜单时发出信号。

• 参数

  tool (vrdImmersiveTool) - 触发信号的 vrdImmersiveTool

vrImmersiveUiService.toolUnchecked(tool)

关闭工具按钮时发出信号。

• 参数

  tool (vrdImmersiveTool) - 触发信号的 vrdImmersiveTool