Adjust xmldoc and rename to GetAspectAdjustedSize

This commit is contained in:
smoogipoo
2018-02-19 17:04:18 +09:00
parent ef11ce3dd1
commit cd2c9a9de6
4 changed files with 8 additions and 7 deletions

View File

@ -324,7 +324,7 @@ namespace osu.Game.Rulesets.UI
{
base.Update();
Playfield.Size = AspectAdjust ? GetPlayfieldAspectAdjust() : Vector2.One;
Playfield.Size = AspectAdjust ? GetAspectAdjustedSize() : Vector2.One;
}
/// <summary>
@ -335,10 +335,11 @@ namespace osu.Game.Rulesets.UI
protected virtual BeatmapProcessor<TObject> CreateBeatmapProcessor() => new BeatmapProcessor<TObject>();
/// <summary>
/// In some cases we want to apply changes to the relative size of our contained <see cref="Playfield"/> based on custom conditions.
/// Computes the final size of the <see cref="Playfield"/> in relative coordinate space after all
/// aspect and scale adjustments.
/// </summary>
/// <returns></returns>
protected virtual Vector2 GetPlayfieldAspectAdjust() => new Vector2(0.75f); //a sane default
/// <returns>The aspect-adjusted size.</returns>
protected virtual Vector2 GetAspectAdjustedSize() => new Vector2(0.75f); // A sane default
/// <summary>
/// Creates a converter to convert Beatmap to a specific mode.