mirror of
https://github.com/ppy/osu.git
synced 2024-11-12 06:07:28 +08:00
7b9ed924be
Further separates them from `IBeatSnapProvider`'s `SnapTime`, and groups them together more, to prevent confusion between the two interfaces. Also changes the xmldoc of the reference time to that of `IBeatSnapProvider` for consistency.
92 lines
3.3 KiB
C#
92 lines
3.3 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.Collections.Generic;
|
|
using osu.Game.Beatmaps.ControlPoints;
|
|
using osu.Game.Beatmaps.Timing;
|
|
using osu.Game.IO.Serialization;
|
|
using osu.Game.Rulesets.Objects;
|
|
|
|
namespace osu.Game.Beatmaps
|
|
{
|
|
public interface IBeatmap : IJsonSerializable
|
|
{
|
|
/// <summary>
|
|
/// This beatmap's info.
|
|
/// </summary>
|
|
BeatmapInfo BeatmapInfo { get; set; }
|
|
|
|
/// <summary>
|
|
/// This beatmap's metadata.
|
|
/// </summary>
|
|
BeatmapMetadata Metadata { get; }
|
|
|
|
/// <summary>
|
|
/// The control points in this beatmap.
|
|
/// </summary>
|
|
ControlPointInfo ControlPointInfo { get; set; }
|
|
|
|
/// <summary>
|
|
/// The breaks in this beatmap.
|
|
/// </summary>
|
|
List<BreakPeriod> Breaks { get; }
|
|
|
|
/// <summary>
|
|
/// Total amount of break time in the beatmap.
|
|
/// </summary>
|
|
double TotalBreakTime { get; }
|
|
|
|
/// <summary>
|
|
/// The hitobjects contained by this beatmap.
|
|
/// </summary>
|
|
IReadOnlyList<HitObject> HitObjects { get; }
|
|
|
|
/// <summary>
|
|
/// Returns statistics for the <see cref="HitObjects"/> contained in this beatmap.
|
|
/// </summary>
|
|
IEnumerable<BeatmapStatistic> GetStatistics();
|
|
|
|
/// <summary>
|
|
/// Finds the most common beat length represented by the control points in this beatmap.
|
|
/// </summary>
|
|
double GetMostCommonBeatLength();
|
|
|
|
/// <summary>
|
|
/// Returns the time on the given beat divisor closest to the given time.
|
|
/// </summary>
|
|
/// <param name="time">The time to find the closest snapped time to.</param>
|
|
/// <param name="beatDivisor">The beat divisor to snap to.</param>
|
|
/// <param name="referenceTime">An optional reference point to use for timing point lookup.</param>
|
|
int ClosestSnapTime(double time, int beatDivisor, double? referenceTime = null);
|
|
|
|
/// <summary>
|
|
/// Returns the time on any valid beat divisor closest to the given time.
|
|
/// </summary>
|
|
/// <param name="time">The time to find the closest snapped time to.</param>
|
|
/// <param name="referenceTime">An optional reference point to use for timing point lookup.</param>
|
|
int ClosestSnapTime(double time, double? referenceTime = null);
|
|
|
|
/// <summary>
|
|
/// Returns the beat snap divisor closest to the given time. If two are equally close, the smallest is returned.
|
|
/// </summary>
|
|
/// <param name="time">The time to find the closest beat snap divisor to.</param>
|
|
/// <param name="referenceTime">An optional reference point to use for timing point lookup.</param>
|
|
int ClosestBeatDivisor(double time, double? referenceTime = null);
|
|
|
|
/// <summary>
|
|
/// Creates a shallow-clone of this beatmap and returns it.
|
|
/// </summary>
|
|
/// <returns>The shallow-cloned beatmap.</returns>
|
|
IBeatmap Clone();
|
|
}
|
|
|
|
public interface IBeatmap<out T> : IBeatmap
|
|
where T : HitObject
|
|
{
|
|
/// <summary>
|
|
/// The hitobjects contained by this beatmap.
|
|
/// </summary>
|
|
new IReadOnlyList<T> HitObjects { get; }
|
|
}
|
|
}
|