osu/osu.Game.Rulesets.Mania/Objects/HoldNote.cs

// Copyright (c) 2007-2017 ppy Pty Ltd <contact@ppy.sh>.
// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE

using System.Collections.Generic;
using osu.Game.Beatmaps;
using osu.Game.Beatmaps.ControlPoints;
using osu.Game.Rulesets.Objects.Types;

namespace osu.Game.Rulesets.Mania.Objects
{
    /// <summary>
    /// Represents a hit object which requires pressing, holding, and releasing a key.
    /// </summary>
    public class HoldNote : ManiaHitObject, IHasEndTime
    {
        public double EndTime => StartTime + Duration;

        private double duration;
        public double Duration
        {
            get { return duration; }
            set
            {
                duration = value;
                Tail.StartTime = EndTime;
            }
        }

        public override double StartTime
        {
            get { return base.StartTime; }
            set
            {
                base.StartTime = value;
                Head.StartTime = value;
                Tail.StartTime = EndTime;
            }
        }

        public override int Column
        {
            get { return base.Column; }
            set
            {
                base.Column = value;
                Head.Column = value;
                Tail.Column = value;
            }
        }

        /// <summary>
        /// The head note of the hold.
        /// </summary>
        public readonly Note Head = new Note();

        /// <summary>
        /// The tail note of the hold.
        /// </summary>
        public readonly Note Tail = new TailNote();

        /// <summary>
        /// The time between ticks of this hold.
        /// </summary>
        private double tickSpacing = 50;

        public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
        {
            base.ApplyDefaults(controlPointInfo, difficulty);

            TimingControlPoint timingPoint = controlPointInfo.TimingPointAt(StartTime);
            tickSpacing = timingPoint.BeatLength / difficulty.SliderTickRate;

            Head.ApplyDefaults(controlPointInfo, difficulty);
            Tail.ApplyDefaults(controlPointInfo, difficulty);
        }

        /// <summary>
        /// The scoring scoring ticks of the hold note.
        /// </summary>
        public IEnumerable<HoldNoteTick> Ticks => ticks ?? (ticks = createTicks());
        private List<HoldNoteTick> ticks;

        private List<HoldNoteTick> createTicks()
        {
            var ret = new List<HoldNoteTick>();

            if (tickSpacing == 0)
                return ret;

            for (double t = StartTime + tickSpacing; t <= EndTime - tickSpacing; t += tickSpacing)
            {
                ret.Add(new HoldNoteTick
                {
                    StartTime = t,
                    Column = Column
                });
            }

            return ret;
        }

        /// <summary>
        /// The tail of the hold note.
        /// </summary>
        private class TailNote : Note
        {
            /// <summary>
            /// Lenience of release hit windows. This is to make cases where the hold note release
            /// is timed alongside presses of other hit objects less awkward.
            /// </summary>
            private const double release_window_lenience = 1.5;

            public override void ApplyDefaults(ControlPointInfo controlPointInfo, BeatmapDifficulty difficulty)
            {
                base.ApplyDefaults(controlPointInfo, difficulty);

                HitWindows *= release_window_lenience;
            }
        }
    }
}