From 869def26dbfe7ee6c21c1669efcb0924c2c4317c Mon Sep 17 00:00:00 2001
From: Jonathan Wilkes <jon.w.wilkes@gmail.com>
Date: Sat, 5 Aug 2017 18:00:53 -0400
Subject: [PATCH] throttle gui_canvas_get_scroll instead of debouncing
while debouncing this call can save re-layouts of the DOM, with indeterminate
streams of redraws coming from Pd it can result in no re-layouts at all. In
the case where a user opens a subpatch that has a redraw triggered by a
[metro 200] object, there may not even be an initial layout. This can result
in the patchsvg never getting its viewBox set and appearing not to display
at all.
One workaround could be to do an initial call immediately after mapping the
window, but there are still cases (like resizing a window or adding objects)
that could result in putting off a needed re-layout for too long.
So instead of debouncing, we throttle. This means there will only be a
single call every 250ms (or whatever value we want), but that call is
_guaranteed_ to happen at the end of the chosen duration. So for a stream
of redraws coming from a [metro 200] we'll get a re-layout every 250ms. That's
more expensive than putting them off indefinitely, but obviously more
responsive and usable.
Ideally we would send a do_getscroll _first_ and then wait 250ms. That would
result in a more responsive UX-- as it is the 250ms makes the initial window
rendering appear sluggish. Unfortunately there's still some kind of race
between the rendering of the window menu and the window size measurements
reported by the DOM API-- if we measure too early the vertical measurement is
too big, resulting in an unnecessary vertical scrollbar.
So instead we wait 250ms and call do_getscroll after. This apparently
gives enough time for the menubar to render and for the DOM to take it into
account when feeding us the window dimensions. But if that race can be fixed
or worked around, we can change the behavior here to call first then wait
second.
---
pd/nw/pdgui.js | 10 +++++++---
1 file changed, 7 insertions(+), 3 deletions(-)
diff --git a/pd/nw/pdgui.js b/pd/nw/pdgui.js
index aa9c5161b..7fd8db9f8 100644
--- a/pd/nw/pdgui.js
+++ b/pd/nw/pdgui.js
@@ -5185,7 +5185,7 @@ function canvas_params(cid)
}
function do_getscroll(cid) {
- // Since we're throttling these getscroll calls, they can happen after
+ // Since we're debouncing these getscroll calls, they can happen after
// the patch has been closed. We remove the cid from the patchwin
// object on close, so we can just check to see if our Window object has
// been set to null, and if so just return.
@@ -5228,8 +5228,12 @@ var getscroll_var = {};
// graphics from displaying until the user releases the mouse,
// which would be a buggy UI
function gui_canvas_get_scroll(cid) {
- clearTimeout(getscroll_var[cid]);
- getscroll_var[cid] = setTimeout(do_getscroll, 250, cid);
+ if (!getscroll_var[cid]) {
+ getscroll_var[cid] = setTimeout(function() {
+ do_getscroll(cid);
+ getscroll_var[cid] = null;
+ }, 250);
+ }
}
exports.gui_canvas_get_scroll = gui_canvas_get_scroll;
--
GitLab