Tanoda
UnityEngine.UI.Extensions.ToolTip Class Reference
Inheritance diagram for UnityEngine.UI.Extensions.ToolTip:

Public Member Functions

void Awake ()
 
void SetTooltip (string ttext, Vector3 basePos, bool refreshCanvasesBeforeGetSize=false)
 
void HideTooltip ()
 
void RefreshTooltipSize ()
 forces rebuilding of Canvases in order to update the tooltip's content size fitting. Can prevent the tooltip from being visibly misplaced for one frame when being resized. Only runs if tooltipTriggersCanForceCanvasUpdate is true More...
 
void ContextualTooltipUpdate (bool refreshCanvasesBeforeGettingSize=false)
 Runs the appropriate tooltip placement method, according to the parent canvas's render mode More...
 
void OnScreenSpaceCamera (bool refreshCanvasesBeforeGettingSize=false)
 
void OnScreenSpaceOverlay (bool refreshCanvasesBeforeGettingSize=false)
 

Public Attributes

Canvas canvas
 
bool tooltipTriggersCanForceCanvasUpdate = false
 
float YShift
 
float xShift
 
RenderMode guiMode
 

Properties

Camera GuiCamera [get]
 
static ToolTip Instance [get]
 

Detailed Description

Definition at line 27 of file ToolTip.cs.

Member Function Documentation

◆ Awake()

void UnityEngine.UI.Extensions.ToolTip.Awake ( )

Definition at line 103 of file ToolTip.cs.

◆ ContextualTooltipUpdate()

void UnityEngine.UI.Extensions.ToolTip.ContextualTooltipUpdate ( bool  refreshCanvasesBeforeGettingSize = false)

Runs the appropriate tooltip placement method, according to the parent canvas's render mode

Parameters
refreshCanvasesBeforeGettingSize

Definition at line 180 of file ToolTip.cs.

◆ HideTooltip()

void UnityEngine.UI.Extensions.ToolTip.HideTooltip ( )

Definition at line 143 of file ToolTip.cs.

◆ OnScreenSpaceCamera()

void UnityEngine.UI.Extensions.ToolTip.OnScreenSpaceCamera ( bool  refreshCanvasesBeforeGettingSize = false)

Definition at line 192 of file ToolTip.cs.

◆ OnScreenSpaceOverlay()

void UnityEngine.UI.Extensions.ToolTip.OnScreenSpaceOverlay ( bool  refreshCanvasesBeforeGettingSize = false)

Definition at line 261 of file ToolTip.cs.

◆ RefreshTooltipSize()

void UnityEngine.UI.Extensions.ToolTip.RefreshTooltipSize ( )

forces rebuilding of Canvases in order to update the tooltip's content size fitting. Can prevent the tooltip from being visibly misplaced for one frame when being resized. Only runs if tooltipTriggersCanForceCanvasUpdate is true

Definition at line 163 of file ToolTip.cs.

◆ SetTooltip()

void UnityEngine.UI.Extensions.ToolTip.SetTooltip ( string  ttext,
Vector3  basePos,
bool  refreshCanvasesBeforeGetSize = false 
)

Definition at line 125 of file ToolTip.cs.

Member Data Documentation

◆ canvas

Canvas UnityEngine.UI.Extensions.ToolTip.canvas

Definition at line 34 of file ToolTip.cs.

◆ guiMode

RenderMode UnityEngine.UI.Extensions.ToolTip.guiMode

Definition at line 53 of file ToolTip.cs.

◆ tooltipTriggersCanForceCanvasUpdate

bool UnityEngine.UI.Extensions.ToolTip.tooltipTriggersCanForceCanvasUpdate = false

Definition at line 38 of file ToolTip.cs.

◆ xShift

float UnityEngine.UI.Extensions.ToolTip.xShift

Definition at line 50 of file ToolTip.cs.

◆ YShift

float UnityEngine.UI.Extensions.ToolTip.YShift

Definition at line 50 of file ToolTip.cs.

Property Documentation

◆ GuiCamera

Camera UnityEngine.UI.Extensions.ToolTip.GuiCamera
get

Definition at line 57 of file ToolTip.cs.

◆ Instance

ToolTip UnityEngine.UI.Extensions.ToolTip.Instance
staticget

Definition at line 86 of file ToolTip.cs.


The documentation for this class was generated from the following file: