ToolTip Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Class for Tooltip object Creates a floating tooltip that is attached to an object and moves to stay in view as object rotates with respect to the view.
public ref class ToolTip : UnityEngine::MonoBehaviour[UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ToolTip")]
[UnityEngine.ExecuteAlways]
[UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/ux-building-blocks/tooltip")]
public class ToolTip : UnityEngine.MonoBehaviour[<UnityEngine.AddComponentMenu("Scripts/MRTK/SDK/ToolTip")>]
[<UnityEngine.ExecuteAlways>]
[<UnityEngine.HelpURL("https://docs.microsoft.com/windows/mixed-reality/mrtk-unity/features/ux-building-blocks/tooltip")>]
type ToolTip = class
inherit MonoBehaviourPublic Class ToolTip
Inherits MonoBehaviour- Inheritance
-
UnityEngine.MonoBehaviourToolTip
- Derived
- Attributes
-
UnityEngine.AddComponentMenuAttribute UnityEngine.ExecuteAlwaysAttribute UnityEngine.HelpURLAttribute
Constructors
| ToolTip() |
Properties
| Anchor |
getter/setter for ameObject that the line and text are attached to |
| AnchorPosition |
point where ToolTip connector is attached |
| AttachPointPosition |
point where ToolTip is attached |
| ContentParentTransform |
Transform of object to which ToolTip is attached |
| ContentScale |
The scale of all the content (label, backgrounds, etc.) |
| FontSize |
The font size of the tooltip. |
| GroupTipState |
Display the state of a group of tooltips. |
| HasFocus |
does the ToolTip have focus. |
| IsOn |
is ToolTip active and displaying |
| LocalContentOffset |
The offset of the background (x / y / z) |
| LocalContentSize |
getter/setter for size of tooltip. |
| MasterTipState |
Display the state of the master tooltip. |
| Pivot |
Pivot point that text will rotate around as well as the point where the Line will be rendered to. |
| PivotPosition |
point about which ToolTip pivots to face camera |
| PivotType | |
| ShowBackground |
Show the opaque background of tooltip. |
| ShowConnector |
Show the connecting stem between the tooltip and its parent GameObject. |
| ShowHighlight |
Shows white trim around edge of tooltip. |
| TipState |
The display the state of the tooltip. |
| ToolTipText |
Text for the ToolTip to display |
Methods
| EnforceHierarchy() | |
| GetTextMeshLocalScale(TextMesh) | |
| OnEnable() |
virtual functions |
| RefreshLocalContent() | |
| ResolveTipState(DisplayMode, DisplayMode, DisplayMode, Boolean) | |
| Update() | |