Add property viewer to DrawVisualiser #780

luaneko · 2017-06-03T06:07:49Z

Added PropertyDisplay which lists all public property values and some graphical changes like highlighting.
Also a commit which simply overrides some ToString()s for better property viewing.

Also fixes #291

For better reading in PropertyDisplay

osu.Framework/Audio/AudioManager.cs

@@ -371,5 +371,7 @@ private void checkAudioDeviceChanged()
            {
            }
        }
+
+        public override string ToString() => $@"AudioManager ({currentAudioDevice})";


osu.Framework/Lists/SortedList.cs

@@ -63,6 +63,8 @@ private int getAdditionIndex(T value)
            return index;
        }

+        public override string ToString() => $@"{GetType().Name} ({Count} items)";


Tom94 · 2017-06-03T07:53:23Z

Looks very nice now! I have only a few more requests before I think this is ready for merging:

As long as the property viewer is disabled, no VisualisedDrawable should be highlighted.
Only the Drawable whose properties are shown should be highlighted; not the entire subtree.
When highlighting a VisualisedDrawable via right-click the property viewer should automatically become enabled if it wasn't before.
The "Up one parent" button shouldn't change the highlighted VisualisedDrawable.
Can you make properties flash if their value changes? That would be super useful to spot which part of the visualised drawable is active, and it can help pull attention to single-frame on-off toggles. Use Drawable.FlashColour for this and use a different colour from the one used to highlight hovered properties.

peppy · 2017-06-04T03:54:33Z

Time and BoundingBox are still jumping around like crazy due to lack of rounding.
OnLoadComplete is always red, which would suggest it's getting fired every frame. I don't think this is the case.

osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

+                if (viz.highlighted == this)
+                    HighlightTarget?.Invoke(null);
+
+                else HighlightTarget?.Invoke(this);


Tom94 · 2017-06-04T09:57:49Z

The property window gets enabled when re-targeting other drawables. That shouldn't happen. The properties window state should be totally independent from drawable selection. Only highlighting via right-click or toggling via the "Properties" button should change its state.

osu.Framework/MathUtils/Precision.cs


-            return AlmostEquals(value, rounded, acceptableDifference) ? rounded : value;
+            return rounded == value ? rounded : value;


osu.Framework/MathUtils/Precision.cs

@@ -53,7 +53,7 @@ public static double Round(double value, int numOfDigits = 7)

        public static float Round(float value, int numOfDigits = 3)


smoogipoo

There are more improvements I'd like to see to the draw visualiser but this is a good start 👍

poop 💩

osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

