Embedding Java 3D objects in a JavaFX application

In a previous post I showed how to embed and display Java 3D objects in a Swing application, using the Canvas3D class for that purpose.

Java 3D and the JavaFX 3D classes are both live projects (*), and similar, but not equal, libraries with a similar set of functions. All that means that there are valid reasons to choose one over the other.

The case with the Swing libraries is different since there is an explicit intention by Oracle of gradually phasing out the Swing library in favor of JavaFX's components. Also, in my very limited experience with both, Swing doesn't seem to hold any particular advantage. Not even in tooling, thanks to Scene Builder.

In summary, there are valid reasons to choose both JavaFX and Java 3D classes to build a Java desktop application that displays 3D graphics.

In this post I will present a minimal example of integrating both in an application. 

Note that this time we can only use Swing lightweight components. Otherwise they may fail to be rendered by JavaFX. That means we need to replace the class Canvas3D that we used in the Java 3D - Swing integration example with its lightweight pure-Java counterpart JCanvas3D.

	package com.moduleforge.com.java3d.examples;
	import javax.swing.SwingUtilities;
	import javafx.application.Application;
	import javafx.embed.swing.SwingNode;
	import javafx.event.EventHandler;
	import javafx.scene.Scene;
	import javafx.scene.layout.StackPane;
	import javafx.stage.Stage;
	import javafx.stage.WindowEvent;
	public class FXAppWithSwingPanel extends Application {
	@Override
	public void start(Stage stage) {
	final SwingNode swingNode = new SwingNode();
	createAndSetSwingContent(swingNode);
	StackPane pane = new StackPane();
	pane.getChildren().add(swingNode);
	stage.setOnCloseRequest(new EventHandler<WindowEvent>() {
	@Override
	public void handle(WindowEvent t) {
	System.exit(0);
	}
	});
	stage.setScene(new Scene(pane, 600, 600));
	stage.show();
	}
	private static void createAndSetSwingContent(final SwingNode swingNode) {
	SwingUtilities.invokeLater(new Runnable() {
	@Override
	public void run() {
	//I need this ugly hack for it to work, it only displays correctly on the second time
	boolean caughtException = true;
	while (caughtException) {
	caughtException = false;
	try {
	swingNode.setContent(new BallJCanvas3DPanel());
	} catch (java.lang.IllegalArgumentException e) {
	caughtException = true;
	}
	}
	}
	});
	}
	public static void main(String[] args) {
	launch(args);
	}
	}

view raw FXAppWithSwingPanel hosted with ❤ by GitHub

	package com.moduleforge.com.java3d.examples;
	import java.awt.BorderLayout;
	import java.awt.Color;
	import java.awt.Dimension;
	import javax.media.j3d.BoundingSphere;
	import javax.media.j3d.BranchGroup;
	import javax.media.j3d.Canvas3D;
	import javax.media.j3d.DirectionalLight;
	import javax.media.j3d.GraphicsConfigTemplate3D;
	import javax.media.j3d.Locale;
	import javax.media.j3d.PhysicalBody;
	import javax.media.j3d.PhysicalEnvironment;
	import javax.media.j3d.Transform3D;
	import javax.media.j3d.TransformGroup;
	import javax.media.j3d.View;
	import javax.media.j3d.ViewPlatform;
	import javax.media.j3d.VirtualUniverse;
	import javax.swing.JPanel;
	import javax.vecmath.Color3f;
	import javax.vecmath.Point3d;
	import javax.vecmath.Vector3d;
	import javax.vecmath.Vector3f;
	import com.sun.j3d.exp.swing.JCanvas3D;
	import com.sun.j3d.utils.geometry.Sphere;
	public class BallJCanvas3DPanel extends JPanel {
	public BallJCanvas3DPanel() {
	setLayout(new BorderLayout());
	makeCanvas();
	}
	private void makeCanvas() {
	GraphicsConfigTemplate3D gCT = new GraphicsConfigTemplate3D();
	JCanvas3D jCanvas3D = new JCanvas3D(gCT);
	Dimension canvasDim = new Dimension(400, 400);
	jCanvas3D.setPreferredSize(canvasDim);
	jCanvas3D.setSize(canvasDim);
	add(jCanvas3D, BorderLayout.CENTER);
	Canvas3D canvas3D = jCanvas3D.getOffscreenCanvas3D();
	View view = new View();
	view.setPhysicalBody(new PhysicalBody());
	view.setPhysicalEnvironment(new PhysicalEnvironment());
	view.addCanvas3D(canvas3D);
	ViewPlatform vp = new ViewPlatform();
	view.attachViewPlatform(vp);
	Transform3D viewTransform = new Transform3D();
	viewTransform.setTranslation(new Vector3d(0, 0, 20)); //move "back" a little
	TransformGroup viewTG = new TransformGroup();
	viewTG.setCapability(TransformGroup.ALLOW_TRANSFORM_WRITE);
	viewTG.setTransform(viewTransform);
	viewTG.addChild(vp);
	BranchGroup group = new BranchGroup();
	group.addChild(viewTG);
	group.addChild(makeLight());
	group.addChild(new Sphere(5));
	VirtualUniverse vu = new VirtualUniverse();
	Locale locale = new Locale(vu);
	locale.addBranchGraph(group);
	}
	private static DirectionalLight makeLight() {
	DirectionalLight light = new DirectionalLight(new Color3f(Color.WHITE), new Vector3f(-1.0f, -1.0f, -1.0f));
	light.setInfluencingBounds(new BoundingSphere(new Point3d(0, 0, 0), 100));
	return light;
	}
	}

view raw BallJCanvas3DPanel hosted with ❤ by GitHub

I had to rely on a hack in the JFrame class. There is an issue with the dimensions of a component at the time of adding the SwingNode that I was not able to resolve and results in an exception being thrown.

However, while debugging and stepping over the code, I noticed that sometimes the frame would be rendered correctly. Then I simply decided to retry adding the SwingNode if it failed the first time and noticed it would correctly render the panel in a very reliable way. I suspect there is a simple and cleaner solution, but at least the code demonstrates that the integration is completely possible.

We are not out of trouble yet. When I tried to integrate the rest of functionality that I had already developed in a Swing application, I noticed some features wouldn't work. It seems Java 3D, Swing and JavaFX simply don't play well together.

With that in mind I still think someone will benefit by going this route and won't have so much trouble with their applications as I had.

(*) Although new developments of Java 3D classes continue as a third party project and will not be integrated in the JDK in any foreseeable future.