// Copyright (c) ppy Pty Ltd . Licensed under the MIT Licence. // See the LICENCE file in the repository root for full licence text. using System; using System.Linq; using osu.Framework.Allocation; using osu.Framework.Audio; using osu.Framework.Bindables; using osu.Framework.Graphics; using osu.Framework.Graphics.Containers; using osu.Game.Graphics; using osu.Game.Rulesets.Objects; using osu.Game.Rulesets.Objects.Drawables; using osu.Game.Rulesets.Osu.Objects.Drawables.Pieces; using osu.Game.Rulesets.Osu.Skinning; using osu.Game.Rulesets.Scoring; using osu.Game.Screens.Ranking; using osu.Game.Skinning; using osuTK; namespace osu.Game.Rulesets.Osu.Objects.Drawables { public class DrawableSpinner : DrawableOsuHitObject { protected readonly Spinner Spinner; private readonly Container ticks; public readonly SpinnerRotationTracker RotationTracker; public readonly SpinnerSpmCounter SpmCounter; private readonly SpinnerBonusDisplay bonusDisplay; private readonly IBindable positionBindable = new Bindable(); private bool spinnerFrequencyModulate; public DrawableSpinner(Spinner s) : base(s) { Origin = Anchor.Centre; Position = s.Position; RelativeSizeAxes = Axes.Both; Spinner = s; InternalChildren = new Drawable[] { ticks = new Container(), new AspectContainer { Anchor = Anchor.Centre, Origin = Anchor.Centre, RelativeSizeAxes = Axes.Y, Children = new Drawable[] { new SkinnableDrawable(new OsuSkinComponent(OsuSkinComponents.SpinnerBody), _ => new DefaultSpinnerDisc()), RotationTracker = new SpinnerRotationTracker(Spinner) } }, SpmCounter = new SpinnerSpmCounter { Anchor = Anchor.Centre, Origin = Anchor.Centre, Y = 120, Alpha = 0 }, bonusDisplay = new SpinnerBonusDisplay { Anchor = Anchor.Centre, Origin = Anchor.Centre, Y = -120, } }; } private Bindable isSpinning; protected override void LoadComplete() { base.LoadComplete(); isSpinning = RotationTracker.IsSpinning.GetBoundCopy(); isSpinning.BindValueChanged(updateSpinningSample); } private SkinnableSound spinningSample; private const float spinning_sample_initial_frequency = 1.0f; private const float spinning_sample_modulated_base_frequency = 0.5f; protected override void LoadSamples() { base.LoadSamples(); spinningSample?.Expire(); spinningSample = null; var firstSample = HitObject.Samples.FirstOrDefault(); if (firstSample != null) { var clone = HitObject.SampleControlPoint.ApplyTo(firstSample); clone.Name = "spinnerspin"; AddInternal(spinningSample = new SkinnableSound(clone) { Volume = { Value = 0 }, Looping = true, Frequency = { Value = spinning_sample_initial_frequency } }); } } private void updateSpinningSample(ValueChangedEvent tracking) { // note that samples will not start playing if exiting a seek operation in the middle of a spinner. // may be something we want to address at a later point, but not so easy to make happen right now // (SkinnableSound would need to expose whether the sample is already playing and this logic would need to run in Update). if (tracking.NewValue && ShouldPlaySamples) { spinningSample?.Play(); spinningSample?.VolumeTo(1, 200); } else { spinningSample?.VolumeTo(0, 200).Finally(_ => spinningSample.Stop()); } } protected override void AddNestedHitObject(DrawableHitObject hitObject) { base.AddNestedHitObject(hitObject); switch (hitObject) { case DrawableSpinnerTick tick: ticks.Add(tick); break; } } protected override void UpdateStateTransforms(ArmedState state) { base.UpdateStateTransforms(state); using (BeginDelayedSequence(Spinner.Duration, true)) this.FadeOut(160); // skin change does a rewind of transforms, which will stop the spinning sound from playing if it's currently in playback. isSpinning?.TriggerChange(); } protected override void ClearNestedHitObjects() { base.ClearNestedHitObjects(); ticks.Clear(); } protected override DrawableHitObject CreateNestedHitObject(HitObject hitObject) { switch (hitObject) { case SpinnerBonusTick bonusTick: return new DrawableSpinnerBonusTick(bonusTick); case SpinnerTick tick: return new DrawableSpinnerTick(tick); } return base.CreateNestedHitObject(hitObject); } [BackgroundDependencyLoader] private void load(OsuColour colours) { positionBindable.BindValueChanged(pos => Position = pos.NewValue); positionBindable.BindTo(HitObject.PositionBindable); } protected override void ApplySkin(ISkinSource skin, bool allowFallback) { base.ApplySkin(skin, allowFallback); spinnerFrequencyModulate = skin.GetConfig(OsuSkinConfiguration.SpinnerFrequencyModulate)?.Value ?? true; } /// /// The completion progress of this spinner from 0..1 (clamped). /// public float Progress { get { if (Spinner.SpinsRequired == 0) // some spinners are so short they can't require an integer spin count. // these become implicitly hit. return 1; return Math.Clamp(RotationTracker.RateAdjustedRotation / 360 / Spinner.SpinsRequired, 0, 1); } } protected override void CheckForResult(bool userTriggered, double timeOffset) { if (Time.Current < HitObject.StartTime) return; RotationTracker.Complete.Value = Progress >= 1; if (userTriggered || Time.Current < Spinner.EndTime) return; // Trigger a miss result for remaining ticks to avoid infinite gameplay. foreach (var tick in ticks.Where(t => !t.IsHit)) tick.TriggerResult(false); ApplyResult(r => { if (Progress >= 1) r.Type = HitResult.Great; else if (Progress > .9) r.Type = HitResult.Good; else if (Progress > .75) r.Type = HitResult.Meh; else if (Time.Current >= Spinner.EndTime) r.Type = HitResult.Miss; }); } protected override void Update() { base.Update(); if (HandleUserInput) RotationTracker.Tracking = !Result.HasResult && (OsuActionInputManager?.PressedActions.Any(x => x == OsuAction.LeftButton || x == OsuAction.RightButton) ?? false); if (spinningSample != null && spinnerFrequencyModulate) spinningSample.Frequency.Value = spinning_sample_modulated_base_frequency + Progress; } protected override void UpdateAfterChildren() { base.UpdateAfterChildren(); if (!SpmCounter.IsPresent && RotationTracker.Tracking) SpmCounter.FadeIn(HitObject.TimeFadeIn); SpmCounter.SetRotation(RotationTracker.RateAdjustedRotation); updateBonusScore(); } private int wholeSpins; private void updateBonusScore() { if (ticks.Count == 0) return; int spins = (int)(RotationTracker.RateAdjustedRotation / 360); if (spins < wholeSpins) { // rewinding, silently handle wholeSpins = spins; return; } while (wholeSpins != spins) { var tick = ticks.FirstOrDefault(t => !t.IsHit); // tick may be null if we've hit the spin limit. if (tick != null) { tick.TriggerResult(true); if (tick is DrawableSpinnerBonusTick) bonusDisplay.SetBonusCount(spins - Spinner.SpinsRequired); } wholeSpins++; } } } }