vrImmersiveUiService

class vrImmersiveUiService

(Inherits vrBaseService)

Interface to work with interactive VR windows and tools.

Functions

vrImmersiveUiService.createMenu(name='')

Creates a new VR menu.

Parameters:name (string) – Name of the menu
Returns:A new menu or an existing menu with the given name
Return type:vrdImmersiveMenu
vrImmersiveUiService.createTool(name='')

Creates a new VR tool visible on the VR tools menu.

Parameters:name (string) – Name of the new tool
Returns:A new tool or an existing one with the given name
Return type:vrdImmersiveTool
vrImmersiveUiService.deleteMenu(menu)

Removes a VR menu.

Parameters:menu (vrdImmersiveMenu) – Menu to be deleted
vrImmersiveUiService.deleteMenu(name)

Removes a VR menu by name.

Parameters:name (string) – Name of the menu to be removed
vrImmersiveUiService.deleteTool(tool)

Removes a VR tool.

This can not be used to delete the tools created by default.

Parameters:tool (vrdImmersiveTool) – Tool to be removed
vrImmersiveUiService.deleteTool(name)

Remove a VR tool by name.

This can not be used to delete the tools created by default.

Parameters:name (string) – Name of the tool to be removed
vrImmersiveUiService.findMenu(name)

Find a VR menu by name.

To find the main VR menu panel, use:

vrImmersiveUiService.findMenu("ToolsMenu")
Parameters:name (string) – Name to search for.
Returns:If found, the menu otherwise an invalid object
Return type:vrdImmersiveMenu
vrImmersiveUiService.findTool(name)

Find a VR tool by name.

Parameters:name (string) – Name to search for
Returns:If found, the tool otherwise an invalid object
Return type:vrdImmersiveTool
vrImmersiveUiService.getHideParticipantsVRPanel()

Get participants hide option.

Returns:True, if panel is hidden
Return type:bool
vrImmersiveUiService.getHideStatusVRPanel()

Get status panel hide option.

Returns:True, if panel is hidden
Return type:bool
vrImmersiveUiService.getTools()
Returns:A list of all existing vr tools
Return type:List[vrdImmersiveTool]
vrImmersiveUiService.openToolsSubMenu(content)

Opens a new tools sub menu with the given html content.

Parameters:content (string) – Content can be a http link, a name of a module or one of the predefined VR panels “variantSets” or “viewpoints”
vrImmersiveUiService.openToolsSubMenu(widget)

Opens a new tools sub menu with the given widget.

Parameters:widget (QWidget) – The given widget is displayed
vrImmersiveUiService.openToolsSubMenu(tool)

Opens the tools sub menu of the given vrdImmersiveTool.

This functions is called automatically, if a tool button is pressed.

Parameters:tool (vrdImmersiveTool) – The type of the submenu is determined by the given tool
vrImmersiveUiService.setHideParticipantsVRPanel(value)

Hides the participants panel in the vr menu.

Parameters:value (bool) – True, hides the panel
vrImmersiveUiService.setHideStatusVRPanel(value)

Hides the status panel with the current time in the vr menu.

Parameters:value (bool) – True, hides the panel
vrImmersiveUiService.showToolsMenu(show, rightHand=False)

Opens or closes the VR tools menu.

Parameters:
  • show (bool) – True shows the menu, False hides the menu
  • rightHand (bool) – Show it on the right (true) or left (false) hand.
vrImmersiveUiService.toggleToolsMenu(rightHand=False)

Toggles show/hide VR tools menu.

Parameters:rightHand (bool) – Show it on the right or left hand.
Returns:True, if the menu has been switched on
Return type:bool

Signals

vrImmersiveUiService.toolChecked(tool)

Signal emitted, if a tool button is switched on.

Parameters:tool (vrdImmersiveTool) – The vrdImmersiveTool that triggered the signal
vrImmersiveUiService.toolClicked(tool)

Signal emitted, if a tool button is clicked.

Parameters:tool (vrdImmersiveTool) – The vrdImmersiveTool that triggered the signal
vrImmersiveUiService.toolSubMenuClosed(tool)

Signal emitted, if a tool sub menu is closed.

Parameters:tool (vrdImmersiveTool) – The vrdImmersiveTool that triggered the signal
vrImmersiveUiService.toolSubMenuOpened(tool)

Signal emitted, if a tool sub menu is opened.

Parameters:tool (vrdImmersiveTool) – The vrdImmersiveTool that triggered the signal
vrImmersiveUiService.toolUnchecked(tool)

Signal emitted, if a tool button is switched off.

Parameters:tool (vrdImmersiveTool) – The vrdImmersiveTool that triggered the signal