Controller Tooltips

Overview

This adds a collection of Object Tooltips to the Controller that give information on what the main controller buttons may do. To add the prefab, it just needs to be added as a child of the relevant controller e.g. [CameraRig]/Controller (right) would add the controller tooltips to the right controller.

If the transforms for the buttons are not provided, then the script will attempt to find the attach transforms on the default controller model in the [CameraRig] prefab.
If no text is provided for one of the elements then the tooltip for that element will be set to disabled.
There are a number of parameters that can be set on the Prefab which are provided by the VRTK/Scripts/VRTK_ControllerTooltips script which is applied to the prefab.

Inspector Parameters

Trigger Text: The text to display for the trigger button action.
Grip Text: The text to display for the grip button action.
Touchpad Text: The text to display for the touchpad action.
App Menu Text: The text to display for the application menu button action.
Tip Background Color: The colour to use for the tooltip background container.
Tip Text Color: The colour to use for the text within the tooltip.
Tip Line Color: The colour to use for the line between the tooltip and the relevant controller button.
Trigger: The transform for the position of the trigger button on the controller (this is usually found in Model/trigger/attach.
Grip: The transform for the position of the grip button on the controller (this is usually found in Model/lgrip/attach.
Touchpad: The transform for the position of the touchpad button on the controller (this is usually found in Model/trackpad/attach.
App Menu: The transform for the position of the app menu button on the controller (this is usually found in Model/button/attach.

Class Methods

ToggleTips/2

public void ToggleTips(bool state, TooltipButtons element = TooltipButtons.None)

Parameters
bool state - The state of whether to display or hide the controller tooltips, true will display and false will hide.
TooltipButtons element - The specific element to hide the tooltip on, if it is TooltipButtons.None then it will hide all tooltips. Optional parameter defaults to TooltipButtons.None
Returns
none

The ToggleTips method will display the controller tooltips if the state is true and will hide the controller tooltips if the state is false. An optional element can be passed to target a specific controller tooltip to toggle otherwise all tooltips are toggled.

Example

VRTK/Examples/029_Controller_Tooltips displays two cubes that have an object tooltip added to them along with tooltips that have been added to the controllers.