Immerse

Description

Sometimes a user's attention needs to be drawn to a specific location in an environment, or interactable objects need to be clearly highlighted in a scene. For these cases, the Immerse SDK includes Tooltips functionality.

How it works

By placing a POI Tooltip Spawn script on an object near to the area of interest, a floating tooltip will appear that always faces the user and scales with distance.

The tooltip will not be visible if the user is very far away (this distance can be set via its properties). As the user gets closer, the tooltip goes through various visual states until fully visible (see below).

📘

Avatar Tooltips

The Immerse SDK also uses tooltips to display the names of VR users in the current session, which appear above avatar's heads. This can be enabled by editing the Scene object and checking the Avatar Tooltips property.

Close-up of a tooltip floating above a rotating cube.

The same tooltip, slightly further away.

The size has changed, so it is still readable at a distance.

The same tooltip, even further away.

The tooltip has minimised into an arrow, pointing towards the area of interest.

The same tooltip, but very far away

The arrow has now disappeared.

Tooltips can also be localised - instead of plain text, a named text key can be specified.

How to implement

  1. Create a new GameObject
  • Position this object close, slightly above the location of interest.
  • Add a POITooltipSpawn component.
  • Enter the tooltip text in the provided field. This field allows localisation, so a Named Text Key can be used if necessary.

Unity editor component

PropertyDescription
Tooltip Text
Text to be displayed. This supports localisation too, so a Named Text key can be used.
TintColor to tint the images with
Start EnabledDetermines whether a tooltip should be disabled (hidden) on start.
Max Distance In MetersMaximum total distance in metres. At a distance greater than this, the arrow and the tooltip will both be hidden.

At distance between Max Distance In Meters and Max Distance In Meters, the arrow is displayed. At distance less than Max Distance In Meters for Tooltip the tooltip is displayed and the arrow hidden.

This value should always be larger than Max Distance In Meters for Tooltip.
Max Distance In Meters for TooltipMaximum distance in meters before showing the tooltip and hiding the arrow.

At distance between Max Distance In Meters and Max Distance In Meters, the arrow is displayed. At distance less than Max Distance In Meters for Tooltip the tooltip is displayed and the arrow hidden.

This value should always be less than Max Distance In Meters.
Auto hide interval in secondsNumber of seconds to wait before hiding the tooltip automatically after it was shown.

Set to 0 (Default) which disables this feature.
No Interaction period for showNumber of seconds with no interactions to trigger the display of the tooltip. The user would need to be close enough to see the tooltip as well.

Set to 0 (Default) which disables this feature.
Number of times to show tooltipNumber of times to show the tooltip.

Set to 0 (Default) which disables this feature.
PivotPivot to use for the tooltip. Set this to the TransformSync if the tooltip relates to a pickup that can be moved. If none is supplied, the tooltip will use the GameObject that this component is on, to position itself in the world.

📘

Read more

POITooltipSpawn class

Unity iconTry out this component in the Examples project

Examples (menu) > UI > Load Tooltips Example

Learn more about the Examples project

Updated 4 months ago


Tooltips


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.