1
0
mirror of https://github.com/ppy/osu.git synced 2024-11-06 06:17:23 +08:00
osu-lazer/osu.Game/Rulesets/UI/Playfield.cs

116 lines
4.2 KiB
C#
Raw Normal View History

2018-01-05 19:21:19 +08:00
// Copyright (c) 2007-2018 ppy Pty Ltd <contact@ppy.sh>.
// Licensed under the MIT Licence - https://raw.githubusercontent.com/ppy/osu/master/LICENCE
using System.Collections.Generic;
using osu.Framework.Graphics;
using osu.Framework.Graphics.Containers;
2017-04-18 15:05:58 +08:00
using osu.Game.Rulesets.Objects.Drawables;
2017-03-07 14:43:44 +08:00
using OpenTK;
using osu.Framework.Allocation;
2017-04-18 15:05:58 +08:00
namespace osu.Game.Rulesets.UI
{
public abstract class Playfield : Container
{
/// <summary>
/// The HitObjects contained in this Playfield.
/// </summary>
public HitObjectContainer HitObjects { get; private set; }
2017-03-06 12:59:11 +08:00
public Container<Drawable> ScaledContent;
2017-03-09 14:53:16 +08:00
protected override Container<Drawable> Content => content;
private readonly Container<Drawable> content;
private List<Playfield> nestedPlayfields;
/// <summary>
/// All the <see cref="Playfield"/>s nested inside this playfield.
/// </summary>
public IReadOnlyList<Playfield> NestedPlayfields => nestedPlayfields;
2017-03-07 14:43:44 +08:00
/// <summary>
/// A container for keeping track of DrawableHitObjects.
/// </summary>
/// <param name="customWidth">Whether we want our internal coordinate system to be scaled to a specified width.</param>
protected Playfield(float? customWidth = null)
{
2018-01-15 18:44:42 +08:00
RelativeSizeAxes = Axes.Both;
AddInternal(ScaledContent = new ScaledContainer
{
2017-03-07 14:43:44 +08:00
CustomWidth = customWidth,
RelativeSizeAxes = Axes.Both,
2017-02-28 19:14:48 +08:00
Children = new[]
{
2017-03-09 14:53:16 +08:00
content = new Container
2017-02-28 19:14:48 +08:00
{
RelativeSizeAxes = Axes.Both,
}
}
});
}
[BackgroundDependencyLoader]
private void load()
{
HitObjects = CreateHitObjectContainer();
HitObjects.RelativeSizeAxes = Axes.Both;
Add(HitObjects);
}
/// <summary>
/// Performs post-processing tasks (if any) after all DrawableHitObjects are loaded into this Playfield.
/// </summary>
public virtual void PostProcess() => nestedPlayfields?.ForEach(p => p.PostProcess());
/// <summary>
/// Adds a DrawableHitObject to this Playfield.
/// </summary>
/// <param name="h">The DrawableHitObject to add.</param>
public virtual void Add(DrawableHitObject h) => HitObjects.Add(h);
/// <summary>
/// Remove a DrawableHitObject from this Playfield.
/// </summary>
/// <param name="h">The DrawableHitObject to remove.</param>
public virtual void Remove(DrawableHitObject h) => HitObjects.Remove(h);
/// <summary>
/// Registers a <see cref="Playfield"/> as a nested <see cref="Playfield"/>.
/// This does not add the <see cref="Playfield"/> to the draw hierarchy.
/// </summary>
/// <param name="otherPlayfield">The <see cref="Playfield"/> to add.</param>
protected void AddNested(Playfield otherPlayfield)
{
if (nestedPlayfields == null)
nestedPlayfields = new List<Playfield>();
nestedPlayfields.Add(otherPlayfield);
}
2017-02-10 13:16:23 +08:00
2018-01-07 11:47:09 +08:00
/// <summary>
/// Creates the container that will be used to contain the <see cref="DrawableHitObject"/>s.
/// </summary>
protected virtual HitObjectContainer CreateHitObjectContainer() => new HitObjectContainer();
2017-03-07 14:43:44 +08:00
private class ScaledContainer : Container
{
2017-03-08 10:54:52 +08:00
/// <summary>
/// A value (in game pixels that we should scale our content to match).
/// </summary>
2017-03-07 14:43:44 +08:00
public float? CustomWidth;
2017-03-08 10:54:52 +08:00
//dividing by the customwidth will effectively scale our content to the required container size.
2017-03-07 14:43:44 +08:00
protected override Vector2 DrawScale => CustomWidth.HasValue ? new Vector2(DrawSize.X / CustomWidth.Value) : base.DrawScale;
protected override void Update()
{
base.Update();
2018-01-04 15:31:41 +08:00
RelativeChildSize = new Vector2(DrawScale.X, RelativeChildSize.Y);
}
}
}
}