2019-10-25 07:50:21 +00:00
// 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.
2022-05-05 07:35:52 +00:00
using osu.Framework.Allocation ;
2019-10-25 07:50:21 +00:00
using osuTK ;
namespace osu.Game.Rulesets.Edit
{
2022-05-05 06:58:21 +00:00
/// <summary>
2022-05-05 07:04:34 +00:00
/// A snap provider which given a proposed position for a hit object, potentially offers a more correct position and time value inferred from the context of the beatmap.
2022-05-05 06:58:21 +00:00
/// </summary>
2022-05-05 07:35:52 +00:00
[Cached]
2020-05-20 08:48:43 +00:00
public interface IPositionSnapProvider
2019-10-25 07:50:21 +00:00
{
2020-05-20 08:48:43 +00:00
/// <summary>
2020-11-24 08:14:39 +00:00
/// Given a position, find a valid time and position snap.
2020-05-20 08:48:43 +00:00
/// </summary>
2020-05-20 09:19:21 +00:00
/// <param name="screenSpacePosition">The screen-space position to be snapped.</param>
2022-05-12 06:23:41 +00:00
/// <param name="snapType">The type of snapping to apply.</param>
2020-05-20 08:48:43 +00:00
/// <returns>The time and position post-snapping.</returns>
2022-05-12 06:23:41 +00:00
SnapResult FindSnappedPositionAndTime ( Vector2 screenSpacePosition , SnapType snapType = SnapType . All ) ;
2019-10-25 07:50:21 +00:00
}
}