using System;
using System.Linq;
using Microsoft.Xna.Framework;
using MLEM.Ui.Style;
namespace MLEM.Ui.Elements {
///
/// A tooltip element for use inside of a .
/// A tooltip is a with a custom cursor that always follows the position of the mouse.
/// Tooltips can easily be configured to be hooked onto an element, causing them to appear when it is moused, and disappear when it is not moused anymore.
///
public class Tooltip : Panel {
///
/// The offset that this tooltip's top left corner should have from the mouse position
///
public StyleProp MouseOffset;
///
/// The amount of time that the mouse has to be over an element before it appears
///
public StyleProp Delay;
///
/// The paragraph of text that this tooltip displays
///
public Paragraph Paragraph;
private TimeSpan delayCountdown;
///
/// Creates a new tooltip with the given settings
///
/// The width of the tooltip
/// The text to display on the tooltip
/// The element that should automatically cause the tooltip to appear and disappear when hovered and not hovered, respectively
public Tooltip(float width, string text = null, Element elementToHover = null) :
base(Anchor.TopLeft, Vector2.One, Vector2.Zero) {
if (text != null)
this.Paragraph = this.AddChild(new Paragraph(Anchor.TopLeft, width, text));
this.Init(elementToHover);
}
///
/// Creates a new tooltip with the given settings
///
/// The width of the tooltip
/// The text to display on the tooltip
/// The element that should automatically cause the tooltip to appear and disappear when hovered and not hovered, respectively
public Tooltip(float width, Paragraph.TextCallback textCallback, Element elementToHover = null) :
base(Anchor.TopLeft, Vector2.One, Vector2.Zero) {
this.Paragraph = this.AddChild(new Paragraph(Anchor.TopLeft, width, textCallback));
this.Init(elementToHover);
}
///
public override void Update(GameTime time) {
base.Update(time);
this.SnapPositionToMouse();
if (this.IsHidden && this.delayCountdown > TimeSpan.Zero) {
this.delayCountdown -= time.ElapsedGameTime;
if (this.delayCountdown <= TimeSpan.Zero)
this.IsHidden = false;
}
}
///
public override void ForceUpdateArea() {
if (this.Parent != null)
throw new NotSupportedException($"A tooltip shouldn't be the child of another element ({this.Parent})");
base.ForceUpdateArea();
}
///
protected override void InitStyle(UiStyle style) {
base.InitStyle(style);
this.Texture.SetFromStyle(style.TooltipBackground);
this.MouseOffset.SetFromStyle(style.TooltipOffset);
this.Delay.SetFromStyle(style.TooltipDelay);
// we can't set from style here since it's a different element
this.Paragraph?.TextColor.Set(style.TooltipTextColor);
}
///
/// Causes this tooltip's position to be snapped to the mouse position.
///
public void SnapPositionToMouse() {
var viewport = this.System.Viewport.Size;
var offset = (this.Input.MousePosition.ToVector2() + this.MouseOffset.Value) / this.Scale;
if (offset.X < 0)
offset.X = 0;
if (offset.Y < 0)
offset.Y = 0;
if (offset.X * this.Scale + this.Area.Width >= viewport.X)
offset.X = (viewport.X - this.Area.Width) / this.Scale;
if (offset.Y * this.Scale + this.Area.Height >= viewport.Y)
offset.Y = (viewport.Y - this.Area.Height) / this.Scale;
this.PositionOffset = offset;
}
///
/// Adds this tooltip to the given and either displays it directly or starts the timer.
///
/// The system to add this tooltip to
/// The name that this tooltip should use
public void Display(UiSystem system, string name) {
system.Add(name, this);
if (this.Delay <= TimeSpan.Zero) {
this.IsHidden = false;
this.SnapPositionToMouse();
} else {
this.IsHidden = true;
this.delayCountdown = this.Delay;
}
}
///
/// Removes this tooltip from its and resets the timer, if there is one.
///
public void Remove() {
this.delayCountdown = TimeSpan.Zero;
if (this.System != null)
this.System.Remove(this.Root.Name);
}
///
/// Adds this tooltip instance to the given , making it display when it is moused over
///
/// The element that should automatically cause the tooltip to appear and disappear when hovered and not hovered, respectively
public void AddToElement(Element elementToHover) {
elementToHover.OnMouseEnter += element => {
// only display the tooltip if there is anything in it
if (this.Children.Any(c => !c.IsHidden))
this.Display(element.System, element.GetType().Name + "Tooltip");
};
elementToHover.OnMouseExit += element => this.Remove();
}
private void Init(Element elementToHover) {
if (this.Paragraph != null)
this.Paragraph.AutoAdjustWidth = true;
this.SetWidthBasedOnChildren = true;
this.SetHeightBasedOnChildren = true;
this.ChildPadding = new Vector2(2);
this.CanBeMoused = false;
if (elementToHover != null)
this.AddToElement(elementToHover);
}
}
}