Class ToolTip
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.
Assembly: cs.temp.dll.dll
public class ToolTip : MonoBehaviour
Properties
getter/setter for ameObject that the line and text are attached to
Declaration
public GameObject Anchor { get; set; }
Property Value
| Type |
Description |
| GameObject |
|
point where ToolTip connector is attached
Declaration
public Vector3 AnchorPosition { get; set; }
Property Value
point where ToolTip is attached
Declaration
public Vector3 AttachPointPosition { get; set; }
Property Value
ContentParentTransform
Transform of object to which ToolTip is attached
Declaration
public Transform ContentParentTransform { get; }
Property Value
| Type |
Description |
| Transform |
|
ContentScale
The scale of all the content (label, backgrounds, etc.)
Declaration
public float ContentScale { get; set; }
Property Value
The font size of the tooltip.
Declaration
public int FontSize { get; set; }
Property Value
Display the state of a group of tooltips.
Declaration
public DisplayMode GroupTipState { get; set; }
Property Value
does the ToolTip have focus.
Declaration
public virtual bool HasFocus { get; }
Property Value
is ToolTip active and displaying
Declaration
public bool IsOn { get; }
Property Value
LocalContentOffset
The offset of the background (x / y / z)
Declaration
public Vector3 LocalContentOffset { get; }
Property Value
LocalContentSize
getter/setter for size of tooltip.
Declaration
public Vector2 LocalContentSize { get; }
Property Value
Display the state of the master tooltip.
Declaration
public DisplayMode MasterTipState { get; set; }
Property Value
Pivot point that text will rotate around as well as the point where the Line will be rendered to.
Declaration
public GameObject Pivot { get; }
Property Value
| Type |
Description |
| GameObject |
|
point about which ToolTip pivots to face camera
Declaration
public Vector3 PivotPosition { get; set; }
Property Value
Declaration
public ToolTipAttachPoint PivotType { get; set; }
Property Value
Show the opaque background of tooltip.
Declaration
public bool ShowBackground { get; set; }
Property Value
Show the connecting stem between the tooltip and its parent GameObject.
Declaration
public bool ShowConnector { get; set; }
Property Value
Shows white trim around edge of tooltip.
Declaration
public bool ShowHighlight { get; set; }
Property Value
The display the state of the tooltip.
Declaration
public DisplayMode TipState { get; set; }
Property Value
ToolTipText
Text for the ToolTip to display
Declaration
public string ToolTipText { get; set; }
Property Value
Methods
Declaration
protected virtual bool EnforceHierarchy()
Returns
GetTextMeshLocalScale(TextMesh)
Declaration
public static Vector3 GetTextMeshLocalScale(TextMesh textMesh)
Parameters
| Type |
Name |
Description |
| TextMesh |
textMesh |
|
Returns
Declaration
protected virtual void OnEnable()
RefreshLocalContent()
Declaration
protected virtual void RefreshLocalContent()
Declaration
public static bool ResolveTipState(DisplayMode masterTipState, DisplayMode groupTipState, DisplayMode tipState, bool hasFocus)
Parameters
Returns
Declaration
protected virtual void Update()