osu/osu.Game/Rulesets/Edit/SelectionBlueprint.cs

148 lines
4.9 KiB
C#
Raw Normal View History

2018-04-13 09:19:50 +00: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;
using osu.Framework;
using osu.Framework.Graphics;
2018-04-13 09:19:50 +00:00
using osu.Framework.Graphics.Containers;
using osu.Framework.Graphics.Primitives;
2018-10-02 03:02:47 +00:00
using osu.Framework.Input.Events;
2018-07-21 02:38:28 +00:00
using osu.Framework.Input.States;
2018-05-11 01:48:07 +00:00
using osu.Game.Graphics.UserInterface;
2018-04-13 09:19:50 +00:00
using osu.Game.Rulesets.Objects.Drawables;
using OpenTK;
namespace osu.Game.Rulesets.Edit
{
/// <summary>
/// A mask placed above a <see cref="DrawableHitObject"/> adding editing functionality.
/// </summary>
2018-11-06 08:56:04 +00:00
public class SelectionBlueprint : CompositeDrawable, IStateful<SelectionState>
2018-04-13 09:19:50 +00:00
{
/// <summary>
2018-11-06 08:56:04 +00:00
/// Invoked when this <see cref="SelectionBlueprint"/> has been selected.
2018-04-13 09:19:50 +00:00
/// </summary>
2018-11-06 08:56:04 +00:00
public event Action<SelectionBlueprint> Selected;
2018-04-13 09:19:50 +00:00
/// <summary>
2018-11-06 08:56:04 +00:00
/// Invoked when this <see cref="SelectionBlueprint"/> has been deselected.
2018-04-13 09:19:50 +00:00
/// </summary>
2018-11-06 08:56:04 +00:00
public event Action<SelectionBlueprint> Deselected;
2018-04-13 09:19:50 +00:00
/// <summary>
2018-11-06 08:56:04 +00:00
/// Invoked when this <see cref="SelectionBlueprint"/> has requested selection.
2018-04-13 09:19:50 +00:00
/// Will fire even if already selected. Does not actually perform selection.
/// </summary>
2018-11-06 08:56:04 +00:00
public event Action<SelectionBlueprint, InputState> SelectionRequested;
2018-04-13 09:19:50 +00:00
/// <summary>
2018-11-06 08:56:04 +00:00
/// Invoked when this <see cref="SelectionBlueprint"/> has requested drag.
2018-04-13 09:19:50 +00:00
/// </summary>
2018-11-06 08:56:04 +00:00
public event Action<SelectionBlueprint, Vector2, InputState> DragRequested;
2018-04-13 09:19:50 +00:00
/// <summary>
2018-11-06 08:56:04 +00:00
/// The <see cref="DrawableHitObject"/> which this <see cref="SelectionBlueprint"/> applies to.
2018-04-13 09:19:50 +00:00
/// </summary>
public readonly DrawableHitObject HitObject;
protected override bool ShouldBeAlive => HitObject.IsAlive && HitObject.IsPresent || State == SelectionState.Selected;
public override bool HandlePositionalInput => ShouldBeAlive;
2018-04-13 09:19:50 +00:00
public override bool RemoveWhenNotAlive => false;
2018-11-06 08:56:04 +00:00
public SelectionBlueprint(DrawableHitObject hitObject)
2018-04-13 09:19:50 +00:00
{
HitObject = hitObject;
RelativeSizeAxes = Axes.Both;
2018-04-13 09:19:50 +00:00
AlwaysPresent = true;
Alpha = 0;
}
private SelectionState state;
public event Action<SelectionState> StateChanged;
public SelectionState State
{
get => state;
set
{
if (state == value) return;
state = value;
switch (state)
{
case SelectionState.Selected:
Show();
Selected?.Invoke(this);
break;
case SelectionState.NotSelected:
Hide();
Deselected?.Invoke(this);
break;
}
}
}
/// <summary>
2018-11-06 08:56:04 +00:00
/// Selects this <see cref="SelectionBlueprint"/>, causing it to become visible.
2018-04-13 09:19:50 +00:00
/// </summary>
public void Select() => State = SelectionState.Selected;
/// <summary>
2018-11-06 08:56:04 +00:00
/// Deselects this <see cref="SelectionBlueprint"/>, causing it to become invisible.
2018-04-13 09:19:50 +00:00
/// </summary>
public void Deselect() => State = SelectionState.NotSelected;
public bool IsSelected => State == SelectionState.Selected;
public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) => HitObject.ReceivePositionalInputAt(screenSpacePos);
2018-04-13 09:19:50 +00:00
private bool selectionRequested;
2018-10-02 03:02:47 +00:00
protected override bool OnMouseDown(MouseDownEvent e)
2018-04-13 09:19:50 +00:00
{
selectionRequested = false;
if (State == SelectionState.NotSelected)
{
SelectionRequested?.Invoke(this, e.CurrentState);
2018-04-13 09:19:50 +00:00
selectionRequested = true;
}
return IsSelected;
}
2018-10-02 03:02:47 +00:00
protected override bool OnClick(ClickEvent e)
2018-04-13 09:19:50 +00:00
{
if (State == SelectionState.Selected && !selectionRequested)
{
selectionRequested = true;
SelectionRequested?.Invoke(this, e.CurrentState);
2018-04-13 09:19:50 +00:00
return true;
}
2018-10-02 03:02:47 +00:00
return base.OnClick(e);
2018-04-13 09:19:50 +00:00
}
2018-10-02 03:02:47 +00:00
protected override bool OnDragStart(DragStartEvent e) => true;
2018-04-13 09:19:50 +00:00
2018-10-02 03:02:47 +00:00
protected override bool OnDrag(DragEvent e)
2018-04-13 09:19:50 +00:00
{
DragRequested?.Invoke(this, e.Delta, e.CurrentState);
2018-04-13 09:19:50 +00:00
return true;
}
/// <summary>
2018-11-06 08:56:04 +00:00
/// The screen-space point that causes this <see cref="SelectionBlueprint"/> to be selected.
2018-04-13 09:19:50 +00:00
/// </summary>
public virtual Vector2 SelectionPoint => HitObject.ScreenSpaceDrawQuad.Centre;
2018-04-13 09:19:50 +00:00
/// <summary>
2018-11-06 08:56:04 +00:00
/// The screen-space quad that outlines this <see cref="SelectionBlueprint"/> for selections.
2018-04-13 09:19:50 +00:00
/// </summary>
public virtual Quad SelectionQuad => HitObject.ScreenSpaceDrawQuad;
2018-04-13 09:19:50 +00:00
}
}