Click or drag to resize

TooltipBase Class

Encapsulates most of the tooltip functionality
Inheritance Hierarchy
SystemObject
  UnityEngine.Object
    UnityEngine.Component
      UnityEngine.Behaviour
        UnityEngine.MonoBehaviour
          ImmerseSDK.UITooltipBase
            ImmerseSDK.UITooltip

Namespace:  ImmerseSDK.UI
Assembly:  ImmerseSDK.App (in ImmerseSDK.App.dll) Version: 3.5.0.0 (3.5.0.0)
Syntax
C#
public class TooltipBase : UnityEngine.MonoBehaviour

The TooltipBase type exposes the following members.

Constructors
  NameDescription
Private methodStatic memberTooltipBase
Public methodTooltipBase
Initializes a new instance of the TooltipBase class
Top
Properties
  NameDescription
Protected propertyCameraService
Cached CameraService instance
Public propertyIsEnabled
Default visibility for this tooltip
Protected propertyIsInitialised
Flag that indicates whether UI is ready to be updated
Protected propertyIsVisibleInCurrentCamera
Returns true if the tooltip is visible in the current camera
Protected propertyLastAppliedScale
The last applied scale
Protected propertyOriginalLocalLocation
The original local position that was applied to this object's transform
Protected propertyOriginalLocalScale
The original scale that was applied to this object's transform
Public propertyPivot
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.
Public propertyReverseFace
Should the transform be rotated 180 degrees after applying the camera's lookat vector?
Protected propertyRoot
The root object that has the Canvas and CanvasGroup on
Protected propertyRootTransform
The RectTransform of the root object
Public propertyVerboseLoggingInEditor
Returns true if verbose logging is toggled to on, and we are currently running in the Editor
Public propertyWebGLHideInNonVrCamera
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
Top
Methods
  NameDescription
Protected methodAwake
Unity Component method
Protected methodCalculateScale
Called once per frame to calculate the scale value. Use this method to determine visibility as well.
Protected methodGetCamera
Gets the camera that's currently being used to render the tooltip
Protected methodLateUpdate
Unity Component method
Public methodSetEnabled
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.
Protected methodShowRoot
Show/hide the root
Protected methodStart
Unity Component method
Public methodUpdateOriginalScaleAndPosition
Update original scale and position
Protected methodUpdateTooltip
Update the tooltip by calculating distance from camera and scale etc
Public methodUpdateUI
Initialise the tooltip with specified information
Protected methodUpdateVisibility
Make the tooltip visible, or hide it
Protected methodUpdateVisibility(Single)
Top
Fields
  NameDescription
Private field_hideWithNoAnimationInEditor
EDITOR ONLY: Hide with no animate
Private field_icon
The icon to display
Private field_iconArea
Enabled if there is an Icon
Private field_iconText
The text to display
Private field_noIconArea
Enabled if there is no Icon
Private field_noIconText
The text to display
Private field_reverseFace
Should the canvas be rotated 180 degrees in the Y axis?
Private field_root
Where we can find the canvas object
Private field_tintImages
List of images we want to tint
Private field_verboseLoggingInEditor
EDITOR ONLY: do verbose logging for this object
Protected fieldStatic memberEpsilonVector
Equal to Vector3.one * Mathf.Epsilon
Public fieldStatic memberMinLookAtUpdateDistanceInMetersAABB
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.
Top
Extension Methods
  NameDescription
Public Extension MethodGetCopyOf
Copies all properties of a component from source to target. Uses reflection to set properties.
(Defined by ComponentExtensions.)
Public Extension MethodWaitForT
Waits for a singleton on a coroutine
(Defined by SingletonManager.)
Top
See Also