vrdImmersiveTool

class vrdImmersiveTool

(Inherits vrdObject)

VR tool object.

Functions

vrdImmersiveTool.getCheckable()
Returns:True, if the tool button is checkable
Return type:bool
vrdImmersiveTool.getChecked()
Returns:True, if the tool button is checked
Return type:bool
vrdImmersiveTool.getCheckedCommand()
Returns:The command executed, when the button is checked
Return type:string
vrdImmersiveTool.getClickedCommand()
Returns:The command executed on click
Return type:string
vrdImmersiveTool.getGroup()
Returns:The button group
Return type:string
vrdImmersiveTool.getHideAway()

Returns if the tool is hidden from the VR menu.

Returns:True if the tool is hidden, False otherwise.
Return type:bool
vrdImmersiveTool.getIcon()
Returns:The current icon
Return type:QIcon
vrdImmersiveTool.getIsInternal()

Returns if the tool is marked as internal. All tools that are created internally by default will have this flag set.

Returns:True if the tool is internal, False otherwise.
Return type:bool
vrdImmersiveTool.getName()
Returns:The name of the tool
Return type:string
vrdImmersiveTool.getText()
Returns:The current display text
Return type:string
vrdImmersiveTool.getUncheckedCommand()
Returns:The command executed, when the button is unchecked
Return type:string
vrdImmersiveTool.getViewContent()
Returns:The content that is displayed on button click
Return type:string
vrdImmersiveTool.getViewWidget()
Returns:The widget that is displayed on button click
Return type:QWidget
vrdImmersiveTool.hideAway(value)

If value is True, this tool is not visible on the VR menu.

Parameters:value (bool) –
vrdImmersiveTool.setCheckable(value)

Sets the tool button to checkable.

Parameters:value (bool) – If True, the button is checkable
vrdImmersiveTool.setChecked(value)

Sets the tool button to checked.

Parameters:value (bool) – If True, the button is checked
vrdImmersiveTool.setCheckedCommand(value)

Sets the Python command that is executed when the button is checked.

Parameters:value (string) – Python command string
vrdImmersiveTool.setClickedCommand(value)

Sets the Python command that is executed on button click.

Parameters:value (string) – Python command string
vrdImmersiveTool.setGroup(value)

Changes the group in which the tool is inserted.

Parameters:value (string) – Group name
vrdImmersiveTool.setIcon(icon)

Sets the icon displayed on the VR tools menu.

Parameters:icon (QIcon) – New icon
vrdImmersiveTool.setIconData(data, format='png')

Use a base64 encoded string to set the icon.

Parameters:
  • data (string) – base64 encoded image data
  • format (string) – Image format. Default is png
vrdImmersiveTool.setIconPath(iconPath)

Use the image at the given path as an icon.

Parameters:iconPath (string) – File path to an image
vrdImmersiveTool.setOnOffIconData(onData, offData, format='png')

Use two base64 encoded strings to set the icon.

Parameters:
  • onData (string) – base64 encoded image data for checked state
  • offData (string) – base64 encoded image data for unchecked state
  • format (string) – Image format. Default is png
vrdImmersiveTool.setText(text)

Changes the text displayed on the VR tools menu.

Parameters:text (string) – Text to display
vrdImmersiveTool.setUncheckedCommand(value)

Sets the Python command that is executed when the button is unchecked.

Parameters:value (string) – Python command string
vrdImmersiveTool.setViewContent(value)

On tool button press, the given content is displayed on a menu panel.

Parameters:value (string) – Url or module title
vrdImmersiveTool.setViewWidget(widget)

On tool button press, the given content is displayed on a menu panel.

Parameters:widget (QWidget) – Reference to a QWidget object
vrdImmersiveTool.signal()
Returns:Access to tool signals
Return type:Q_SLOTvrdImmersiveToolSignal