1
0
mirror of https://github.com/ppy/osu.git synced 2024-11-06 06:57:39 +08:00

Add method documentation

This commit is contained in:
Naxess 2021-03-22 19:42:27 +01:00
parent b11fd7972a
commit 3fa5852e00

View File

@ -197,6 +197,9 @@ namespace osu.Game.Rulesets.Objects
return pointsInCurrentSegment;
}
/// <summary>
/// Handles correction of invalid path types.
/// </summary>
private void updatePathTypes()
{
foreach (PathControlPoint segmentStartPoint in ControlPoints.Where(p => p.Type.Value != null))
@ -210,6 +213,13 @@ namespace osu.Game.Rulesets.Objects
}
}
/// <summary>
/// Returns whether the given points are arranged in a valid way. Invalid if points
/// are almost entirely linear - as this causes the radius to approach infinity,
/// which would exhaust memory when drawing / approximating.
/// </summary>
/// <param name="points">The three points that make up this circular arc segment.</param>
/// <returns></returns>
private bool validCircularArcSegment(IReadOnlyList<Vector2> points)
{
Vector2 a = points[0];