+        {
+            if (args.Button == MouseButton.Right)
+            {
+                HighlightTarget?.Invoke(viz.Highlighted == this ? null : this);


osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

+        public void Collapse()
+        {
+            if (viz.Highlighted == this)
+                return;


osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

-            updateSpecifics();
+            if (Flow.IsPresent)
+                Collapse();
+


osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

@@ -30,7 +31,8 @@ public int Compare(VisualisedDrawable x, VisualisedDrawable y)

        public Drawable Target { get; }

-        private readonly Box textBg;
+        private readonly Box background;
+        internal readonly Box highlightBackground;


osu.Framework/Graphics/Visualisation/DrawVisualiser.cs

@@ -186,6 +269,26 @@ private VisualisedDrawable createVisualisedDrawable(VisualisedDrawable parent, D

            return vis;
        }


osu.Framework/Graphics/Visualisation/DrawVisualiser.cs

@@ -159,6 +226,21 @@ private void runUpdate()

            visualise(Target, targetDrawable);
        }


osu.Framework/Graphics/Visualisation/DrawVisualiser.cs

+
+            propertyDisplay.Add(
+                ((IEnumerable<MemberInfo>)type.GetProperties(BindingFlags.Instance | BindingFlags.Public))      // Get all properties
+                .Concat(type.GetFields(BindingFlags.Instance | BindingFlags.Public))                            // And all fields


osu.Framework/Graphics/Visualisation/DrawVisualiser.cs

                {
-                    Depth = float.MinValue,
+                    Depth = float.MinValue


peppy · 2017-06-13T00:15:51Z

@paparony03 you still alive?

smoogipoo

I think there are more code styling improvements that can be made, but I will do so a bit later.

osu.Framework/osu.Framework.csproj

@@ -1,391 +1,392 @@
-<?xml version="1.0" encoding="utf-8"?>


osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

        protected override bool OnClick(InputState state)
        {
-            Flow.Alpha = Flow.Alpha > 0 ? 0 : 1;
-            updateSpecifics();
+            if (Flow.IsPresent)


osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs

+        {
+            get
+            {
+                return highlightBackground.Alpha > 0;


osu.Framework/Graphics/Visualisation/PropertyDisplay.cs

+        }
+    }
+
+    internal class PropertyItem : Container


osu.Framework/Graphics/Visualisation/DrawVisualiser.cs


 namespace osu.Framework.Graphics.Visualisation
 {
    public class DrawVisualiser : OverlayContainer
    {
-        private readonly TreeContainer treeContainer;
+        internal readonly TreeContainer TreeContainer;
+        internal VisualisedDrawable HighlightedTarget;


smoogipoo · 2017-06-16T11:36:32Z

Properties panel looks bad hiding when selecting a new drawable.

.

paparony03 added 3 commits June 3, 2017 15:44

Better visualizer

9811970

Also fixes #291

Override ToStrings

a2d6ce0

For better reading in PropertyDisplay

Bottom-right display

92a0322

Tom94 reviewed Jun 3, 2017

View reviewed changes

osu.Framework/Audio/AudioManager.cs Outdated

@@ -371,5 +371,7 @@ private void checkAudioDeviceChanged()

{

}

}

public override string ToString() => $@"AudioManager ({currentAudioDevice})";

This comment was marked as off-topic.

Sign in to view

Tom94 reviewed Jun 3, 2017

View reviewed changes

osu.Framework/Lists/SortedList.cs Outdated

@@ -63,6 +63,8 @@ private int getAdditionIndex(T value)

return index;

}

public override string ToString() => $@"{GetType().Name} ({Count} items)";

This comment was marked as off-topic.

Sign in to view

paparony03 added 5 commits June 3, 2017 16:15

Little fixes

7c10866

Attach PropertyDisplay to highlight

d691fa8

Parent highlighting

2d6495f

Truncate double

e96128c

Appear right next to the tree

442cd0e

paparony03 added 2 commits June 4, 2017 10:27

Suggestions

e02fba2

Unnecessary

7165cf6

Tom94 reviewed Jun 4, 2017

View reviewed changes

osu.Framework/Graphics/Visualisation/VisualisedDrawable.cs Outdated

if (viz.highlighted == this)

HighlightTarget?.Invoke(null);

else HighlightTarget?.Invoke(this);

This comment was marked as off-topic.

Sign in to view

paparony03 added 4 commits June 5, 2017 16:02

AlmostRounded for near integer rounding

57ca2fb

Fixes

e82ed0c

Trim whitespace

e5cc325

Better use of Math.Round

2551db6

Tom94 reviewed Jun 5, 2017

View reviewed changes

osu.Framework/MathUtils/Precision.cs Outdated

return AlmostEquals(value, rounded, acceptableDifference) ? rounded : value;

return rounded == value ? rounded : value;

This comment was marked as off-topic.

Sign in to view

This comment was marked as off-topic.

Sign in to view

paparony03 added 2 commits June 5, 2017 16:21

Just round

4d40b47

Semicolon

5c78b42

Tom94 reviewed Jun 5, 2017

View reviewed changes

osu.Framework/MathUtils/Precision.cs Outdated

@@ -53,7 +53,7 @@ public static double Round(double value, int numOfDigits = 7)

public static float Round(float value, int numOfDigits = 3)

This comment was marked as off-topic.

Sign in to view

paparony03 added 2 commits June 5, 2017 16:38

Add xml documentation

051fd0e

Merge branch 'master' into better-viz

95f609c

peppy changed the title ~~Better visualizer~~ Add property viewer to DrawVisualiser Jun 6, 2017

Dan Balasescu added 2 commits June 7, 2017 12:37

Merge branch 'master' into better-viz

c6ef468

Cleanups.

372dc8d

smoogipoo previously approved these changes Jun 7, 2017

View reviewed changes

CI cleanups.

c5dd98a

smoogipoo requested changes Jun 7, 2017

View reviewed changes

paparony03 added 3 commits June 13, 2017 16:52

Cleanups and fixes

8655843

Merge branch 'master' into better-viz

c940bc2

Fix EdgeEffect ToString when None

dab603a

smoogipoo previously requested changes Jun 14, 2017

View reviewed changes

paparony03 and others added 8 commits June 14, 2017 15:40

Code styling improvements

634b888

Move PropertyItem into PropertyDisplay

5ba107b

Use ? expression

26a1bc1

Merge branch 'master' into better-viz

e7768ab

Combine PropertyDisplay and DrawVisualiser

afb61e5

Standardise padding and text sizes

29417a4

Improve right click behaviour

e2afd04

Styling improvements

2e8e7e3

Don't hide property viewer when double-clicking a new target

8f632b9

peppy approved these changes Jun 16, 2017

View reviewed changes

peppy merged commit 3dd7516 into ppy:master Jun 16, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add property viewer to DrawVisualiser #780

Add property viewer to DrawVisualiser #780

luaneko commented Jun 3, 2017

This comment was marked as off-topic.

This comment was marked as off-topic.

Tom94 commented Jun 3, 2017

peppy commented Jun 4, 2017

This comment was marked as off-topic.

Tom94 commented Jun 4, 2017

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

smoogipoo left a comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

peppy commented Jun 13, 2017

smoogipoo left a comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

smoogipoo commented Jun 16, 2017


		return AlmostEquals(value, rounded, acceptableDifference) ? rounded : value;
		return rounded == value ? rounded : value;

		@@ -53,7 +53,7 @@ public static double Round(double value, int numOfDigits = 7)

		public static float Round(float value, int numOfDigits = 3)

		@@ -186,6 +269,26 @@ private VisualisedDrawable createVisualisedDrawable(VisualisedDrawable parent, D

		return vis;
		}

		@@ -159,6 +226,21 @@ private void runUpdate()

		visualise(Target, targetDrawable);
		}

Add property viewer to DrawVisualiser #780

Add property viewer to DrawVisualiser #780

Conversation

luaneko commented Jun 3, 2017

This comment was marked as off-topic.

This comment was marked as off-topic.

Tom94 commented Jun 3, 2017

peppy commented Jun 4, 2017

This comment was marked as off-topic.

Tom94 commented Jun 4, 2017

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

smoogipoo left a comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

peppy commented Jun 13, 2017

smoogipoo left a comment

Choose a reason for hiding this comment

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

This comment was marked as off-topic.

smoogipoo commented Jun 16, 2017