Add biomech window by aymanhab · Pull Request #31 · opensim-org/opensim-visualizer

aymanhab · 2026-06-10T23:01:37Z

No description provided.

remove licensekey ref and download prebuilt jar instead

…r' into opensim-gui-jxbrowser7

…serve for downloads

… models

… the module jar file

…utes of a trial (name, segments, .... etc.) and use to enable users to select actions accordingly.

…tiple segment trials

…TopComponent add cleanup on exit

…ad prematurely, also guard against missing grf file(s)

aymanhab · 2026-06-10T23:05:43Z

This PR adds the AddBiomechanics window to the OpenSim GUI allowing users to download and handle zip files on OpenSim format.

Copilot

Pull request overview

This PR introduces an “AddBiomechanics” window built on the existing embedded JxBrowser integration, adds UI/resources to support downloading and importing datasets from addbiomechanics.org, and updates a couple of documentation links/notes.

Changes:

Added a new AddBiomechanicsTopComponent that embeds JxBrowser and wires download handling into an “import” flow.
Added org.opensim.addBiomech classes to unpack downloaded zips, discover models/trials, and load motions into the app.
Updated JxBrowser engine initialization/caching and refreshed README / welcome page links.

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 16 comments.

Show a summary per file

File	Description
README.md	Updates note about JxBrowser7 license.
jxbrowser/src/org/opensim/javabrowser/welcome.html	Updates “What’s New” link to OpenSim 4.6 page.
jxbrowser/src/org/opensim/javabrowser/jxBrowserTopComponent.java	Refactors Engine creation into a shared cached engine and tweaks model-change event handling.
jxbrowser/src/org/opensim/javabrowser/Bundle.properties	Adds localized strings for the new AddBiomechanics window UI.
jxbrowser/src/org/opensim/javabrowser/AddBiomechanicsTopComponent.java	New TopComponent embedding JxBrowser with download callbacks.
jxbrowser/src/org/opensim/javabrowser/AddBiomechanicsTopComponent.form	NetBeans form definition for the new TopComponent.
jxbrowser/src/org/opensim/addBiomech/Installer.java	Module shutdown hook to clean up downloads directory.
jxbrowser/src/org/opensim/addBiomech/Bundle.properties	UI strings for the download-handling panel.
jxbrowser/src/org/opensim/addBiomech/AddBiomechPrefs.java	Preferences helper for download directory location.
jxbrowser/src/org/opensim/addBiomech/AddBiomechanicsTrial.java	Trial abstraction + “stitching” helpers for multi-segment downloads.
jxbrowser/src/org/opensim/addBiomech/AddBiomechanicsHandleDownloadJPanel.java	Zip extraction + UI flow to open/associate downloaded content.
jxbrowser/src/org/opensim/addBiomech/AddBiomechanicsHandleDownloadJPanel.form	NetBeans form definition for the download-handling panel.
jxbrowser/nbproject/project.xml	Adds module dependencies needed for dialogs/UI and modeling/logger usage.
jxbrowser/manifest.mf	Registers module installer and changes public package exports.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

 If you would like to use JxBrowser in your development, please contact TeamDev.

-Upgraded to jXBrowser7 in 10/25
+Upgraded to jXBrowser7 in 10/25 with new dedicated project license rather then OpenSource one.


+            Engine engine = Engine.newInstance(EngineOptions.newBuilder(RenderingMode.OFF_SCREEN)
+                    .licenseKey("4UNGXAXTRYIHI4S4DZYH52OM3U0NQ188QVOUJDS0M7QMDCF0RKIL1YBWQJT0U6L5GCDZK7J949904OT7JYQUSHQ7ETBOBK9A3RD2ENRJK48F9HH2F8CWAD3MAP1BZKBN4ZVYC0D9R89R75KTYLN")
+                    .addSwitch("--js-flags=--max-old-space-size=256")  // JS heap in MB


+package org.opensim.addBiomech;
+
+import org.opensim.utils.TheApp;
+import static org.opensim.utils.TheApp.getCurrentVersionPreferences;
+
+/**
+ *
+ * @author ayman
+ */
+public final class AddBiomechPrefs {
+    public static String getDownloadsDir() {
+        return getCurrentVersionPreferences().get("AddBiomechDownloadFolder", TheApp.getInstallDir()+"/"+"AddBiomechDownloads");
+    }
+}


+    @Override
+    public void close() {
+        // Called when shutdown is confirmed — do your cleanup here
+        deleteTempFiles();
+    }
+
+    private void deleteTempFiles() {
+        Path downloadPath = Paths.get(AddBiomechPrefs.getDownloadsDir());
+        File tempDir = new File(downloadPath.toString());
+        deleteRecursively(tempDir);
+    }
+
+    private void deleteRecursively(File f) {
+        if (f.isDirectory()) {
+            for (File child : f.listFiles()) {
+                deleteRecursively(child);
+            }
+        }
+        f.delete();
+    }


+        browser.navigation().loadUrl("addbiomechanics.org/login");
+        setName(Bundle.CTL_AddBiomechanicsTopComponent());


+            int[] indices = jTrialsList.getSelectedIndices();
+
+            for (int i : indices) { // Single select
+                selectedTrialIndex = i;
+            }


+                        if (grfPath != null)
+                            MotionsDB.getInstance().loadMotionFile(grfPath, false);
+                        trialLoadingStatus = 2;
+                    }
+                    });
+            }});
+


