sim1222/osukey
1
1
Fork 0
mirror of https://github.com/osukey/osukey.git synced 2025-08-07 16:43:52 +09:00
Code Issues Packages Projects Releases Wiki Activity

Add xmldoc to SnapFinder

Browse Source
This commit is contained in:
Justus Franklin Tumacder
2021-04-25 08:53:45 +08:00
parent 8b9d2a6cff
commit 1f48378ce7
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
osu.Game/Rulesets/Objects/SnapFinder.cs
View File

@ -8,10 +8,17 @@ using osu.Game.Beatmaps.ControlPoints;
namespace osu.Game.Rulesets.Objects namespace osu.Game.Rulesets.Objects
{ {
/// <summary>
/// Used to find the lowest beat divisor that a <see cref="HitObject"/> aligns to in an <see cref="IBeatmap"/>
/// </summary>
public class SnapFinder public class SnapFinder
{ {
private readonly IBeatmap beatmap; private readonly IBeatmap beatmap;
/// <summary>
/// Creates a new SnapFinder instance.
/// </summary>
/// <param name="beatmap">The beatmap to align to when evaulating.</param>
public SnapFinder(IBeatmap beatmap) public SnapFinder(IBeatmap beatmap)
{ {
this.beatmap = beatmap; this.beatmap = beatmap;
@ -19,6 +26,10 @@ namespace osu.Game.Rulesets.Objects
private readonly static int[] snaps = { 1, 2, 3, 4, 6, 8, 12, 16 }; private readonly static int[] snaps = { 1, 2, 3, 4, 6, 8, 12, 16 };
/// <summary>
/// Finds the lowest beat divisor that the given HitObject aligns to.
/// </summary>
/// <param name="hitObject">The <see cref="HitObject"/> to evaluate.</param>
public int FindSnap(HitObject hitObject) public int FindSnap(HitObject hitObject)
{ {
TimingControlPoint currentTimingPoint = beatmap.ControlPointInfo.TimingPointAt(hitObject.StartTime); TimingControlPoint currentTimingPoint = beatmap.ControlPointInfo.TimingPointAt(hitObject.StartTime);