Controls: refactor interactivity management system by swharden · Pull Request #4053 · ScottPlot/ScottPlot

swharden · 2024-07-07T01:54:25Z

This PR explores alternative strategies for customizing user interactivity in graphical environments.

Primary Goals

Ability to re-map inputs with actions (e.g., right-click-drag pan)
Ability to add arbitrary inputs (e.g., two-finger pinch)
Ability to customize actions (e.g., increasing sensitivity of right-click-drag zoom)
Ability to add arbitrary actions (e.g., holding left and right mouse buttons down while dragging only pans horizontally or vertically)
Improved ability to unit test interactive behavior
Ability to opt-in to the new system, allowing existing users to continue using the original Interaction.cs and PlotActions.cs system while the new system matures.
Related: Controls: refactor input binding system #3186

Architecture

User inputs are structs that inherit IUserInput and contain any properties that may be unique to that type of input (e.g., LeftMouseDown has a stores a Pixel and DateTime)
User input actions are classes that contain logic for when and how to respond to user inputs, including whether to refresh the plot or stop processing further actions (e.g., LeftClickDragPan engages only after LeftMouseDown happens and MouseMove moved by more than 5 pixels, preventing other actions from being processed until LeftMouseUp occurs)
Plot controls have a UserInputProcessor that they pass user inputs into, and it holds a collection of user input actions that decide if and how to respond to the events. Users can remove actions (like double-click benchmark), add custom actions (like holding the A key while left-click-dragging will only pan diagonally), and even pass custom input types through (like three-finger-drag).

Rules to Implement

Items are checked only when implemented and unit tests are in place

to facilitate experimentation related to alternate control interaction systems #3186

Previously it was confusing because panning by a mouse delta pixels needs to be done by panning the axis limits that number of pixels in the OPPOSITE direction

…nses

Create a new static class to wrap shared logic between old and new interaction controllers

…action

swharden · 2024-07-18T23:30:22Z

I'm getting close to merging this. The new behavior is demonstrated in the "custom mouse behavior" demo app.

The code shows the general style of how the new API can be used.

ScottPlot/src/ScottPlot5/ScottPlot5 Demos/ScottPlot5 WinForms Demo/Demos/CustomMouseActions.cs

