Java example test (#2782)

Meakk · noclone · web-flow · commit 65f3b6878941 · 2026-01-08T23:17:59.000+01:00
---------

Co-authored-by: Jean Fechter &lt;jean.fechter@gmail.com&gt;
diff --git a/.github/actions/generic-ci/action.yml b/.github/actions/generic-ci/action.yml
@@ -335,6 +335,12 @@ runs:
         cmake --install . --component configuration
         cmake --install . --component colormaps
 
+    - name: Install Mesa Windows in install
+      if: runner.os == 'Windows'
+      uses: f3d-app/install-mesa-windows-action@v2
+      with:
+        path: ${{github.workspace}}\install\bin
+
     - name: Build and configure python externally
       if: |
         inputs.optional_deps_label == 'optional-deps' &&
@@ -428,12 +434,6 @@ runs:
       shell: bash
       run: echo "F3D_BIN_PATH=./bin/f3d" >> $GITHUB_ENV
 
-    - name: Install Mesa Windows in install
-      if: runner.os == 'Windows'
-      uses: f3d-app/install-mesa-windows-action@v2
-      with:
-        path: ${{github.workspace}}\install\bin
-
     # Grid rendering has artifacts in macOS arm64 CI
     # https://github.com/f3d-app/f3d/issues/1276
     - name: Check F3D_PLUGINS_PATH using plugin example
diff --git a/README.md b/README.md
@@ -10,7 +10,7 @@ F3D (pronounced `/fɛd/`) is a fast and minimalist 3D viewer desktop application
 
 It is fully controllable from the command line and support configuration files. It can provide thumbnails, support interactive hotkeys, drag&drop and integration into file managers.
 
-F3D also contains the libf3d, a simple library to render meshes, with a C++17 API, C, Python and Javascript Bindings, and experimental Java bindings.
+F3D also contains the libf3d, a simple library to render meshes, with a C++17 API, C, Python, Java and Javascript Bindings.
 
 <img src="https://media.githubusercontent.com/media/f3d-app/f3d-website/refs/heads/main/static/images/typical.png" width="640" />
 
diff --git a/doc/dev/04-BUILD.md b/doc/dev/04-BUILD.md
@@ -60,7 +60,7 @@ Some modules, plugins and language bindings depending on external libraries can
 - `F3D_PLUGIN_BUILD_VDB`: Support for VDB file format. Requires that VTK has been built with `IOOpenVDB` module (and `OpenVDB`). Disabled by default.
 - `F3D_BINDINGS_PYTHON`: Generate python bindings (requires `Python` and `pybind11`). Disabled by default.
 - `F3D_BINDINGS_PYTHON_GENERATE_STUBS`: Generate python stubs (requires `Python` and `pybind11_stubgen`). Disabled by default.
-- `F3D_BINDINGS_JAVA`: Generate java bindings (requires `Java` and `JNI`). Disabled by default.
+- `F3D_BINDINGS_JAVA`: Generate java bindings (requires `Java` >= 17 and `JNI`). Disabled by default.
 
 Some dependencies are provided internally, eg: ImGui, dmon and others. Use `F3D_USE_EXTERNAL_*` to use an external version of these libraries.
 
diff --git a/doc/dev/07-ARCHITECTURE.md b/doc/dev/07-ARCHITECTURE.md
@@ -15,7 +15,7 @@ This architecture is reflected by the directories organisation.
 - **vtkext**: extensions to VTK and related tests, see below
 - c: [c bindings](../libf3d/04-LANGUAGE_BINDINGS.md#c) and tests
 - python: [python bindings](../libf3d/04-LANGUAGE_BINDINGS.md#python) and tests
-- java: [java bindings](../libf3d/04-LANGUAGE_BINDINGS.md#java-experimental) and tests
+- java: [java bindings](../libf3d/04-LANGUAGE_BINDINGS.md#java) and tests
 - webassembly: [webassembly/javascript bindings](../libf3d/04-LANGUAGE_BINDINGS.md#javascript) and tests
 - winshellext: shell extension for Windows, provide [thumbnails for Windows](../user/11-DESKTOP_INTEGRATION.md#windows)
 
diff --git a/doc/libf3d/04-LANGUAGE_BINDINGS.md b/doc/libf3d/04-LANGUAGE_BINDINGS.md
@@ -150,9 +150,9 @@ Some advanced libf3d API are not bound yet, here's the exhaustive list:
 - `f3d::interactor`: bindings related functions
 - `f3d::interactor`: `playInteraction` and `recordInteraction`
 
-## Java (experimental)
+## Java
 
-If the Java bindings have been generated using the `F3D_BINDINGS_JAVA` CMake option, the libf3d can be used directly from Java.
+If the Java bindings have been generated using the `F3D_BINDINGS_JAVA` CMake option, the libf3d can be used directly from Java >= 17.
 You can import the `f3d.jar` package and use the provided Java classes directly.
 Make sure to set `java.library.path` to the path where the JNI library is built.
 Here is an example showing how to use libf3d Java bindings:
diff --git a/examples/libf3d/java/CMakeLists.txt b/examples/libf3d/java/CMakeLists.txt
@@ -1,3 +1,7 @@
 cmake_minimum_required(VERSION 3.10)
 
 add_subdirectory(interactive-app)
+
+if (BUILD_TESTING)
+  add_subdirectory(tests)
+endif ()
diff --git a/examples/libf3d/java/interactive-app/CMakeLists.txt b/examples/libf3d/java/interactive-app/CMakeLists.txt
@@ -19,13 +19,15 @@ find_file(F3D_JAR
 
 message(STATUS "Found f3d.jar: ${F3D_JAR}")
 
+file(COPY ${F3D_JAR} DESTINATION ${CMAKE_CURRENT_BINARY_DIR})
+
 file(WRITE "${CMAKE_CURRENT_BINARY_DIR}/MANIFEST.MF"
   "Manifest-Version: 1.0\n"
   "Main-Class: InteractiveApp\n"
-  "Class-Path: ${F3D_JAR}\n"
+  "Class-Path: f3d.jar\n"
 )
 
-set(CMAKE_JAVA_COMPILE_FLAGS -source 8 -target 8)
+set(CMAKE_JAVA_COMPILE_FLAGS --release 17)
 add_jar(interactive-app-java
   InteractiveApp.java
   INCLUDE_JARS ${F3D_JAR}
diff --git a/examples/libf3d/java/interactive-app/InteractiveApp.java b/examples/libf3d/java/interactive-app/InteractiveApp.java
@@ -1,12 +1,17 @@
 import app.f3d.F3D.*;
-import java.util.Timer;
-import java.util.TimerTask;
 
 public class InteractiveApp {
 
+    // On Windows, try to load opengl32 from Java path
+    // It's only useful in order to force Mesa software OpenGL
     static {
-        if (System.getProperty("os.name").startsWith("Windows")) {
-            System.loadLibrary("opengl32");
+        if (System.getProperty("os.name").startsWith("Windows"))
+        {
+            try {
+                System.loadLibrary("opengl32");
+            } catch (UnsatisfiedLinkError e) {
+                // Ignore if opengl32 is not available
+            }
         }
     }
 
@@ -48,15 +53,7 @@ public static void main(String[] args) {
             if (args.length > 1) {
                 // For testing purposes, stop after timeout seconds
                 int timeout = Integer.parseInt(args[1]);
-                Timer timer = new Timer();
-                timer.schedule(new TimerTask() {
-                    @Override
-                    public void run() {
-                        interactor.requestStop();
-                        timer.cancel();
-                    }
-                }, timeout * 1000L);
-                interactor.start();
+                interactor.start(timeout, () -> interactor.stop());
             } else {
                 interactor.start();
             }
diff --git a/examples/libf3d/java/tests/CMakeLists.txt b/examples/libf3d/java/tests/CMakeLists.txt
@@ -0,0 +1,21 @@
+cmake_minimum_required(VERSION 3.10)
+
+get_filename_component(F3D_JAVA_LIBRARY_DIR "${f3d_DIR}/../.." ABSOLUTE)
+
+set(java_test_args "--enable-native-access=ALL-UNNAMED")
+if (WIN32)
+  set(F3D_JAVA_LIBRARY_DIR "${F3D_JAVA_LIBRARY_DIR}/../bin")
+endif()
+if(APPLE)
+  list(APPEND java_test_args "-XstartOnFirstThread")
+endif()
+
+# interactive-app
+add_test(NAME test_interactive-app-java
+  WORKING_DIRECTORY "${F3D_JAVA_LIBRARY_DIR}"
+  COMMAND ${Java_JAVA_EXECUTABLE}
+    -Djava.library.path=${F3D_JAVA_LIBRARY_DIR}
+    ${java_test_args}
+    -jar $<SHELL_PATH:$<TARGET_PROPERTY:interactive-app-java,JAR_FILE>>
+    "${CMAKE_CURRENT_SOURCE_DIR}/data/cow.vtp" 1)
+set_tests_properties(test_interactive-app-java PROPERTIES TIMEOUT 60)
diff --git a/examples/libf3d/java/tests/data/cow.vtp b/examples/libf3d/java/tests/data/cow.vtp
@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:d5aa4901d186902f90e17bf3b5917541cb6cb8cf223bfeea736631df4c047652
+size 60449
diff --git a/java/CMakeLists.txt b/java/CMakeLists.txt
@@ -23,7 +23,7 @@ set(F3D_JAVA_SOURCES
   Window.java)
 
 # Generate JNI headers, and builds a JAR package
-set(CMAKE_JAVA_COMPILE_FLAGS -source 8 -target 8)
+set(CMAKE_JAVA_COMPILE_FLAGS --release 17)
 add_jar(f3d-jar ${F3D_JAVA_SOURCES}
   GENERATE_NATIVE_HEADERS f3d-jni-headers
   OUTPUT_NAME f3d)
@@ -42,17 +42,20 @@ set(F3D_JAVA_BINDINGS_SOURCES
   F3DWindowBindings.cxx)
 
 add_library(javaf3d SHARED ${F3D_JAVA_BINDINGS_SOURCES})
-target_link_libraries(javaf3d PRIVATE f3d-jni-headers)
-
-target_include_directories(javaf3d PRIVATE ${JNI_INCLUDE_DIRS})
-target_link_libraries(javaf3d PRIVATE libf3d ${JNI_LIBRARIES})
+target_link_libraries(javaf3d PRIVATE f3d-jni-headers libf3d)
 
 if(UNIX)
   # Set this option to detect mismatch in function implementation and headers
   # automatically generated by javac
   target_compile_options(javaf3d PRIVATE "-Werror=missing-declarations")
 endif()
 
+if(APPLE)
+  set_target_properties(javaf3d PROPERTIES INSTALL_RPATH "@loader_path")
+elseif(UNIX)
+  set_target_properties(javaf3d PROPERTIES INSTALL_RPATH "$ORIGIN")
+endif()
+
 set_target_properties(javaf3d PROPERTIES
   CXX_VISIBILITY_PRESET hidden
   CXX_STANDARD 17
diff --git a/java/F3DInteractorBindings.cxx b/java/F3DInteractorBindings.cxx
@@ -625,6 +625,34 @@ extern "C"
     return self;
   }
 
+  JNIEXPORT jobject JAVA_BIND(Interactor, startWithCallback)(
+    JNIEnv* env, jobject self, jdouble deltaTime, jobject callback)
+  {
+    jobject globalCallback = env->NewGlobalRef(callback);
+
+    GetInteractor(env, self).start(deltaTime,
+      [globalCallback]()
+      {
+        JNIEnv* env = nullptr;
+#ifdef __ANDROID__
+        if (g_jvm->AttachCurrentThread(&env, nullptr) != JNI_OK)
+#else
+        if (g_jvm->AttachCurrentThread(reinterpret_cast<void**>(&env), nullptr) != JNI_OK)
+#endif
+        {
+          return;
+        }
+
+        jclass runnableClass = env->GetObjectClass(globalCallback);
+        jmethodID runMethod = env->GetMethodID(runnableClass, "run", "()V");
+        env->CallVoidMethod(globalCallback, runMethod);
+
+        env->DeleteGlobalRef(globalCallback);
+        g_jvm->DetachCurrentThread();
+      });
+    return self;
+  }
+
   JNIEXPORT jobject JAVA_BIND(Interactor, stop)(JNIEnv* env, jobject self)
   {
     GetInteractor(env, self).stop();
diff --git a/java/Interactor.java b/java/Interactor.java
@@ -502,6 +502,28 @@ public Interactor start() {
         return start(1.0 / 30);
     }
 
+    /**
+     * Start the interactor event loop with a callback.
+     * The callback is called on each event loop iteration.
+     *
+     * @param deltaTime time delta in seconds (must be positive)
+     * @param callback callback to execute on each iteration
+     * @return this interactor for method chaining
+     */
+    private native Interactor startWithCallback(double deltaTime, Runnable callback);
+
+    /**
+     * Start the interactor event loop with a callback.
+     * The callback is called on each event loop iteration.
+     *
+     * @param deltaTime time delta in seconds (must be positive)
+     * @param callback callback to execute on each iteration
+     * @return this interactor for method chaining
+     */
+    public Interactor start(double deltaTime, Runnable callback) {
+        return startWithCallback(deltaTime, callback);
+    }
+
     /**
      * Stop the interactor.
      *
diff --git a/java/testing/CMakeLists.txt b/java/testing/CMakeLists.txt
@@ -12,6 +12,9 @@ list(APPEND javaf3dTests_list
     )
 
 set(java_test_args "-ea") # enable assertions
+if (WIN32)
+  list(APPEND java_test_args "--enable-native-access=ALL-UNNAMED")
+endif()
 if(APPLE)
   # On macOS, this argument is mandatory in order to create native window
   list(APPEND java_test_args "-XstartOnFirstThread")
diff --git a/java/testing/TestCamera.java b/java/testing/TestCamera.java
@@ -2,10 +2,16 @@
 
 public class TestCamera {
 
+  // On Windows, try to load opengl32 from Java path
+  // It's only useful in order to force Mesa software OpenGL
   static {
     if (System.getProperty("os.name").startsWith("Windows"))
     {
-      System.loadLibrary("opengl32");
+      try {
+        System.loadLibrary("opengl32");
+      } catch (UnsatisfiedLinkError e) {
+        // Ignore if opengl32 is not available
+      }
     }
   }
 
diff --git a/java/testing/TestEngine.java b/java/testing/TestEngine.java
@@ -2,10 +2,16 @@
 
 public class TestEngine {
 
+  // On Windows, try to load opengl32 from Java path
+  // It's only useful in order to force Mesa software OpenGL
   static {
     if (System.getProperty("os.name").startsWith("Windows"))
     {
-      System.loadLibrary("opengl32");
+      try {
+        System.loadLibrary("opengl32");
+      } catch (UnsatisfiedLinkError e) {
+        // Ignore if opengl32 is not available
+      }
     }
   }
 
diff --git a/java/testing/TestImage.java b/java/testing/TestImage.java
@@ -2,13 +2,6 @@
 
 public class TestImage {
 
-  static {
-    if (System.getProperty("os.name").startsWith("Windows"))
-    {
-      System.loadLibrary("opengl32");
-    }
-  }
-
   public static void main(String[] args) {
     Engine.autoloadPlugins();
 
diff --git a/java/testing/TestInteractor.java b/java/testing/TestInteractor.java
@@ -2,10 +2,16 @@
 
 public class TestInteractor {
 
+  // On Windows, try to load opengl32 from Java path
+  // It's only useful in order to force Mesa software OpenGL
   static {
     if (System.getProperty("os.name").startsWith("Windows"))
     {
-      System.loadLibrary("opengl32");
+      try {
+        System.loadLibrary("opengl32");
+      } catch (UnsatisfiedLinkError e) {
+        // Ignore if opengl32 is not available
+      }
     }
   }
 
diff --git a/java/testing/TestLog.java b/java/testing/TestLog.java
@@ -2,13 +2,6 @@
 
 public class TestLog {
 
-  static {
-    if (System.getProperty("os.name").startsWith("Windows"))
-    {
-      System.loadLibrary("opengl32");
-    }
-  }
-
   static class TestCallback implements Log.ForwardCallback {
     @Override
     public void onLogMessage(Log.VerboseLevel level, String message) {
diff --git a/java/testing/TestOptions.java b/java/testing/TestOptions.java
@@ -2,10 +2,16 @@
 
 public class TestOptions {
 
+  // On Windows, try to load opengl32 from Java path
+  // It's only useful in order to force Mesa software OpenGL
   static {
     if (System.getProperty("os.name").startsWith("Windows"))
     {
-      System.loadLibrary("opengl32");
+      try {
+        System.loadLibrary("opengl32");
+      } catch (UnsatisfiedLinkError e) {
+        // Ignore if opengl32 is not available
+      }
     }
   }
 
diff --git a/java/testing/TestScene.java b/java/testing/TestScene.java
@@ -5,10 +5,16 @@
 
 public class TestScene {
 
+  // On Windows, try to load opengl32 from Java path
+  // It's only useful in order to force Mesa software OpenGL
   static {
     if (System.getProperty("os.name").startsWith("Windows"))
     {
-      System.loadLibrary("opengl32");
+      try {
+        System.loadLibrary("opengl32");
+      } catch (UnsatisfiedLinkError e) {
+        // Ignore if opengl32 is not available
+      }
     }
   }
 
diff --git a/java/testing/TestTypes.java b/java/testing/TestTypes.java
@@ -2,13 +2,6 @@
 
 public class TestTypes {
 
-  static {
-    if (System.getProperty("os.name").startsWith("Windows"))
-    {
-      System.loadLibrary("opengl32");
-    }
-  }
-
   public static void main(String[] args) {
     Types.LightType lightType = Types.LightType.SCENE_LIGHT;
     lightType.getValue();
diff --git a/java/testing/TestUtils.java b/java/testing/TestUtils.java
diff --git a/java/testing/TestWindow.java b/java/testing/TestWindow.java

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+version https://git-lfs.github.com/spec/v1`
	`2`	`+oid sha256:d5aa4901d186902f90e17bf3b5917541cb6cb8cf223bfeea736631df4c047652`
	`3`	`+size 60449`