Merge pull request #34 from mastodon-sc/optional_time_scaling

Add Optional time scaling for Blender Interactive

Author: stefanhahmann

src/main/java/org/mastodon/blender/Blender3dViewPlugin.java

@@ -31,6 +31,7 @@
 import org.mastodon.app.ui.ViewMenuBuilder;
 import org.mastodon.blender.csv.ExportGraphAsCsvAction;
 import org.mastodon.blender.csv.StartBlenderWithCsvAction;
+import org.mastodon.blender.interactive.BlenderInteractiveCommand;
 import org.mastodon.blender.setup.BlenderSettingsCommand;
 import org.mastodon.blender.setup.BlenderSetup;
 import org.mastodon.mamut.KeyConfigScopes;
@@ -187,17 +188,8 @@ private void updateEnabledActions()
 
 	private void startBlenderView()
 	{
-		if ( projectModel != null )
-		{
-			new Thread(() -> {
-				try {
-					new BlenderController( projectModel );
-				}
-				catch ( StartBlenderException e ) {
-					BlenderSetup.startSetupWithMessage( context, e );
-				}
-			}).start();
-		}
+		context.service( CommandService.class ).run( BlenderInteractiveCommand.class, true, "projectModel", projectModel,
+				"context", projectModel.getContext() );
 	}
 
 	private void startBlenderWithCsv()

src/main/java/org/mastodon/blender/BlenderController.java

@@ -84,15 +84,16 @@ public class BlenderController
 
 	int known_active_object = -1;
 