Lines 11 to 88 in 1bd1400

    
           public CustomMouseActions() 
        
           { 
        
               InitializeComponent(); 
        
               // Disable the old input system and enable the new one. 
        
               // The new one will be enabled by default in a future release. 
        
               formsPlot1.Interaction.IsEnabled = false; 
        
               formsPlot1.UserInputProcessor.IsEnabled = true; 
        
               formsPlot1.Plot.Add.Signal(ScottPlot.Generate.Sin()); 
        
               formsPlot1.Plot.Add.Signal(ScottPlot.Generate.Cos()); 
        
               btnDefault.Click += (s, e) => 
        
               { 
        
                   richTextBox1.Text = "left-click-drag pan, right-click-drag zoom, middle-click autoscale, " + 
        
                       "middle-click-drag zoom rectangle, alt+left-click-drag zoom rectangle, right-click menu, " + 
        
                       "double-click benchmark, scroll wheel zoom, arrow keys pan, " + 
        
                       "shift or alt with arrow keys pans more or less, ctrl+arrow keys zoom"; 
        
                   formsPlot1.UserInputProcessor.IsEnabled = true; 
        
                   formsPlot1.UserInputProcessor.Reset(); 
        
               }; 
        
               btnDisable.Click += (s, e) => 
        
               { 
        
                   richTextBox1.Text = "Mouse and keyboard events are disabled"; 
        
                   formsPlot1.UserInputProcessor.IsEnabled = false; 
        
               }; 
        
               btnCustom.Click += (s, e) => 
        
               { 
        
                   richTextBox1.Text = "middle-click-drag pan, right-click-drag zoom rectangle, " + 
        
                       "right-click autoscale, left-click menu, Q key autoscale, WASD keys pan"; 
        
                   formsPlot1.UserInputProcessor.IsEnabled = true; 
        
                   // remove all existing responses so we can create and add our own 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Clear(); 
        
                   // middle-click-drag pan 
        
                   var panButton = ScottPlot.Interactivity.StandardMouseButtons.Middle; 
        
                   var panResponse = new ScottPlot.Interactivity.UserActionResponses.MouseDragPan(panButton); 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(panResponse); 
        
                   // right-click-drag zoom rectangle 
        
                   var zoomRectangleButton = ScottPlot.Interactivity.StandardMouseButtons.Right; 
        
                   var zoomRectangleResponse = new ScottPlot.Interactivity.UserActionResponses.MouseDragZoomRectangle(zoomRectangleButton); 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(zoomRectangleResponse); 
        
                   // right-click autoscale 
        
                   var autoscaleButton = ScottPlot.Interactivity.StandardMouseButtons.Right; 
        
                   var autoscaleResponse = new ScottPlot.Interactivity.UserActionResponses.SingleClickAutoscale(autoscaleButton); 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(autoscaleResponse); 
        
                   // left-click menu 
        
                   var menuButton = ScottPlot.Interactivity.StandardMouseButtons.Left; 
        
                   var menuResponse = new ScottPlot.Interactivity.UserActionResponses.SingleClickContextMenu(menuButton); 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(menuResponse); 
        
                   // Q key autoscale too 
        
                   var autoscaleKey = new ScottPlot.Interactivity.Key("Q"); 
        
                   Action<ScottPlot.Plot, ScottPlot.Pixel> autoscaleAction = (plot, pixel) => plot.Axes.AutoScale(); 
        
                   var autoscaleKeyResponse = new ScottPlot.Interactivity.UserActionResponses.KeyPressResponse(autoscaleKey, autoscaleAction); 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(autoscaleKeyResponse); 
        
                   // WASD keys pan 
        
                   var keyPanResponse = new ScottPlot.Interactivity.UserActionResponses.KeyboardPanAndZoom() 
        
                   { 
        
                       PanUpKey = new ScottPlot.Interactivity.Key("W"), 
        
                       PanLeftKey = new ScottPlot.Interactivity.Key("A"), 
        
                       PanDownKey = new ScottPlot.Interactivity.Key("S"), 
        
                       PanRightKey = new ScottPlot.Interactivity.Key("D"), 
        
                   }; 
        
                   formsPlot1.UserInputProcessor.UserActionResponses.Add(keyPanResponse); 
        
               }; 
        
               Load += (s, e) => btnDefault.PerformClick(); 
        
           }

required by all plot controls after ScottPlot#4053

swharden added 3 commits July 6, 2024 17:06

Create Interactivity Inspector project

2a36a1e

to facilitate experimentation related to alternate control interaction systems #3186

Interactivity: setup basic event processing system

2fd71d6

Interactivity: replace event queue with pass-through system

91b7ef5

swharden linked an issue Jul 7, 2024 that may be closed by this pull request

Controls: refactor input binding system #3186

Closed

swharden added 11 commits July 7, 2024 09:39

Interactivity: add all currently supported user events

28e840a

Interactivity: implement basic pan and zoom actions

653af3b

Interactivity: support primary responses in cases of overlapping actions

53559bc

Interactivity: add a pressed key state manager

6df9af3

Interactivity: DefaultInputs → UserInputs

5258c22

IKey: use string Name to uniquely identify keys

39e06b6

Interactivity: key-based axis locking during pan

4c1a905

Tests: test left-click-drag interacitivty

2abe756

Pixel: add methods for moving in a single direction

37d879f

Axies: make pixel panning more explicit

9eff72f

Previously it was confusing because panning by a mouse delta pixels needs to be done by panning the axis limits that number of pixels in the OPPOSITE direction

Tests: right-click-drag zoom

4893331