+    private String getSegmentFileName(String firstSegmentFilename, int segNumber) {
+         // Generated from nbfs://nbhost/SystemFileSystem/Templates/Classes/Code/GeneratedMethodBody
+         if (segNumber == -1)
+             return (firstSegmentFilename.replace("_0", "_all"));
+         return (firstSegmentFilename.replace("_0", "_"+String.valueOf(segNumber)));
+    }


+        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
+        this.setLayout(layout);
+        layout.setHorizontalGroup(
+            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
+            .addComponent(jScrollPane)
+        );
+        layout.setVerticalGroup(
+            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
+            .addComponent(jScrollPane)
+        );


 OpenIDE-Module-Requires: org.openide.windows.WindowManager
 OpenIDE-Module-Specification-Version: 1.0
-
+OpenIDE-Module-Public-Packages: org.opensim.javabrowser.*


AlbertoCasasOrtiz · 2026-06-11T18:54:11Z

    public void update(Observable o, Object arg) {
-        if (arg instanceof ObjectSetCurrentEvent){
-            ObjectSetCurrentEvent ev = (ObjectSetCurrentEvent) arg;
+        //System.out.println("jxBrowserTC.update "+arg.toString());


Is this commented line needed for debugging?

Can be removed

AlbertoCasasOrtiz · 2026-06-11T18:55:17Z

+        if (cacheEngine==null){
+            // This is the hardcoded trial license, eventually this will go into private repo
+            Engine engine = Engine.newInstance(EngineOptions.newBuilder(RenderingMode.OFF_SCREEN)
+                    .licenseKey("4UNGXAXTRYIHI4S4DZYH52OM3U0NQ188QVOUJDS0M7QMDCF0RKIL1YBWQJT0U6L5GCDZK7J949904OT7JYQUSHQ7ETBOBK9A3RD2ENRJK48F9HH2F8CWAD3MAP1BZKBN4ZVYC0D9R89R75KTYLN")


Is it ok to have this license key in this public repo?

That's the eval license key we had since we upgraded. The real key is embedded in an nbm file

Sounds good to me then. I though that to be a stale license, but just wanted to make sure. I will test this branch on the GUI next then.

… to troubleshoot a build on ci

aymanhab added 15 commits February 11, 2026 10:29

Merge pull request #30 from opensim-org/use_precompiled_jxbrowser

9925a8f

remove licensekey ref and download prebuilt jar instead

Restore trial key though unused so format is met

03b7741

Merge remote-tracking branch 'remotes/origin/use_precompiled_jxbrowse…

d072638

…r' into opensim-gui-jxbrowser7

Update readme file with license info

eb57843

Change whats new page reference on welcome page

68cc40b

Add option under windows to open addbiomechanics.org and to handle ob…

84d7c48

…serve for downloads

Rearrange download handling dialog and load motions along with scaled…

80852c3

… models

Undo change to build script until we find a workaround to overwriting…

222fdd7

… the module jar file

Introduce AddBiomechanicsTrial class to hold references to all attrib…

71598d1

…utes of a trial (name, segments, .... etc.) and use to enable users to select actions accordingly.

Beef up AddBiomechanicsTrial class and use it to stitch files for mul…

021e69a

…tiple segment trials

Unify browser creation in one place as a cached instance in jxBrowser…

5943ed7

…TopComponent add cleanup on exit

Remove hack to use a local zip file instead of downloaded zip

a208642

Cleanup, remove debugging lines and dead code

de03679

Handle the case where no physics fitting was made

23d93ee

Move download handling to callback so we don't try to open the downlo…

db129fa

…ad prematurely, also guard against missing grf file(s)

aymanhab requested review from AlbertoCasasOrtiz and Copilot June 10, 2026 23:04

Copilot started reviewing on behalf of aymanhab June 10, 2026 23:04 View session

Copilot AI reviewed Jun 10, 2026

View reviewed changes

use updated nbm file from dev

5f6ec09

AlbertoCasasOrtiz reviewed Jun 11, 2026

View reviewed changes

aymanhab added 2 commits June 15, 2026 11:30

no postjar for now and use std jar from 4.6

097c005

Remove optimization switches for now and remove pre/post jar commands…

0a00a75

… to troubleshoot a build on ci

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add biomech window#31

Add biomech window#31
aymanhab wants to merge 18 commits into
use_precompiled_jxbrowserfrom
add_biomech_win

aymanhab commented Jun 10, 2026

Uh oh!

aymanhab commented Jun 10, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Uh oh!

aymanhab Jun 11, 2026

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Uh oh!

aymanhab Jun 11, 2026

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		browser.navigation().loadUrl("addbiomechanics.org/login");
		setName(Bundle.CTL_AddBiomechanicsTopComponent());

Uh oh!

Conversation

aymanhab commented Jun 10, 2026

Uh oh!

aymanhab commented Jun 10, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

aymanhab Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

aymanhab Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

AlbertoCasasOrtiz Jun 11, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants