1
0
mirror of https://github.com/ppy/osu.git synced 2024-12-18 08:02:54 +08:00
osu-lazer/osu.Game/Screens/Menu/MainMenuButton.cs

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

411 lines
14 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 17:19:50 +08:00
2016-12-06 17:56:20 +08:00
using System;
using System.Linq;
using osu.Framework;
2016-12-05 20:09:41 +08:00
using osu.Framework.Allocation;
using osu.Framework.Audio;
using osu.Framework.Audio.Sample;
2020-06-23 12:49:18 +08:00
using osu.Framework.Audio.Track;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Shapes;
using osu.Game.Graphics.Sprites;
2018-11-20 15:51:59 +08:00
using osuTK;
using osuTK.Graphics;
using osuTK.Input;
using osu.Framework.Extensions.Color4Extensions;
using osu.Game.Graphics.Containers;
2019-04-02 13:51:28 +08:00
using osu.Framework.Graphics.Effects;
using osu.Framework.Graphics.Sprites;
2018-10-02 11:02:47 +08:00
using osu.Framework.Input.Events;
2021-04-20 16:06:26 +08:00
using osu.Framework.Localisation;
using osu.Game.Beatmaps.ControlPoints;
2018-04-13 17:19:50 +08:00
2016-11-14 16:23:33 +08:00
namespace osu.Game.Screens.Menu
{
/// <summary>
/// Button designed specifically for the osu!next main menu.
/// In order to correctly flow, we have to use a negative margin on the parent container (due to the parallelogram shape).
/// </summary>
public partial class MainMenuButton : BeatSyncedContainer, IStateful<ButtonState>
{
public const float BOUNCE_COMPRESSION = 0.9f;
public const float HOVER_SCALE = 1.2f;
public const float BOUNCE_ROTATION = 8;
2023-11-24 10:05:57 +08:00
public event Action<ButtonState>? StateChanged;
2018-04-13 17:19:50 +08:00
public readonly Key[] TriggerKeys;
protected override Container<Drawable> Content => content;
private readonly Container content;
/// <summary>
/// The menu state for which we are visible for (assuming only one).
/// </summary>
public ButtonSystemState VisibleState
{
set
{
VisibleStateMin = value;
VisibleStateMax = value;
}
}
public ButtonSystemState VisibleStateMin = ButtonSystemState.TopLevel;
public ButtonSystemState VisibleStateMax = ButtonSystemState.TopLevel;
public new MarginPadding Padding
{
get => Content.Padding;
set => Content.Padding = value;
}
protected Vector2 BaseSize { get; init; } = new Vector2(ButtonSystem.BUTTON_WIDTH, ButtonArea.BUTTON_AREA_HEIGHT);
private readonly Action<MainMenuButton>? clickAction;
private readonly Container background;
private readonly Drawable backgroundContent;
private readonly Box boxHoverLayer;
private readonly SpriteIcon icon;
private Vector2 initialSize => BaseSize + Padding.Total;
private readonly string sampleName;
2023-11-24 10:05:57 +08:00
private Sample? sampleClick;
private Sample? sampleHover;
private SampleChannel? sampleChannel;
2018-04-13 17:19:50 +08:00
public override bool IsPresent => base.IsPresent
// Allow keyboard interaction based on state rather than waiting for delayed animations.
|| state == ButtonState.Expanded;
public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => background.ReceivePositionalInputAt(screenSpacePos);
2018-04-13 17:19:50 +08:00
public MainMenuButton(LocalisableString text, string sampleName, IconUsage symbol, Color4 colour, Action<MainMenuButton>? clickAction = null, params Key[] triggerKeys)
{
this.sampleName = sampleName;
this.clickAction = clickAction;
TriggerKeys = triggerKeys;
2018-04-13 17:19:50 +08:00
2016-10-22 16:50:42 +08:00
AutoSizeAxes = Axes.Both;
Alpha = 0;
2018-04-13 17:19:50 +08:00
AddRangeInternal(new Drawable[]
{
background = new Container
{
2019-04-05 17:21:54 +08:00
// box needs to be always present to ensure the button is always sized correctly for flow
AlwaysPresent = true,
2016-11-30 13:38:45 +08:00
Masking = true,
MaskingSmoothness = 2,
2017-06-12 11:48:47 +08:00
EdgeEffect = new EdgeEffectParameters
2016-11-30 13:38:45 +08:00
{
Type = EdgeEffectType.Shadow,
2017-01-11 02:44:40 +08:00
Colour = Color4.Black.Opacity(0.2f),
2016-11-30 13:38:45 +08:00
Roundness = 5,
Radius = 8,
},
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
2017-06-07 19:53:37 +08:00
Children = new[]
2016-11-30 13:38:45 +08:00
{
backgroundContent = CreateBackground(colour).With(bg =>
{
bg.RelativeSizeAxes = Axes.Y;
bg.Anchor = Anchor.Centre;
bg.Origin = Anchor.Centre;
}),
boxHoverLayer = new Box
2016-11-30 13:38:45 +08:00
{
EdgeSmoothness = new Vector2(1.5f, 0),
2016-11-30 13:38:45 +08:00
RelativeSizeAxes = Axes.Both,
2019-08-21 12:29:50 +08:00
Blending = BlendingParameters.Additive,
Colour = Color4.White,
Depth = float.MinValue,
Alpha = 0,
2016-11-30 13:38:45 +08:00
},
}
},
content = new Container
{
RelativeSizeAxes = Axes.Both,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
Children = new Drawable[]
{
new OsuSpriteText
{
Shadow = true,
AllowMultiline = false,
Anchor = Anchor.BottomCentre,
Origin = Anchor.BottomCentre,
Margin = new MarginPadding
{
Left = -3,
Bottom = 7,
},
Text = text
},
icon = new SpriteIcon
{
Shadow = true,
Anchor = Anchor.Centre,
Origin = Anchor.Centre,
2023-12-29 07:15:23 +08:00
Size = new Vector2(32),
Position = new Vector2(0, 0),
Margin = new MarginPadding { Top = -4 },
Icon = symbol
}
}
}
});
}
protected virtual Drawable CreateBackground(Colour4 accentColour) => new Container
{
Child = new Box
{
EdgeSmoothness = new Vector2(1.5f, 0),
RelativeSizeAxes = Axes.Both,
Colour = accentColour,
}
};
protected override void LoadComplete()
{
base.LoadComplete();
background.Shear = new Vector2(ButtonSystem.WEDGE_WIDTH / initialSize.Y, 0);
// for whatever reason, attempting to size the background "just in time" to cover the visible width
// results in gaps when the width changes are quick (only visible when testing menu at 100% speed, not visible slowed down).
// to ensure there's no missing backdrop, just use a ballpark that should be enough to always cover the width and then some.
// note that while on a code inspections it would seem that `1.5 * initialSize.X` would be enough, elastic usings are used in this button
// (which can exceed the [0;1] range during interpolation).
backgroundContent.Width = 2 * initialSize.X;
backgroundContent.Shear = -background.Shear;
animateState();
FinishTransforms(true);
}
2018-04-13 17:19:50 +08:00
private bool rightward;
2018-04-13 17:19:50 +08:00
2020-06-23 12:49:18 +08:00
protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, ChannelAmplitudes amplitudes)
{
base.OnNewBeat(beatIndex, timingPoint, effectPoint, amplitudes);
2018-04-13 17:19:50 +08:00
if (!IsHovered) return;
2018-04-13 17:19:50 +08:00
double duration = timingPoint.BeatLength / 2;
2018-04-13 17:19:50 +08:00
icon.RotateTo(rightward ? BOUNCE_ROTATION : -BOUNCE_ROTATION, duration * 2, Easing.InOutSine);
2018-04-13 17:19:50 +08:00
icon.Animate(
2017-07-23 02:50:25 +08:00
i => i.MoveToY(-10, duration, Easing.Out),
i => i.ScaleTo(HOVER_SCALE, duration, Easing.Out)
).Then(
2017-07-23 02:50:25 +08:00
i => i.MoveToY(0, duration, Easing.In),
i => i.ScaleTo(new Vector2(HOVER_SCALE, HOVER_SCALE * BOUNCE_COMPRESSION), duration, Easing.In)
);
2018-04-13 17:19:50 +08:00
rightward = !rightward;
}
2018-04-13 17:19:50 +08:00
2018-10-02 11:02:47 +08:00
protected override bool OnHover(HoverEvent e)
{
if (State != ButtonState.Expanded) return true;
2018-04-13 17:19:50 +08:00
double duration = TimeUntilNextBeat;
2018-04-13 17:19:50 +08:00
icon.ClearTransforms();
icon.RotateTo(rightward ? -BOUNCE_ROTATION : BOUNCE_ROTATION, duration, Easing.InOutSine);
icon.ScaleTo(new Vector2(HOVER_SCALE, HOVER_SCALE * BOUNCE_COMPRESSION), duration, Easing.Out);
sampleHover?.Play();
background.ResizeTo(Vector2.Multiply(initialSize, new Vector2(1.5f, 1)), 500, Easing.OutElastic);
return true;
}
2018-04-13 17:19:50 +08:00
2018-10-02 11:02:47 +08:00
protected override void OnHoverLost(HoverLostEvent e)
{
2017-02-25 20:12:39 +08:00
icon.ClearTransforms();
2017-07-23 02:50:25 +08:00
icon.RotateTo(0, 500, Easing.Out);
icon.MoveTo(Vector2.Zero, 500, Easing.Out);
2017-07-23 02:50:25 +08:00
icon.ScaleTo(Vector2.One, 200, Easing.Out);
2018-04-13 17:19:50 +08:00
if (State == ButtonState.Expanded)
background.ResizeTo(initialSize, 500, Easing.OutElastic);
}
2018-04-13 17:19:50 +08:00
2016-12-05 20:09:41 +08:00
[BackgroundDependencyLoader]
2018-08-31 06:04:40 +08:00
private void load(AudioManager audio)
2016-12-05 20:09:41 +08:00
{
sampleHover = audio.Samples.Get(@"Menu/button-hover");
sampleClick = audio.Samples.Get(!string.IsNullOrEmpty(sampleName) ? $@"Menu/{sampleName}" : @"UI/button-select");
2016-12-05 20:09:41 +08:00
}
2018-04-13 17:19:50 +08:00
2018-10-02 11:02:47 +08:00
protected override bool OnMouseDown(MouseDownEvent e)
{
2017-07-23 02:50:25 +08:00
boxHoverLayer.FadeTo(0.1f, 1000, Easing.OutQuint);
2018-10-02 11:02:47 +08:00
return base.OnMouseDown(e);
}
2018-04-13 17:19:50 +08:00
protected override void OnMouseUp(MouseUpEvent e)
{
2017-07-23 02:50:25 +08:00
boxHoverLayer.FadeTo(0, 1000, Easing.OutQuint);
base.OnMouseUp(e);
}
2018-04-13 17:19:50 +08:00
2018-10-02 11:02:47 +08:00
protected override bool OnClick(ClickEvent e)
{
trigger();
return true;
}
2018-04-13 17:19:50 +08:00
2018-10-02 11:02:47 +08:00
protected override bool OnKeyDown(KeyDownEvent e)
{
if (e.Repeat || e.ControlPressed || e.ShiftPressed || e.AltPressed || e.SuperPressed)
return false;
2018-04-13 17:19:50 +08:00
if (TriggerKeys.Contains(e.Key))
{
trigger();
return true;
}
2018-04-13 17:19:50 +08:00
return false;
}
2018-04-13 17:19:50 +08:00
private void trigger()
{
sampleChannel = sampleClick?.GetChannel();
sampleChannel?.Play();
2018-04-13 17:19:50 +08:00
clickAction?.Invoke(this);
2018-04-13 17:19:50 +08:00
2017-02-25 20:12:39 +08:00
boxHoverLayer.ClearTransforms();
boxHoverLayer.Alpha = 0.9f;
2017-07-23 02:50:25 +08:00
boxHoverLayer.FadeOut(800, Easing.OutExpo);
}
2018-04-13 17:19:50 +08:00
public override bool HandleNonPositionalInput => state == ButtonState.Expanded;
public override bool HandlePositionalInput => state != ButtonState.Exploded && background.Width / initialSize.X >= 0.8f;
2018-04-13 17:19:50 +08:00
public void StopSamplePlayback() => sampleChannel?.Stop();
protected override void Update()
{
content.Alpha = Math.Clamp((background.Width / initialSize.X - 0.5f) / 0.3f, 0, 1);
base.Update();
}
2018-04-13 17:19:50 +08:00
public int ContractStyle;
2018-04-13 17:19:50 +08:00
2017-03-07 09:59:19 +08:00
private ButtonState state;
2018-04-13 17:19:50 +08:00
public ButtonState State
{
get => state;
2018-04-13 17:19:50 +08:00
2017-06-07 19:53:37 +08:00
set
{
if (state == value)
return;
2018-04-13 17:19:50 +08:00
state = value;
2018-04-13 17:19:50 +08:00
animateState();
StateChanged?.Invoke(State);
}
}
private void animateState()
{
switch (state)
{
case ButtonState.Contracted:
switch (ContractStyle)
{
default:
background.ResizeTo(Vector2.Multiply(initialSize, new Vector2(0, 1)), 500, Easing.OutExpo);
this.FadeOut(500);
break;
case 1:
background.ResizeTo(Vector2.Multiply(initialSize, new Vector2(0, 1)), 400, Easing.InSine);
this.FadeOut(800);
break;
}
2019-04-01 11:44:46 +08:00
break;
2019-04-01 11:44:46 +08:00
case ButtonState.Expanded:
const int expand_duration = 500;
background.ResizeTo(initialSize, expand_duration, Easing.OutExpo);
this.FadeIn(expand_duration / 6f);
break;
2018-04-13 17:19:50 +08:00
case ButtonState.Exploded:
const int explode_duration = 200;
background.ResizeTo(Vector2.Multiply(initialSize, new Vector2(2, 1)), explode_duration, Easing.OutExpo);
this.FadeOut(explode_duration / 4f * 3);
break;
}
}
private ButtonSystemState buttonSystemState;
public ButtonSystemState ButtonSystemState
{
get => buttonSystemState;
set
{
if (buttonSystemState == value)
return;
buttonSystemState = value;
UpdateState();
}
}
2019-04-01 11:44:46 +08:00
protected virtual void UpdateState()
{
ContractStyle = 0;
2019-04-01 11:44:46 +08:00
switch (ButtonSystemState)
{
case ButtonSystemState.Initial:
State = ButtonState.Contracted;
break;
case ButtonSystemState.EnteringMode:
ContractStyle = 1;
State = ButtonState.Contracted;
break;
default:
if (ButtonSystemState <= VisibleStateMax && ButtonSystemState >= VisibleStateMin)
State = ButtonState.Expanded;
else if (ButtonSystemState < VisibleStateMin)
State = ButtonState.Contracted;
else
State = ButtonState.Exploded;
break;
}
}
}
2018-04-13 17:19:50 +08:00
public enum ButtonState
{
Contracted,
Expanded,
Exploded
}
}