swharden added the ⚠️ HIGH PRIORITY label Jul 9, 2024

swharden added 14 commits July 9, 2024 19:26

Interactivity: shift and ctrl modifiers for zoom rectangle

947b702

Interactivity: shift and ctrl modifiers for scroll wheel zoom

a57285f

Interactivity: alt + left-click-drag zoom rectangle

08a63b8

Interactivity: improve support for parallel processing

ba04e01

Interactivity: improve primary handler logic for overlapping UI respo…

beb7465

…nses

Interactivity: right-click context menu

640ec65

Tests: create mock plot control to facilitate UI testing

4c7b2e3

Tests: right-click context menu

22053b3

Interactivity: double-click benchmark

9fce89d

Interactivity: add support for keyboard pan and zoom

cea24ba

Interactivity: configurable keys for pan/zoom

2080ec0

Interactivity: convert key from an interface to a concrete class

985a724

Interactivity: use UserAction and PlotResponse naming

b724961

Interactivity: refactor to use mouse button interfaces

ef7ae9d

swharden added 18 commits July 14, 2024 17:14

WinUI: setup new user input processor

3be3ccd

WPF: setup new user input processor

f47668b

Tests: MockPlotControl for automated UI testing

304397d

Tests: panning by pixel no long requires a pre-render

cf3b421

InteractivityInspector: compare old and new systems

2e876d8

Interaction: add IsEnabled property (mimicking UserInputProcessor API)

109033e

Interactivity: mouse wheel zoom affects only initiated axis

6bc3d92

MouseAxisManipulation

8640237

Create a new static class to wrap shared logic between old and new interaction controllers

MouseAxisManipulation: support zoom rectangle

c8c4191

MouseAxisManipulation: use shared autoscale code

64e9618

MouseDragPan: evaluate distance using absolute units

ff9920f

UserActionProcessor: setting IsEnabled deactivates IPlotControl.Inter…

80d87e5

…action

Update CHANGELOG.md

c776ad3

MouseAxisManipulation: improve support for Plot.ScaleFactor

7219343

MultiAxisLimits: primitive for storing limits for all axes

bf97853

Controls: add autoscale to right-click menu

7303aa2

UserActionProcessor: Reset() clears keyboard state

bf0bf8d

Demo: custom mouse actions use new user input processor

baa03f2

swharden marked this pull request as ready for review July 18, 2024 23:27

Demo: remove unused pan key variable

1bd1400

swharden mentioned this pull request Jul 18, 2024

Controls: refactor input binding system #3186

Closed

swharden merged commit 4078033 into main Jul 19, 2024

swharden deleted the 3186 branch July 19, 2024 15:24

swharden mentioned this pull request Jul 20, 2024

Polar Axis #4055

Merged

swharden added a commit to ByteSore/ScottPlot that referenced this pull request Jul 21, 2024

MauiPlot: add UserInputProcessor

7fdb1c3

required by all plot controls after ScottPlot#4053

This was referenced Jul 21, 2024

Maui: improve the ScottPlot Maui control and fix the sandbox app #4065

Closed

DataStreamer2: Improve support for rotated plots #4093

Merged

swharden mentioned this pull request Sep 6, 2024

Interactivity: obsolete Interaction and direct people toward UserInputProcessor #4224

Closed

swharden mentioned this pull request Oct 12, 2024

Controls: deprecate Interaction in favor of UserInputProcessor #4322

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Controls: refactor interactivity management system#4053

Controls: refactor interactivity management system#4053
swharden merged 60 commits intomainfrom
3186

swharden commented Jul 7, 2024 •

edited

Loading

Uh oh!

swharden commented Jul 18, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Conversation

swharden commented Jul 7, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Primary Goals

Architecture

Rules to Implement

Uh oh!

swharden commented Jul 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

swharden commented Jul 7, 2024 •

edited

Loading

swharden commented Jul 18, 2024 •

edited

Loading