-	public BlenderController( ProjectModel projectModel ) {
+	public BlenderController( ProjectModel projectModel, int timeScalingFactor )
+	{
 		this.projectModel = projectModel;
 		this.model = projectModel.getModel();
 		this.groupHandle = projectModel.getGroupManager().createGroupHandle();
 		this.groupHandle.setGroupId( -1 );
 		NavigationHandler<Spot, Link> navigationModel = groupHandle.getModel( projectModel.NAVIGATION );
 		this.focusModel = new AutoNavigateFocusModel<>( projectModel.getFocusModel(), navigationModel );
 		this.timePointModel = groupHandle.getModel( projectModel.TIMEPOINT );
-		this.client = new ViewServiceClient( projectModel.getContext(), new ViewServiceListener() );
+		this.client = new ViewServiceClient( projectModel.getContext(), new ViewServiceListener(), timeScalingFactor );
 		sendCoordinates();
 		sendColors();
 		sendTagSetList();

src/main/java/org/mastodon/blender/ViewServiceClient.java

@@ -65,7 +65,7 @@ public class ViewServiceClient
 	 * Mapping a timepoint to multiple frames in Blender has the advantage
 	 * that the Blender automatically interpolates between the timepoints.
 	 **/
-	private static final int TIME_SCALING_FACTOR = 10;
+	private static final int DEFAULT_TIME_SCALING_FACTOR = 10;
 
 	public static final String URL = "localhost:";
 
@@ -75,6 +75,8 @@ public class ViewServiceClient
 
 	private final Listener listener;
 
+	private final int timeScalingFactor;
+
 	public static void waitForConnection( int port )
 	{
 		ManagedChannel channel = ManagedChannelBuilder.forTarget( URL + port ).usePlaintext().build();
@@ -111,14 +113,22 @@ public static void closeBlender( int port )
 	}
 
 	public ViewServiceClient( final Context context, final Listener listener )
+	{
+		this( context, listener, DEFAULT_TIME_SCALING_FACTOR );
+	}
+
+	public ViewServiceClient( final Context context, final Listener listener, final int timeScalingFactor )
 	{
 		this.listener = listener;
+		this.timeScalingFactor = timeScalingFactor;
 		int port = StartBlender.getFreePort();
-		try {
+		try
+		{
 			StartBlender.startBlender( context, port );
 		}
-		catch( Throwable throwable ) {
-			throw new StartBlenderException(throwable);
+		catch ( Throwable throwable )
+		{
+			throw new StartBlenderException( throwable );
 		}
 		ManagedChannel channel = ManagedChannelBuilder.forTarget( URL + port ).usePlaintext().build();
 		Runtime.getRuntime().addShutdownHook( new Thread( channel::shutdown ) );
@@ -135,7 +145,7 @@ public int receiveSyncGroupIndex()
 
 	public int receiveTimepoint()
 	{
-		return Math.round( ( float ) blockingStub.getTimePoint( Empty.newBuilder().build() ).getTimePoint() / TIME_SCALING_FACTOR );
+		return Math.round( ( float ) blockingStub.getTimePoint( Empty.newBuilder().build() ).getTimePoint() / timeScalingFactor );
 	}
 
 	public int receiveActiveSpotId()
@@ -169,7 +179,7 @@ public void sendTimepoint( int timePoint )
 	{
 		//System.out.println("Mastodon -> Blender: set time point to " + timePoint);
 		blockingStub.setTimePoint( SetTimePointRequest.newBuilder()
-				.setTimepoint( timePoint * TIME_SCALING_FACTOR )
+				.setTimepoint( timePoint * timeScalingFactor )
 				.build() );
 	}
 
@@ -238,7 +248,7 @@ private void coordinates( AddMovingSpotRequest.Builder request, Spot spot, Affin
 		request.addCoordinates( point.getFloatPosition( 0 ) );
 		request.addCoordinates( point.getFloatPosition( 1 ) );
 		request.addCoordinates( point.getFloatPosition( 2 ) );
-		request.addTimepoints( spot.getTimepoint() * TIME_SCALING_FACTOR );
+		request.addTimepoints( spot.getTimepoint() * timeScalingFactor );
 	}
 
 	// callback

src/main/java/org/mastodon/blender/interactive/BlenderInteractiveCommand.java

@@ -0,0 +1,80 @@
+package org.mastodon.blender.interactive;
+
+import org.mastodon.blender.BlenderController;
+import org.mastodon.blender.StartBlenderException;
+import org.mastodon.blender.setup.BlenderSetup;
+import org.mastodon.mamut.ProjectModel;
+import org.scijava.Cancelable;
+import org.scijava.Context;
+import org.scijava.Initializable;
+import org.scijava.ItemVisibility;
+import org.scijava.command.Command;
+import org.scijava.plugin.Parameter;
+import org.scijava.plugin.Plugin;
+
+/**
+ * This dialog allows the user to set the time scaling factor for Blender Interactive view.
+ */
+@Plugin( type = Command.class, name = "Set time scaling for Blender Interactive View" )
+public class BlenderInteractiveCommand implements Command, Initializable, Cancelable
+{
+
+	@Parameter
+	private Context context;
+
+	@Parameter
+	private ProjectModel projectModel;
+
+	@Parameter( visibility = ItemVisibility.MESSAGE ) // Text that is displayed in the dialog and never changes.
+	private final String description = "<html>"
+			+ "\n<body width=10cm align=left>"
+			+ "\nA time scaling factor of 1 means that there is no time scaling and the frame number in Big Data View / TrackScheme views matches the frame number in Blender.<br><br>"
+			+ "\nA Time scaling factor larger than 1 means that interpolation between frames in the Blender view is computed, which leads to a smoother animation."
+			+ "\nFrame numbers in Blender are then multiplied by the time scaling factor."
+			+ "\n</body>"
+			+ "\n</html>";
+
+	@Parameter( label = "Time scaling factor", description = "1 means no time scaling. Larger means leads to time scaling and interpolation.", min = "1" )
+	private int timeScalingFactor = 1;
+
+	@Override
+	public void run()
+	{
+		startBlenderView();
+	}
+
+	@Override
+	public boolean isCanceled()
+	{
+		return false;
+	}
+
+	@Override
+	public void cancel( String reason )
+	{
+		// The goal is to have a cancel button in the dialog. This method does not need to do anything to achieve that.
+	}
+
+	@Override
+	public String getCancelReason()
+	{
+		return null;
+	}
+
+	private void startBlenderView()
+	{
+		if ( projectModel != null )
+		{
+			new Thread( () -> {
+				try
+				{
+					new BlenderController( projectModel, timeScalingFactor );
+				}
+				catch ( StartBlenderException e )
+				{
+					BlenderSetup.startSetupWithMessage( context, e );
+				}
+			} ).start();
+		}
+	}
+}

src/test/java/StartBlenderAndMastodon.java

@@ -45,7 +45,7 @@ public static void main( String... args ) throws IOException
 	{
 		copyAddonFromRepoToBlender();
 		ProjectModel projectModel = MastodonUtils.showGui( "/home/arzt/Datasets/DeepLineage/Johannes/2022-07-27_NL46xNL22_eachview_2023-07-04_cleaned.mastodon" );
-		new BlenderController( projectModel );
+		new BlenderController( projectModel, 1 );
 	}
 
 	private static void copyAddonFromRepoToBlender() throws IOException