mirror of https://github.com/ppy/osu
100 lines
3.9 KiB
C#
100 lines
3.9 KiB
C#
// 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.
|
|
|
|
using System;
|
|
using osu.Framework.Bindables;
|
|
using osu.Game.Audio;
|
|
using osu.Game.Graphics;
|
|
using osuTK.Graphics;
|
|
|
|
namespace osu.Game.Beatmaps.ControlPoints
|
|
{
|
|
/// <remarks>
|
|
/// Note that going forward, this control point type should always be assigned directly to HitObjects.
|
|
/// </remarks>
|
|
public class SampleControlPoint : ControlPoint, IEquatable<SampleControlPoint>
|
|
{
|
|
public const string DEFAULT_BANK = "normal";
|
|
|
|
public static readonly SampleControlPoint DEFAULT = new SampleControlPoint
|
|
{
|
|
SampleBankBindable = { Disabled = true },
|
|
SampleVolumeBindable = { Disabled = true }
|
|
};
|
|
|
|
public override Color4 GetRepresentingColour(OsuColour colours) => colours.Pink;
|
|
|
|
/// <summary>
|
|
/// The default sample bank at this control point.
|
|
/// </summary>
|
|
public readonly Bindable<string> SampleBankBindable = new Bindable<string>(DEFAULT_BANK) { Default = DEFAULT_BANK };
|
|
|
|
/// <summary>
|
|
/// The speed multiplier at this control point.
|
|
/// </summary>
|
|
public string SampleBank
|
|
{
|
|
get => SampleBankBindable.Value;
|
|
set => SampleBankBindable.Value = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// The default sample bank at this control point.
|
|
/// </summary>
|
|
public readonly BindableInt SampleVolumeBindable = new BindableInt(100)
|
|
{
|
|
MinValue = 0,
|
|
MaxValue = 100,
|
|
Default = 100
|
|
};
|
|
|
|
/// <summary>
|
|
/// The default sample volume at this control point.
|
|
/// </summary>
|
|
public int SampleVolume
|
|
{
|
|
get => SampleVolumeBindable.Value;
|
|
set => SampleVolumeBindable.Value = value;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Create a SampleInfo based on the sample settings in this control point.
|
|
/// </summary>
|
|
/// <param name="sampleName">The name of the same.</param>
|
|
/// <returns>A populated <see cref="HitSampleInfo"/>.</returns>
|
|
public HitSampleInfo GetSampleInfo(string sampleName = HitSampleInfo.HIT_NORMAL) => new HitSampleInfo(sampleName, SampleBank, volume: SampleVolume);
|
|
|
|
/// <summary>
|
|
/// Applies <see cref="SampleBank"/> and <see cref="SampleVolume"/> to a <see cref="HitSampleInfo"/> if necessary, returning the modified <see cref="HitSampleInfo"/>.
|
|
/// </summary>
|
|
/// <param name="hitSampleInfo">The <see cref="HitSampleInfo"/>. This will not be modified.</param>
|
|
/// <returns>The modified <see cref="HitSampleInfo"/>. This does not share a reference with <paramref name="hitSampleInfo"/>.</returns>
|
|
public virtual HitSampleInfo ApplyTo(HitSampleInfo hitSampleInfo)
|
|
=> hitSampleInfo.With(newBank: hitSampleInfo.Bank ?? SampleBank, newVolume: hitSampleInfo.Volume > 0 ? hitSampleInfo.Volume : SampleVolume);
|
|
|
|
public override bool IsRedundant(ControlPoint? existing)
|
|
=> existing is SampleControlPoint existingSample
|
|
&& SampleBank == existingSample.SampleBank
|
|
&& SampleVolume == existingSample.SampleVolume;
|
|
|
|
public override void CopyFrom(ControlPoint other)
|
|
{
|
|
SampleVolume = ((SampleControlPoint)other).SampleVolume;
|
|
SampleBank = ((SampleControlPoint)other).SampleBank;
|
|
|
|
base.CopyFrom(other);
|
|
}
|
|
|
|
public override bool Equals(ControlPoint? other)
|
|
=> other is SampleControlPoint otherSampleControlPoint
|
|
&& Equals(otherSampleControlPoint);
|
|
|
|
public bool Equals(SampleControlPoint? other)
|
|
=> base.Equals(other)
|
|
&& SampleBank == other.SampleBank
|
|
&& SampleVolume == other.SampleVolume;
|
|
|
|
public override int GetHashCode() => HashCode.Combine(base.GetHashCode(), SampleBank, SampleVolume);
|
|
}
|
|
}
|