From 51bec1efbd3434c2461355e6f8fe64205005b577 Mon Sep 17 00:00:00 2001
From: Jean-Yves Tinevez <tinevez@pasteur.fr>
Date: Mon, 11 Nov 2024 16:18:17 +0100
Subject: [PATCH] A behaviour to scroll through time-points in bdv with
 mouse-wheel.

Not binded by default.
We have to make special behaviour for it, because the behaviour
mechanism for mouse-wheel is implemented in a special behaviour
hierarchy.
---
 .../mamut/views/bdv/MamutViewBdv.java         |  2 +
 .../bdv/BigDataViewerBehavioursMamut.java     | 68 +++++++++++++++++++
 2 files changed, 70 insertions(+)
 create mode 100644 src/main/java/org/mastodon/views/bdv/BigDataViewerBehavioursMamut.java

diff --git a/src/main/java/org/mastodon/mamut/views/bdv/MamutViewBdv.java b/src/main/java/org/mastodon/mamut/views/bdv/MamutViewBdv.java
index 4eeeb12e5..c64220625 100644
--- a/src/main/java/org/mastodon/mamut/views/bdv/MamutViewBdv.java
+++ b/src/main/java/org/mastodon/mamut/views/bdv/MamutViewBdv.java
@@ -77,6 +77,7 @@
 import org.mastodon.ui.keymap.KeyConfigContexts;
 import org.mastodon.views.bdv.BdvContextProvider;
 import org.mastodon.views.bdv.BigDataViewerActionsMamut;
+import org.mastodon.views.bdv.BigDataViewerBehavioursMamut;
 import org.mastodon.views.bdv.BigDataViewerMamut;
 import org.mastodon.views.bdv.SharedBigDataViewerData;
 import org.mastodon.views.bdv.ViewerFrameMamut;
@@ -149,6 +150,7 @@ public MamutViewBdv( final ProjectModel appModel )
 
 		MastodonFrameViewActions.install( viewActions, this );
 		BigDataViewerActionsMamut.install( viewActions, bdv );
+		BigDataViewerBehavioursMamut.install( viewBehaviours, bdv );
 
 		/*
 		 * We have to build the coloring menu handles now. But the other actions
diff --git a/src/main/java/org/mastodon/views/bdv/BigDataViewerBehavioursMamut.java b/src/main/java/org/mastodon/views/bdv/BigDataViewerBehavioursMamut.java
new file mode 100644
index 000000000..a6a90ef7f
--- /dev/null
+++ b/src/main/java/org/mastodon/views/bdv/BigDataViewerBehavioursMamut.java
@@ -0,0 +1,68 @@
+package org.mastodon.views.bdv;
+
+import org.mastodon.ui.keymap.KeyConfigContexts;
+import org.mastodon.ui.keymap.KeyConfigScopes;
+import org.mastodon.views.bdv.overlay.OverlayEdge;
+import org.mastodon.views.bdv.overlay.OverlayVertex;
+import org.scijava.plugin.Plugin;
+import org.scijava.ui.behaviour.ScrollBehaviour;
+import org.scijava.ui.behaviour.io.gui.CommandDescriptionProvider;
+import org.scijava.ui.behaviour.io.gui.CommandDescriptions;
+import org.scijava.ui.behaviour.util.Behaviours;
+
+import bdv.viewer.ViewerPanel;
+
+public class BigDataViewerBehavioursMamut
+{
+
+	public static final String SCROLL_TIMEPOINTS = "scroll timepoint";
+
+	private static final String[] SCROLL_TIMEPOINTS_KEYS = new String[] { "not mapped" };
+
+	public static < V extends OverlayVertex< V, E >, E extends OverlayEdge< E, V > > void install(
+			final Behaviours behaviours,
+			final BigDataViewerMamut bdv )
+	{
+		behaviours.behaviour( new ScrollTimePointsBehaviour( bdv.getViewer() ), SCROLL_TIMEPOINTS, SCROLL_TIMEPOINTS_KEYS );
+	}
+
+	/*
+	 * Command descriptions for all provided commands
+	 */
+	@Plugin( type = CommandDescriptionProvider.class )
+	public static class Descriptions extends CommandDescriptionProvider
+	{
+		public Descriptions()
+		{
+			super( KeyConfigScopes.MASTODON, KeyConfigContexts.BIGDATAVIEWER );
+		}
+
+		@Override
+		public void getCommandDescriptions( final CommandDescriptions descriptions )
+		{
+			descriptions.add( SCROLL_TIMEPOINTS, SCROLL_TIMEPOINTS_KEYS, "Use mouse-wheel to scroll through time-points." );
+		}
+	}
+
+	private static class ScrollTimePointsBehaviour implements ScrollBehaviour
+	{
+
+		private final ViewerPanel viewer;
+
+		public ScrollTimePointsBehaviour( final ViewerPanel viewerPanel )
+		{
+			this.viewer = viewerPanel;
+		}
+
+		@Override
+		public void scroll( final double wheelRotation, final boolean isHorizontal, final int x, final int y )
+		{
+			if ( wheelRotation > 0 )
+				viewer.nextTimePoint();
+			else
+				viewer.previousTimePoint();
+		}
+
+	}
+
+}