aecw/osu-framework
1
0
Fork 0
mirror of https://github.com/SK-la/osu-framework.git synced 2026-03-15 03:20:30 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add comments

Browse Source
This commit is contained in:
smoogipoo
2020-02-25 12:26:47 +09:00
parent be4b9cf9cd
commit 725928bd38
3 changed files with 93 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

65
osu.Framework/Graphics/Drawable.cs
View File

@@ -1688,23 +1688,39 @@ namespace osu.Framework.Graphics
/// </summary>
internal Vector2 RequiredParentSizeToFit => requiredParentSizeToFitBacking.IsValid ? requiredParentSizeToFitBacking : requiredParentSizeToFitBacking.Value = computeRequiredParentSizeToFit();
protected Invalidation InvalidationState { get; private set; }
/// <summary>
/// The flags which this <see cref="Drawable"/> has been invalidated with.
/// </summary>
private Invalidation invalidationState;
private readonly List<LayoutMember> layoutMembers = new List<LayoutMember>();
/// <summary>
/// Adds a layout member that will be invalidated when its <see cref="LayoutMember.InvalidationType"/> is invalidated.
/// </summary>
/// <param name="member">The layout member to add.</param>
protected void AddLayout(LayoutMember member)
{
layoutMembers.Add(member);
member.Parent = this;
}
public void ValidateSuperTree(Invalidation validationType)
/// <summary>
/// Validates the super-tree of this <see cref="Drawable"/> for the given <see cref="Invalidation"/> flags.
/// </summary>
/// <remarks>
/// This is internally invoked by <see cref="LayoutMember"/>, and should not be invoked manually.
/// </remarks>
/// <param name="validationType">The <see cref="Invalidation"/> flags to validate with.</param>
internal void ValidateSuperTree(Invalidation validationType)
{
if ((InvalidationState & validationType) == 0)
// Prevent multiple traversals by only iterating on the invalid states.
if ((invalidationState & validationType) == 0)
return;
InvalidationState &= ~validationType;
invalidationState &= ~validationType;
// Propagate the validation up towards the parent if required.
if (Parent != null)
{
Parent.ValidateSuperTree(validationType);
@@ -1718,23 +1734,27 @@ namespace osu.Framework.Graphics
public long InvalidationID { get; private set; } = invalidation_counter.Increment();
/// <summary>
/// Invalidates draw matrix and autosize caches.
/// <para>
/// Invalidates the layout of this <see cref="Drawable"/>.
/// </summary>
/// <remarks>
/// This does not ensure that the parent containers have been updated before us, thus operations involving
/// parent states (e.g. <see cref="DrawInfo"/>) should not be executed in an overridden implementation.
/// </para>
/// </summary>
/// <returns>If the invalidate was actually necessary.</returns>
/// </remarks>
/// <param name="invalidation">The flags to invalidate with.</param>
/// <param name="source">The source that triggered the invalidation. A <c>null</c> value implies that this <see cref="Drawable"/> triggered the invalidation.</param>
/// <returns>If any layout was invalidated.</returns>
public bool Invalidate(Invalidation invalidation = Invalidation.All, Drawable source = null)
{
if (invalidation == Invalidation.None || LoadState < LoadState.Ready)
return false;
// Alert the parent that an invalidation has occurred.
if (Parent != null && source != Parent)
{
// Trim the invalidation flags for which the parent has already been alerted about.
var parentInvalidation = invalidation & ~Parent.ChildInvalidationState;
// Colour doesn't affect parent's properties
// Trim the invalidation flags that don't affect the parent's properties.
parentInvalidation &= ~Invalidation.Colour;
if (parentInvalidation > 0)
@@ -1744,19 +1764,26 @@ namespace osu.Framework.Graphics
}
}
if ((InvalidationState & invalidation) == invalidation)
// Prevent duplicate invalidations for states that have already been invalidated in this subtree.
if ((invalidationState & invalidation) == invalidation)
return false;
// A DrawNode invalidation should always invalidate.
bool anyInvalidated = (invalidation & Invalidation.DrawNode) > 0;
// Invalidate all layout members that at least partly match the given invalidation type.
foreach (var member in layoutMembers)
{
Invalidation memberInvalidation = invalidation & member.InvalidationType;
if (memberInvalidation > 0 && member.InvalidationCondition?.Invoke(this, memberInvalidation) != false)
if (memberInvalidation == 0)
continue;
if (member.InvalidationCondition?.Invoke(this, memberInvalidation) != false)
anyInvalidated |= member.Invalidate();
}
// Allow any custom invalidation to take place.
anyInvalidated |= OnInvalidate(invalidation);
if (anyInvalidated)
@@ -1764,12 +1791,22 @@ namespace osu.Framework.Graphics
Invalidated?.Invoke(this);
// Trim off some invalidation flags that should never affect drawable states (these will always propagate)
InvalidationState |= invalidation & ~(Invalidation.DrawNode | Invalidation.Parent);
// Trim the invalidation flags that should never affect drawable states and are only used as special markers (these will always propagate).
invalidation &= ~(Invalidation.DrawNode | Invalidation.Parent);
invalidationState |= invalidation;
return anyInvalidated;
}
/// <summary>
/// Invoked when the layout of this <see cref="Drawable"/> was invalidated.
/// </summary>
/// <remarks>
/// This should be used to perform any custom invalidation logic that cannot be described as a layout.
/// </remarks>
/// <param name="invalidation">The flags that the this <see cref="Drawable"/> was invalidated with.</param>
/// <returns>Whether any custom invalidation was performed. Must be true if the <see cref="DrawNode"/> for this <see cref="Drawable"/> is to be invalidated.</returns>
protected virtual bool OnInvalidate(Invalidation invalidation) => false;
public Invalidation InvalidationFromParentSize

25
osu.Framework/Layout/LayoutMember.cs
View File

@@ -10,19 +10,41 @@ namespace osu.Framework.Layout
public abstract class LayoutMember
{
/// <summary>
/// The <see cref="Invalidation"/> flags this <see cref="LayoutMember"/> responds to.
/// </summary>
public readonly Invalidation InvalidationType;
/// <summary>
/// Any extra conditions that must be satisfied before this <see cref="LayoutMember"/> is invalidated.
/// </summary>
public readonly InvalidationConditionDelegate InvalidationCondition;
/// <summary>
/// The <see cref="Drawable"/> containing this <see cref="LayoutMember"/>.
/// </summary>
internal Drawable Parent;
/// <summary>
/// Creates a new <see cref="LayoutMember"/>.
/// </summary>
/// <param name="invalidationType">The <see cref="Invalidation"/> flags that will invalidate this <see cref="LayoutMember"/>.</param>
/// <param name="invalidationCondition">Any extra conditions that must be satisfied before this <see cref="LayoutMember"/> is invalidated.</param>
protected LayoutMember(Invalidation invalidationType, InvalidationConditionDelegate invalidationCondition = null)
{
InvalidationType = invalidationType;
InvalidationCondition = invalidationCondition;
}
/// <summary>
/// Whether this <see cref="LayoutMember"/> is valid.
/// </summary>
public bool IsValid { get; private set; }
/// <summary>
/// Invalidates this <see cref="LayoutMember"/>.
/// </summary>
/// <returns>Whether any invalidation occurred.</returns>
public bool Invalidate()
{
if (!IsValid)
@@ -33,6 +55,9 @@ namespace osu.Framework.Layout
return true;
}
/// <summary>
/// Validates this <see cref="LayoutMember"/>.
/// </summary>
protected void Validate()
{
if (IsValid)

17
osu.Framework/Layout/LayoutValue.cs
View File

@@ -8,16 +8,29 @@ namespace osu.Framework.Layout
{
public class LayoutValue : LayoutMember
{
/// <summary>
/// Creates a new <see cref="LayoutValue"/>.
/// </summary>
/// <param name="invalidationType">The <see cref="Invalidation"/> flags that will invalidate this <see cref="LayoutValue"/>.</param>
/// <param name="invalidationCondition">Any extra conditions that must be satisfied before this <see cref="LayoutValue"/> is invalidated.</param>
public LayoutValue(Invalidation invalidationType, InvalidationConditionDelegate invalidationCondition = null)
: base(invalidationType, invalidationCondition)
{
}
/// <summary>
/// Validates this <see cref="LayoutValue"/>.
/// </summary>
public new void Validate() => base.Validate();
}
public class LayoutValue<T> : LayoutMember
{
/// <summary>
/// Creates a new <see cref="LayoutValue{T}"/>.
/// </summary>
/// <param name="invalidationType">The <see cref="Invalidation"/> flags that will invalidate this <see cref="LayoutValue{T}"/>.</param>
/// <param name="invalidationCondition">Any extra conditions that must be satisfied before this <see cref="LayoutValue{T}"/> is invalidated.</param>
public LayoutValue(Invalidation invalidationType, InvalidationConditionDelegate invalidationCondition = null)
: base(invalidationType, invalidationCondition)
{
@@ -25,6 +38,10 @@ namespace osu.Framework.Layout
private T value;
/// <summary>
/// The current value.
/// </summary>
/// <exception cref="InvalidOperationException">If accessed while <see cref="LayoutMember.IsValid"/> is <code>false</code>.</exception>
public T Value
{
get