// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. #nullable disable using System; using osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Audio.Sample; using osu.Framework.Audio.Track; using osu.Framework.Extensions.Color4Extensions; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Framework.Graphics.Shapes; using osu.Framework.Graphics.Sprites; using osu.Framework.Graphics.Textures; using osu.Framework.Input.Events; using osu.Framework.Utils; using osu.Game.Beatmaps.ControlPoints; using osu.Game.Graphics.Backgrounds; using osu.Game.Graphics.Containers; using osu.Game.Overlays; using osuTK; using osuTK.Graphics; using osuTK.Input; namespace osu.Game.Screens.Menu { /// /// osu! logo and its attachments (pulsing, visualiser etc.) /// public partial class OsuLogo : BeatSyncedContainer { public readonly Color4 OsuPink = Color4Extensions.FromHex(@"e967a1"); private const double transition_length = 300; /// /// The osu! logo sprite has a shadow included in its texture. /// This adjustment vector is used to match the precise edge of the border of the logo. /// public static readonly Vector2 SCALE_ADJUST = new Vector2(0.96f); private readonly Sprite logo; private readonly CircularContainer logoContainer; private readonly Container logoBounceContainer; private readonly Container logoBeatContainer; private readonly Container logoAmplitudeContainer; private readonly Container logoHoverContainer; private readonly MenuLogoVisualisation visualizer; private readonly IntroSequence intro; private Sample sampleClick; private SampleChannel sampleClickChannel; private Sample sampleBeat; private Sample sampleDownbeat; private readonly Container colourAndTriangles; private readonly Triangles triangles; /// /// Return value decides whether the logo should play its own sample for the click action. /// public Func Action; /// /// The size of the logo Sprite with respect to the scale of its hover and bounce containers. /// /// Does not account for the scale of this public float SizeForFlow => logo == null ? 0 : logo.DrawSize.X * logo.Scale.X * logoBounceContainer.Scale.X * logoHoverContainer.Scale.X; public bool IsTracking { get; set; } private readonly Sprite ripple; private readonly Container rippleContainer; public bool Triangles { set => colourAndTriangles.FadeTo(value ? 1 : 0, transition_length, Easing.OutQuint); } public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => logoContainer.ReceivePositionalInputAt(screenSpacePos); public bool Ripple { get => rippleContainer.Alpha > 0; set => rippleContainer.FadeTo(value ? 1 : 0, transition_length, Easing.OutQuint); } private const float visualizer_default_alpha = 0.5f; private readonly Box flashLayer; private readonly Container impactContainer; private const double early_activation = 60; private const float triangles_paused_velocity = 0.5f; public override bool IsPresent => base.IsPresent || Scheduler.HasPendingTasks; public OsuLogo() { EarlyActivationMilliseconds = early_activation; Origin = Anchor.Centre; AutoSizeAxes = Axes.Both; Children = new Drawable[] { intro = new IntroSequence { RelativeSizeAxes = Axes.Both, }, logoHoverContainer = new Container { AutoSizeAxes = Axes.Both, Children = new Drawable[] { logoBounceContainer = new Container { AutoSizeAxes = Axes.Both, Children = new Drawable[] { rippleContainer = new Container { Anchor = Anchor.Centre, Origin = Anchor.Centre, RelativeSizeAxes = Axes.Both, Children = new Drawable[] { ripple = new Sprite { Anchor = Anchor.Centre, Origin = Anchor.Centre, Blending = BlendingParameters.Additive, Alpha = 0 } } }, logoAmplitudeContainer = new Container { AutoSizeAxes = Axes.Both, Children = new Drawable[] { logoBeatContainer = new Container { AutoSizeAxes = Axes.Both, Children = new Drawable[] { visualizer = new MenuLogoVisualisation { RelativeSizeAxes = Axes.Both, Origin = Anchor.Centre, Anchor = Anchor.Centre, Alpha = visualizer_default_alpha, Size = SCALE_ADJUST }, new Container { AutoSizeAxes = Axes.Both, Children = new Drawable[] { logoContainer = new CircularContainer { Anchor = Anchor.Centre, Origin = Anchor.Centre, RelativeSizeAxes = Axes.Both, Scale = SCALE_ADJUST, Masking = true, Children = new Drawable[] { colourAndTriangles = new Container { RelativeSizeAxes = Axes.Both, Anchor = Anchor.Centre, Origin = Anchor.Centre, Children = new Drawable[] { new Box { RelativeSizeAxes = Axes.Both, Colour = OsuPink, }, triangles = new Triangles { TriangleScale = 4, ColourLight = Color4Extensions.FromHex(@"ff7db7"), ColourDark = Color4Extensions.FromHex(@"de5b95"), RelativeSizeAxes = Axes.Both, }, } }, flashLayer = new Box { RelativeSizeAxes = Axes.Both, Blending = BlendingParameters.Additive, Colour = Color4.White, Alpha = 0, }, }, }, logo = new Sprite { Anchor = Anchor.Centre, Origin = Anchor.Centre, }, } }, impactContainer = new CircularContainer { Anchor = Anchor.Centre, Origin = Anchor.Centre, Alpha = 0, BorderColour = Color4.White, RelativeSizeAxes = Axes.Both, BorderThickness = 10, Masking = true, Children = new Drawable[] { new Box { RelativeSizeAxes = Axes.Both, AlwaysPresent = true, Alpha = 0, } } } } } } } } } } } }; } /// /// Schedule a new external animation. Handled queueing and finishing previous animations in a sane way. /// /// The animation to be performed /// If true, the new animation is delayed until all previous transforms finish. If false, existing transformed are cleared. public void AppendAnimatingAction(Action action, bool waitForPrevious) { void runnableAction() { if (waitForPrevious) this.DelayUntilTransformsFinished().Schedule(action); else { ClearTransforms(); action(); } } if (IsLoaded) runnableAction(); else Schedule(runnableAction); } [BackgroundDependencyLoader] private void load(TextureStore textures, AudioManager audio) { sampleClick = audio.Samples.Get(@"Menu/osu-logo-select"); sampleBeat = audio.Samples.Get(@"Menu/osu-logo-heartbeat"); sampleDownbeat = audio.Samples.Get(@"Menu/osu-logo-downbeat"); logo.Texture = textures.Get(@"Menu/logo"); ripple.Texture = textures.Get(@"Menu/logo"); } private int lastBeatIndex; protected override void OnNewBeat(int beatIndex, TimingControlPoint timingPoint, EffectControlPoint effectPoint, ChannelAmplitudes amplitudes) { base.OnNewBeat(beatIndex, timingPoint, effectPoint, amplitudes); lastBeatIndex = beatIndex; double beatLength = timingPoint.BeatLength; float amplitudeAdjust = Math.Min(1, 0.4f + amplitudes.Maximum); if (beatIndex < 0) return; if (Action != null && IsHovered) { this.Delay(early_activation).Schedule(() => { if (beatIndex % timingPoint.TimeSignature.Numerator == 0) { sampleDownbeat?.Play(); } else { var channel = sampleBeat.GetChannel(); channel.Frequency.Value = 0.95 + RNG.NextDouble(0.1); channel.Play(); } }); } logoBeatContainer .ScaleTo(1 - 0.02f * amplitudeAdjust, early_activation, Easing.Out).Then() .ScaleTo(1, beatLength * 2, Easing.OutQuint); ripple.ClearTransforms(); ripple .ScaleTo(logoAmplitudeContainer.Scale) .ScaleTo(logoAmplitudeContainer.Scale * (1 + 0.04f * amplitudeAdjust), beatLength, Easing.OutQuint) .FadeTo(0.15f * amplitudeAdjust).FadeOut(beatLength, Easing.OutQuint); if (effectPoint.KiaiMode && flashLayer.Alpha < 0.4f) { flashLayer.ClearTransforms(); flashLayer .FadeTo(0.2f * amplitudeAdjust, early_activation, Easing.Out).Then() .FadeOut(beatLength); visualizer.ClearTransforms(); visualizer .FadeTo(visualizer_default_alpha * 1.8f * amplitudeAdjust, early_activation, Easing.Out).Then() .FadeTo(visualizer_default_alpha, beatLength); } this.Delay(early_activation).Schedule(() => { triangles.Velocity += amplitudeAdjust * (effectPoint.KiaiMode ? 6 : 3); }); } public void PlayIntro() { const double length = 3150; const double fade = 200; logoHoverContainer.FadeOut().Delay(length).FadeIn(fade); intro.Show(); intro.Start(length); intro.Delay(length + fade).FadeOut(); } [Resolved] private MusicController musicController { get; set; } protected override void Update() { base.Update(); const float scale_adjust_cutoff = 0.4f; if (musicController.CurrentTrack.IsRunning) { float maxAmplitude = lastBeatIndex >= 0 ? musicController.CurrentTrack.CurrentAmplitudes.Maximum : 0; logoAmplitudeContainer.Scale = new Vector2((float)Interpolation.Damp(logoAmplitudeContainer.Scale.X, 1 - Math.Max(0, maxAmplitude - scale_adjust_cutoff) * 0.04f, 0.9f, Time.Elapsed)); triangles.Velocity = (float)Interpolation.Damp(triangles.Velocity, triangles_paused_velocity * (IsKiaiTime ? 4 : 2), 0.995f, Time.Elapsed); } else { triangles.Velocity = (float)Interpolation.Damp(triangles.Velocity, triangles_paused_velocity, 0.9f, Time.Elapsed); } } public override bool HandlePositionalInput => base.HandlePositionalInput && Alpha > 0.2f; protected override bool OnMouseDown(MouseDownEvent e) { if (e.Button != MouseButton.Left) return true; logoBounceContainer.ScaleTo(0.9f, 1000, Easing.Out); return true; } protected override void OnMouseUp(MouseUpEvent e) { if (e.Button != MouseButton.Left) return; logoBounceContainer.ScaleTo(1f, 500, Easing.OutElastic); } protected override bool OnClick(ClickEvent e) { flashLayer.ClearTransforms(); flashLayer.Alpha = 0.4f; flashLayer.FadeOut(1500, Easing.OutExpo); if (Action?.Invoke() == true) { StopSamplePlayback(); sampleClickChannel = sampleClick.GetChannel(); sampleClickChannel.Play(); } return true; } protected override bool OnHover(HoverEvent e) { if (Action != null) logoHoverContainer.ScaleTo(1.1f, 500, Easing.OutElastic); return true; } protected override void OnHoverLost(HoverLostEvent e) { logoHoverContainer.ScaleTo(1, 500, Easing.OutElastic); } public void Impact() { impactContainer.FadeOutFromOne(250, Easing.In); impactContainer.ScaleTo(SCALE_ADJUST); impactContainer.ScaleTo(1.12f, 250); } public override bool DragBlocksClick => false; protected override bool OnDragStart(DragStartEvent e) => true; protected override void OnDrag(DragEvent e) { Vector2 change = e.MousePosition - e.MouseDownPosition; // Diminish the drag distance as we go further to simulate "rubber band" feeling. change *= change.Length <= 0 ? 0 : MathF.Pow(change.Length, 0.6f) / change.Length; logoBounceContainer.MoveTo(change); } protected override void OnDragEnd(DragEndEvent e) { logoBounceContainer.MoveTo(Vector2.Zero, 800, Easing.OutElastic); base.OnDragEnd(e); } private Container defaultProxyTarget; private Container currentProxyTarget; private Drawable proxy; public void StopSamplePlayback() => sampleClickChannel?.Stop(); public Drawable ProxyToContainer(Container c) { if (currentProxyTarget != null) throw new InvalidOperationException("Previous proxy usage was not returned"); if (defaultProxyTarget == null) throw new InvalidOperationException($"{nameof(SetupDefaultContainer)} must be called first"); currentProxyTarget = c; defaultProxyTarget.Remove(proxy, false); currentProxyTarget.Add(proxy); return proxy; } public void ReturnProxy() { if (currentProxyTarget == null) throw new InvalidOperationException("No usage to return"); if (defaultProxyTarget == null) throw new InvalidOperationException($"{nameof(SetupDefaultContainer)} must be called first"); currentProxyTarget.Remove(proxy, false); currentProxyTarget = null; defaultProxyTarget.Add(proxy); } public void SetupDefaultContainer(Container container) { defaultProxyTarget = container; defaultProxyTarget.Add(this); defaultProxyTarget.Add(proxy = CreateProxy()); } } }