 | TooltipBase Class |
Encapsulates most of the tooltip functionality
Inheritance HierarchySystemObject
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.UITooltipBase
ImmerseSDK.UITooltip
UnityEngine.Object
UnityEngine.Component
UnityEngine.Behaviour
UnityEngine.MonoBehaviour
ImmerseSDK.UITooltipBase
ImmerseSDK.UITooltip
Namespace: ImmerseSDK.UI
Assembly: ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.9.0.0 (3.9.0.0)
SyntaxC#
[HelpURLAttribute("https://immerse.readme.io/")] public class TooltipBase : UnityEngine.MonoBehaviour
The TooltipBase type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
  | TooltipBase | |
 | TooltipBase | Initializes a new instance of the TooltipBase class |
Properties| Name | Description | |
|---|---|---|
 | CameraService |
Cached CameraService instance
|
 | IsEnabled |
Default visibility for this tooltip
|
| IsInitialised |
Flag that indicates whether UI is ready to be updated
|
| IsVisibleInCurrentCamera |
Returns true if the tooltip is visible in the current camera
|
| LastAppliedScale |
The last applied scale
|
| OriginalLocalLocation |
The original local position that was applied to this object's transform
|
| OriginalLocalScale |
The original scale that was applied to this object's transform
|
| Pivot |
Set a pivot for the tooltip to track. This will cause it to stay orientated to the pivot in the way it started even if the pivot is rotated.
|
| ReverseFace |
Should the transform be rotated 180 degrees after applying the camera's lookat vector?
|
| Root |
The root object that has the Canvas and CanvasGroup on
|
| RootTransform |
The RectTransform of the root object
|
| VerboseLoggingInEditor |
Returns true if verbose logging is toggled to on, and we are currently running in the Editor
|
| WebGLHideInNonVrCamera |
If set to true, the tooltip is not visible in the normal non-VR cameras.
If set to false, the tooltip will be visible in all the cameras.
Note: this only affect WebGL platform
|
Methods| Name | Description | |
|---|---|---|
 | Awake |
Unity Component method
|
| CalculateScale |
Called once per frame to calculate the scale value. Use this method to determine visibility as well.
|
| GetCamera |
Gets the camera that's currently being used to render the tooltip
|
| LateUpdate |
Unity Component method
|
| SetEnabled |
Set the default visibility. If the tooltip is enabled, depending on specialisations, the tooltip can still be
hidden based on those requirements (like distance for instance).
If the tooltip is disabled, it will always stay hidden.
|
| ShowRoot |
Show/hide the root
|
| Start |
Unity Component method
|
| UpdateOriginalScaleAndPosition |
Update original scale and position
|
| UpdateTooltip |
Update the tooltip by calculating distance from camera and scale etc
|
| UpdateUI |
Initialise the tooltip with specified information
|
| UpdateVisibility |
Make the tooltip visible, or hide it
|
| UpdateVisibility(Single) |
Fields| Name | Description | |
|---|---|---|
 | _hideWithNoAnimationInEditor |
EDITOR ONLY: Hide with no animate
|
| _icon |
The icon to display
|
| _iconArea |
Enabled if there is an Icon
|
| _iconText |
The text to display
|
| _noIconArea |
Enabled if there is no Icon
|
| _noIconText |
The text to display
|
| _reverseFace |
Should the canvas be rotated 180 degrees in the Y axis?
|
| _root |
Where we can find the canvas object
|
| _tintImages |
List of images we want to tint
|
| _verboseLoggingInEditor |
EDITOR ONLY: do verbose logging for this object
|
 | EpsilonVector |
Equal to Vector3.one * Mathf.Epsilon
|
 | MinLookAtUpdateDistanceInMetersAABB |
Any distance below this will not update the look-at vector for the tooltip. This prevents it from spinning around when the player is too close.
|
Extension Methods| 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.) |
See Also