UX adjustments for stream mode

- Flyto path when double-clicking on it in PathManagerUI
- Warn when imported files don't match image dimensions

Author: tferr

src/main/java/sc/fiji/snt/PathManagerUI.java

@@ -508,6 +508,22 @@ public void mousePressed(final MouseEvent me) {
                 handleMouseEvent(me);
             }
 
+            @Override
+            public void mouseClicked(final MouseEvent me) {
+                if (me.getClickCount() != 2 || !SwingUtilities.isLeftMouseButton(me)) return;
+                final TreePath tp = tree.getPathForLocation(me.getX(), me.getY());
+                if (tp == null) return;
+                final DefaultMutableTreeNode node = (DefaultMutableTreeNode) tp.getLastPathComponent();
+                if (node.isRoot()) return;
+                if (plugin.isStreamMode()) {
+                    navToolbar.zoomToBoundingBox(List.of((Path) node.getUserObject()));
+                } else if (tree.isExpanded(tp)) {
+                    tree.collapsePath(tp);
+                } else {
+                    tree.expandPath(tp);
+                }
+            }
+
             private void handleMouseEvent(final MouseEvent e) {
                 if (!e.isConsumed() && tree.getRowForLocation(e.getX(), e.getY()) == -1) {
                     tree.clearSelection(); // Deselect when clicking on 'empty space'
@@ -1678,6 +1694,9 @@ public HelpfulJTree() {
             getSelectionModel().setSelectionMode(TreeSelectionModel.DISCONTIGUOUS_TREE_SELECTION);
             setExpandsSelectedPaths(true);
             setScrollsOnExpand(true);
+            // Native double-click toggle is replaced by our own handler below, so that in
+            // stream mode double-click can zoom to the path instead of expanding/collapsing
+            setToggleClickCount(0);
             setRowHeight(getFontMetrics(getFont()).getHeight()); // otherwise viewport too small!?
             searchable = new TreeSearchable(this);
             final Timer timer = new Timer(400, ev -> getSNT().getUI().getRecorder(false)
@@ -5962,11 +5981,22 @@ private boolean ensureNodeValues(final Collection<Path> paths) {
         private JButton zoomToPathsButton() {
             final JButton button = new JButton(IconFactory.buttonIcon(IconFactory.GLYPH.SEARCH_PLUS, 1f));
             button.setActionCommand("Zoom To Selected Paths");
-            button.addActionListener( e -> zoomToBoundingBox(getSelectedPathsUsingToolbarOptions(true)));
+            button.addActionListener( e -> {
+                final Collection<Path> paths = getSelectedPathsUsingToolbarOptions(true);
+                zoomToBoundingBox(paths);
+                if (paths != null && paths.size()==1) doubleClickZoomTipIfNeeded();
+            });
             button.setToolTipText("Zoom to selected path(s)");
             return button;
         }
 
+        private void doubleClickZoomTipIfNeeded() {
+            if (!plugin.isStreamMode() || plugin.getPrefs().getTemp("stream-dclick-zoom-tip-skipnag", false)) return;
+            final Boolean skipNag = guiUtils.getPersistentWarning("Tip: Double-click a single path in the list "
+                    + "to zoom to it directly, without using this button.", "Navigation Tip");
+            if (skipNag != null) plugin.getPrefs().setTemp("stream-dclick-zoom-tip-skipnag", skipNag);
+        }
+
         private JButton bookmarkButton() {
             final ActionListener action = e -> {
                 final Collection<Path> paths = getSelectedPathsUsingToolbarOptions(true);

src/main/java/sc/fiji/snt/SNTUI.java

@@ -140,7 +140,7 @@ public class SNTUI extends JDialog {
 
     // UI controls promoted from Options tab
     private JCheckBox diametersCheckBox; // used for for quick-toggle access
-    private JPanel optionsPanel; // Options tab group holding diametersCheckBox and its sub-panels. //
+    private final JPanel optionsPanel; // Options tab group holding diametersCheckBox and its sub-panels. //
 
     private final SNTCommandFinder commandFinder;
     private ActiveWorker activeWorker;
@@ -1398,7 +1398,7 @@ private void initializeStates() {
         states.put(CALCULATING_HESSIAN_II,simpleState(CALCULATING_HESSIAN_II,"Calculating Hessian (II Image)..",         "Computing Hessian (secondary image)...", true, null));
         states.put(WAITING_FOR_SIGMA_POINT_I, simpleState(WAITING_FOR_SIGMA_POINT_I, "Click on a representative structure...", "Adjusting Hessian (main image)...", false, null));
         states.put(WAITING_FOR_SIGMA_CHOICE,  simpleState(WAITING_FOR_SIGMA_CHOICE,  "Close 'Pick Sigma & Max' to continue...", null, false, null));
-        states.put(LOADING, simpleState(LOADING, "Loading...", null, true, null));
+        states.put(LOADING, simpleState(LOADING, "Loading data...", null, true, null));
         states.put(SAVING,  simpleState(SAVING,  "Saving...",  null, true, null));
         states.put(EDITING, new EditingState());
         states.put(SNT_PAUSED, new SntPausedState());
@@ -2079,18 +2079,8 @@ private void validateImgDimensions() {
         if (plugin.getPrefs().getTemp(SNTPrefs.RESIZE_REQUIRED, false)) {
             final boolean nag = plugin.getPrefs().getTemp("canvasResize-nag", true);
             if (nag) {
-                final StringBuilder sb = new StringBuilder("Some nodes are being displayed outside the image canvas. To visualize them you can:<ul>");
-                String type = "canvas";
-                if (plugin.accessToValidImageData()) {
-                    type = "image";
-                    sb.append("<li>Use IJ's command Image&rarr;Adjust&rarr;Canvas Size... and press <i>Reload</i> in the Data Source widget of the Options pane</li>");
-                    sb.append("<li>Close the current image and create a Display Canvas using <i>Create Canvas</i> in the Options pane</li>");
-                }
-                else {
-                    sb.append("<li>Use the <i>Create/Resize Canvas</i> commands in the Options pane</li>");
-                }
-                sb.append("<li>Replace the current ").append(type).append(" using File&rarr;Choose Tracing Image...</li>");
-                final Boolean userPrompt = guiUtils.getPersistentWarning(sb.toString(), "Image Needs Resizing");
+                final Boolean userPrompt = guiUtils.getPersistentWarning(mismatchedImageWarningMsg(),
+                        "Mismatched Image Dimensions");
                 if (userPrompt != null) // do nothing if user dismissed the dialog
                     plugin.getPrefs().setTemp("canvasResize-nag", !userPrompt);
             } else {
@@ -2099,6 +2089,24 @@ private void validateImgDimensions() {
         }
     }
 
+    private String mismatchedImageWarningMsg() {
+        if (plugin.isStreamMode()) {
+            return "Some nodes are being displayed outside the image volume: Perhaps reconstruction(s) have been loaded from mismatched file(s)?";
+        }
+        final StringBuilder sb = new StringBuilder("Some nodes are being displayed outside the image canvas. To visualize them you can:<ul>");
+        String type = "canvas";
+        if (plugin.accessToValidImageData()) {
+            type = "image";
+            sb.append("<li>Use IJ's command Image&rarr;Adjust&rarr;Canvas Size... and press <i>Reload</i> in the Data Source widget of the Options pane</li>");
+            sb.append("<li>Close the current image and create a Display Canvas using <i>Create Canvas</i> in the Options pane</li>");
+        }
+        else {
+            sb.append("<li>Use the <i>Create/Resize Canvas</i> commands in the Options pane</li>");
+        }
+        sb.append("<li>Replace the current ").append(type).append(" using File&rarr;Choose Tracing Image...</li>");
+        return sb.toString();
+    }
+
     private void updateSinglePaneFlag() {
         if (plugin.getImagePlus(MultiDThreePanes.XZ_PLANE) == null
                 && plugin.getImagePlus(MultiDThreePanes.ZY_PLANE) == null)

src/main/java/sc/fiji/snt/gui/cmds/BigDataLoaderCmd.java

@@ -47,6 +47,7 @@
 import sc.fiji.snt.gui.GuiUtils;
 import sc.fiji.snt.gui.ScriptInstaller;
 import sc.fiji.snt.io.SpimDataUtils;
+import sc.fiji.snt.util.BoundingBox;
 import sc.fiji.snt.util.ImgUtils;
 import sc.fiji.snt.util.SNTColor;
 import sc.fiji.snt.viewer.AbstractBigViewer;
@@ -723,7 +724,51 @@ private void loadReconstructions(final AbstractBigViewer viewer) {
         if (viewer.getSNT() != null) { // tracing capabilities present
             final PathAndFillManager pafm = viewer.getSNT().getPathAndFillManager();
             trees.forEach(tree -> pafm.addTree(tree, tree.getLabel())); // registers as editable Paths
+            // addTree() (unlike addTrees()) intentionally skips this check (see its javadoc), so trigger
+            // it explicitly here. If a SNTUI exists, reuse its own persistent-warning dialog (same one
+            // shown by traditional-mode reconstruction imports) instead of a one-off dialog of our own
+            pafm.validateImageDimensions();
+            if (viewer.getSNT().getUI() != null) {
+                try {
+                    viewer.getSNT().getUI().runCommand("validateImgDimensions");
+                } catch (final IllegalArgumentException ignored) {
+                    // command unavailable in the current UI state; RESIZE_REQUIRED (set above, if
+                    // applicable) remains armed and will surface on the next reconstruction import
+                }
+            }
+        } else {
+            // No SNT/PathAndFillManager in this case (plain, non-tracing viewer): compare directly
+            // against the viewer's own loaded volume instead
+            warnIfOutOfBounds(viewer, trees);
+        }
+    }
+
+    /**
+     * Warns (once, with a permanent opt-out) if {@code trees} fall at least partially outside
+     * {@code viewer}'s loaded volume -- typically a sign that the reconstruction and image files
+     * specified are not a matching pair. Only used for the plain (non-tracing) viewer case; when
+     * tracing capabilities are present, {@link PathAndFillManager#validateImageDimensions()} plus
+     * {@code SNTUI}'s own dialog (see {@link #loadReconstructions}) is used instead
+     */
+    private void warnIfOutOfBounds(final AbstractBigViewer viewer, final Collection<Tree> trees) {
+        final BoundingBox volumeBox = viewer.getBoundingBox();
+        if (volumeBox == null) return;
+        BoundingBox treesBox = null;
+        for (final Tree tree : trees) {
+            final BoundingBox tb = tree.getBoundingBox(true);
+            if (tb == null) continue;
+            if (treesBox == null) treesBox = tb.clone();
+            else treesBox.combine(tb);
+        }
+        if (treesBox == null || volumeBox.contains(treesBox)
+                || prefService.getBoolean(BigDataLoaderCmd.class, "oob-skipnag", false)) {
+            return;
         }
+        final Boolean skipNag = new GuiUtils(null).getPersistentWarning(
+                "The loaded reconstruction(s) fall (at least partially) outside the loaded volume. "
+                        + "This typically indicates the reconstruction and image are not a matching pair.",
+                "Reconstruction Outside Image Bounds");
+        if (skipNag != null) prefService.put(BigDataLoaderCmd.class, "oob-skipnag", skipNag);
     }
 
     /**