![]() | Tooltip Class |
Namespace: ImmerseSDK.UI
public class Tooltip : TooltipBase
The Tooltip type exposes the following members.
Name | Description | |
---|---|---|
![]() | ArrowRectTransform |
Transform of the Arrow object so we can move the canvas slightly when we scale up and down to keep it pointing at the correct location
|
![]() | AutoHideIntervalInSeconds |
Number of seconds to wait before hiding the tooltip automatically
|
![]() | HideAnimationTriggerParameterName |
The trigger's name that will play the HIDE animation on the Animator
|
![]() | MaxDistanceTooltipInMetersForScale |
Maximum total distance in meters. This should be larger than MaxDistanceTooltipInMetersForScale.
At distance > MaxDistanceTooltipInMetersForScale and distance < MaxDistanceTotalInMetersForScale, the arrow is displayed
At distance < MaxDistanceTooltipInMetersForScale the tooltip is displayed and the arrow hidden
|
![]() | MaxDistanceTotalInMetersForScale |
Maximum total distance in meters. This should be larger than MaxDistanceTooltipInMetersForScale.
At distance > MaxDistanceTooltipInMetersForScale and distance < MaxDistanceTotalInMetersForScale, the arrow is displayed
At distance < MaxDistanceTooltipInMetersForScale the tooltip is displayed and the arrow hidden
|
![]() | MinDistanceInMetersForScale |
Minimum distance in meters used to scale tooltip. Anything closer than this means the tooltip does not scale anymore and stays constant size.
|
![]() | NoInteractionPeriodForShow |
Number of seconds with no interactions to trigger the display of the tooltip
|
![]() | NumberOfTimesToShow |
Number of times to show the tooltip. Set to 0 (Default) which disables this feature
|
![]() | ShouldScaleWithDistance |
Should this tooltip scale up the further away the player gets from it?
|
![]() | ShowArrowAnimationTriggerParameterName |
The trigger's name that will play the SHOW arrow animation on the Animator
|
![]() | ShowHideAnimator |
Animator to use when showing/hiding the tooltip
|
![]() | ShowTooltipAnimationTriggerParameterName |
The trigger's name that will play the SHOW tooltip animation on the Animator
|
![]() | SizeScalarAtMaxDistance |
The amount to scale the size by at maximum distance. The tooltip's size is an interpolation
between this and the size at minimum distance.
|
Name | Description | |
---|---|---|
![]() | Awake |
Unity Component method
(Overrides TooltipBaseAwake.) |
![]() | CalculateScale |
Called once per frame to calculate the scale value. Use this method to determine visibility as well.
(Overrides TooltipBaseCalculateScale(Single).) |
![]() | OnDataUpdated |
Recalculate variables and update scale and visibility
|
![]() | OnDisable | |
![]() | OnEnable | |
![]() | ResetVariables |
Reset internal state variables, like how long we have been waiting for a timeout, etc
|
![]() | SetVisibility | |
![]() | Start |
Unity Component method
(Overrides TooltipBaseStart.) |
![]() | UpdateTooltip |
Update the tooltip by calculating distance from camera and scale etc
(Overrides TooltipBaseUpdateTooltip.) |
![]() | UpdateVisibility |
Make the tooltip visible, or hide it
(Overrides TooltipBaseUpdateVisibility.) |
![]() | UpdateVisibility(Single) | (Overrides TooltipBaseUpdateVisibility(Single).) |
Name | Description | |
---|---|---|
![]() | GetCopyOf |
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.) |
![]() | WaitForT |
Waits for a singleton on a coroutine
(Defined by SingletonManager.) |