osu/osu.Game/Graphics/UserInterface/OsuTabControl.cs

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

217 lines
6.7 KiB
C#
Raw Normal View History

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.
2018-04-13 09:19:50 +00:00
2022-06-17 07:37:17 +00:00
#nullable disable
2017-03-15 03:19:41 +00:00
using System;
2017-03-16 02:39:09 +00:00
using System.Linq;
2018-11-20 07:51:59 +00:00
using osuTK;
using osuTK.Graphics;
2017-03-16 00:52:31 +00:00
using osu.Framework.Allocation;
2019-02-21 10:04:31 +00:00
using osu.Framework.Bindables;
2017-03-22 23:44:52 +00:00
using osu.Framework.Extensions;
using osu.Framework.Extensions.Color4Extensions;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Shapes;
2017-03-22 23:44:52 +00:00
using osu.Framework.Graphics.Sprites;
using osu.Framework.Graphics.UserInterface;
2018-10-02 03:02:47 +00:00
using osu.Framework.Input.Events;
2021-07-17 11:40:32 +00:00
using osu.Framework.Localisation;
2020-01-09 04:43:44 +00:00
using osu.Framework.Utils;
2017-03-22 23:44:52 +00:00
using osu.Game.Graphics.Sprites;
2018-04-13 09:19:50 +00:00
2017-03-16 00:11:50 +00:00
namespace osu.Game.Graphics.UserInterface
2017-03-05 04:07:47 +00:00
{
2017-03-16 00:11:50 +00:00
public partial class OsuTabControl<T> : TabControl<T>
2017-03-05 04:07:47 +00:00
{
2020-01-26 09:57:19 +00:00
private Color4 accentColour;
2020-01-22 06:36:16 +00:00
public const float HORIZONTAL_SPACING = 10;
public virtual Color4 AccentColour
2020-01-22 06:36:16 +00:00
{
2020-01-26 09:57:19 +00:00
get => accentColour;
2020-01-24 07:31:47 +00:00
set
{
2020-01-26 09:57:19 +00:00
accentColour = value;
2020-01-24 07:31:47 +00:00
if (Dropdown is IHasAccentColour dropdown)
dropdown.AccentColour = value;
foreach (var i in TabContainer.Children.OfType<IHasAccentColour>())
i.AccentColour = value;
2020-01-24 07:31:47 +00:00
}
2020-01-22 06:36:16 +00:00
}
2018-03-29 18:29:45 +00:00
private readonly Box strip;
2018-04-13 09:19:50 +00:00
2020-02-17 20:56:35 +00:00
protected override Dropdown<T> CreateDropdown() => new OsuTabDropdown<T>();
2018-04-13 09:19:50 +00:00
2017-04-03 09:35:33 +00:00
protected override TabItem<T> CreateTabItem(T value) => new OsuTabItem(value);
2018-04-13 09:19:50 +00:00
2020-01-02 05:19:31 +00:00
protected virtual float StripWidth => TabContainer.Children.Sum(c => c.IsPresent ? c.DrawWidth + TabContainer.Spacing.X : 0) - TabContainer.Spacing.X;
2019-08-12 15:14:37 +00:00
/// <summary>
2019-11-17 12:48:23 +00:00
/// Whether entries should be automatically populated if <typeparamref name="T"/> is an <see cref="Enum"/> type.
2019-08-12 15:14:37 +00:00
/// </summary>
protected virtual bool AddEnumEntriesAutomatically => true;
2017-06-09 11:04:29 +00:00
private static bool isEnumType => typeof(T).IsEnum;
2018-04-13 09:19:50 +00:00
public OsuTabControl()
2017-03-08 09:19:00 +00:00
{
TabContainer.Spacing = new Vector2(HORIZONTAL_SPACING, 0f);
2018-04-13 09:19:50 +00:00
AddInternal(strip = new Box
2018-03-29 18:29:45 +00:00
{
Anchor = Anchor.BottomLeft,
Origin = Anchor.BottomLeft,
2020-01-03 06:35:18 +00:00
Height = 1,
2018-03-29 18:29:45 +00:00
Colour = Color4.White.Opacity(0),
});
2018-04-13 09:19:50 +00:00
2019-08-12 15:14:37 +00:00
if (isEnumType && AddEnumEntriesAutomatically)
2019-11-11 11:53:22 +00:00
{
foreach (var val in (T[])Enum.GetValues(typeof(T)))
AddItem(val);
2019-11-11 11:53:22 +00:00
}
2017-03-08 09:19:00 +00:00
}
2018-04-13 09:19:50 +00:00
2017-03-16 00:52:31 +00:00
[BackgroundDependencyLoader]
private void load(OsuColour colours)
{
2020-01-26 13:49:39 +00:00
if (accentColour == default)
2017-03-16 00:52:31 +00:00
AccentColour = colours.Blue;
}
2018-04-13 09:19:50 +00:00
2018-03-29 18:29:45 +00:00
public Color4 StripColour
{
get => strip.Colour;
set => strip.Colour = value;
}
2018-04-13 09:19:50 +00:00
2018-03-29 18:29:45 +00:00
protected override void UpdateAfterChildren()
{
base.UpdateAfterChildren();
2018-04-13 09:19:50 +00:00
2018-03-29 18:29:45 +00:00
// dont bother calculating if the strip is invisible
if (strip.Colour.MaxAlpha > 0)
2020-01-02 05:19:31 +00:00
strip.Width = Interpolation.ValueAt(Math.Clamp(Clock.ElapsedFrameTime, 0, 1000), strip.Width, StripWidth, 0, 500, Easing.OutQuint);
2018-03-29 18:29:45 +00:00
}
2018-04-13 09:19:50 +00:00
public partial class OsuTabItem : TabItem<T>, IHasAccentColour
2017-03-22 23:44:52 +00:00
{
protected readonly SpriteText Text;
protected readonly Box Bar;
2018-04-13 09:19:50 +00:00
private Color4 accentColour;
2019-02-28 04:31:40 +00:00
2017-03-22 23:44:52 +00:00
public Color4 AccentColour
{
get => accentColour;
2017-03-22 23:44:52 +00:00
set
{
accentColour = value;
2019-02-21 09:56:34 +00:00
if (!Active.Value)
Text.Colour = value;
2017-03-22 23:44:52 +00:00
}
}
2018-04-13 09:19:50 +00:00
2017-03-22 23:44:52 +00:00
private const float transition_length = 500;
2018-04-13 09:19:50 +00:00
protected void FadeHovered()
2017-03-22 23:44:52 +00:00
{
Bar.FadeIn(transition_length, Easing.OutQuint);
2017-07-22 18:50:25 +00:00
Text.FadeColour(Color4.White, transition_length, Easing.OutQuint);
2017-03-22 23:44:52 +00:00
}
2018-04-13 09:19:50 +00:00
protected void FadeUnhovered()
2017-03-22 23:44:52 +00:00
{
Bar.FadeTo(IsHovered ? 1 : 0, transition_length, Easing.OutQuint);
Text.FadeColour(IsHovered ? Color4.White : AccentColour, transition_length, Easing.OutQuint);
2017-03-22 23:44:52 +00:00
}
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
protected override bool OnHover(HoverEvent e)
2017-03-22 23:44:52 +00:00
{
2019-02-21 09:56:34 +00:00
if (!Active.Value)
FadeHovered();
2017-03-22 23:44:52 +00:00
return true;
}
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
protected override void OnHoverLost(HoverLostEvent e)
2017-03-22 23:44:52 +00:00
{
2019-02-21 09:56:34 +00:00
if (!Active.Value)
FadeUnhovered();
2017-03-22 23:44:52 +00:00
}
2018-04-13 09:19:50 +00:00
2017-03-22 23:44:52 +00:00
[BackgroundDependencyLoader]
private void load(OsuColour colours)
{
2018-10-16 02:40:51 +00:00
if (accentColour == default)
2017-03-22 23:44:52 +00:00
AccentColour = colours.Blue;
}
2018-04-13 09:19:50 +00:00
2019-02-28 04:31:40 +00:00
public OsuTabItem(T value)
: base(value)
2017-03-22 23:44:52 +00:00
{
AutoSizeAxes = Axes.X;
RelativeSizeAxes = Axes.Y;
2018-04-13 09:19:50 +00:00
LocalisableString text;
2021-07-17 13:37:58 +00:00
switch (value)
{
case IHasDescription hasDescription:
text = hasDescription.GetDescription();
break;
case Enum e:
text = e.GetLocalisableDescription();
break;
case LocalisableString l:
text = l;
break;
default:
text = value.ToString();
break;
2021-07-17 13:37:58 +00:00
}
2017-03-22 23:44:52 +00:00
Children = new Drawable[]
{
Text = new OsuSpriteText
2017-04-03 09:35:33 +00:00
{
Margin = new MarginPadding { Top = 5, Bottom = 5 },
Origin = Anchor.BottomLeft,
Anchor = Anchor.BottomLeft,
Text = text,
Font = OsuFont.GetFont(size: 14)
2017-04-03 09:35:33 +00:00
},
Bar = new Box
2017-04-03 09:35:33 +00:00
{
RelativeSizeAxes = Axes.X,
Height = 1,
Alpha = 0,
Colour = Color4.White,
Origin = Anchor.BottomLeft,
Anchor = Anchor.BottomLeft,
},
2021-06-18 08:26:28 +00:00
new HoverClickSounds(HoverSampleSet.TabSelect)
2017-03-22 23:44:52 +00:00
};
}
2018-04-13 09:19:50 +00:00
protected override void OnActivated()
{
Text.Font = Text.Font.With(weight: FontWeight.Bold);
FadeHovered();
}
2018-04-13 09:19:50 +00:00
protected override void OnDeactivated()
{
Text.Font = Text.Font.With(weight: FontWeight.Medium);
FadeUnhovered();
}
2017-03-22 23:44:52 +00:00
}
2017-03-05 04:07:47 +00:00
}
}