Add toggle to save and load mounting reset (#963)

SlimeVR · Apr 4, 2024 · 7df8c5d · 7df8c5d
1 parent 78caab1
commit 7df8c5d
Show file tree

Hide file tree

Showing 11 changed files with 79 additions and 5 deletions.
diff --git a/gui/public/i18n/en/translation.ftl b/gui/public/i18n/en/translation.ftl
@@ -320,6 +320,11 @@ settings-general-tracker_mechanics-drift_compensation-description =
 settings-general-tracker_mechanics-drift_compensation-enabled-label = Drift compensation
 settings-general-tracker_mechanics-drift_compensation-amount-label = Compensation amount
 settings-general-tracker_mechanics-drift_compensation-max_resets-label = Use up to x last resets
+settings-general-tracker_mechanics-save_mounting_reset = Save automatic mounting reset calibration
+settings-general-tracker_mechanics-save_mounting_reset-description =
+    Saves the automatic mounting reset calibrations for the trackers between restarts. Useful
+    when wearing a suit where trackers don't move between sessions. <b>Not recommended for normal users!</b>
+settings-general-tracker_mechanics-save_mounting_reset-enabled-label = Save mounting reset
 
 ## FK/Tracking settings
 settings-general-fk_settings = Tracking settings

diff --git a/gui/src/components/settings/pages/GeneralSettings.tsx b/gui/src/components/settings/pages/GeneralSettings.tsx
@@ -1,4 +1,4 @@
-import { useLocalization } from '@fluent/react';
+import { Localized, useLocalization } from '@fluent/react';
 import { useEffect, useState } from 'react';
 import { DefaultValues, useForm } from 'react-hook-form';
 import {
@@ -91,6 +91,7 @@ interface SettingsForm {
     resetMountingFeet: boolean;
     armsMountingResetMode: number;
     yawResetSmoothTime: number;
+    saveMountingReset: boolean;
   };
 }
 
@@ -147,6 +148,7 @@ const defaultValues = {
     resetMountingFeet: false,
     armsMountingResetMode: 0,
     yawResetSmoothTime: 0.0,
+    saveMountingReset: false,
   },
 };
 
@@ -269,6 +271,8 @@ export function GeneralSettings() {
         values.resetsSettings.armsMountingResetMode;
       resetsSettings.yawResetSmoothTime =
         values.resetsSettings.yawResetSmoothTime;
+      resetsSettings.saveMountingReset =
+        values.resetsSettings.saveMountingReset;
       settings.resetsSettings = resetsSettings;
     }
 
@@ -659,6 +663,28 @@ export function GeneralSettings() {
                 step={0.05}
               />
             </div>
+            <div className="flex flex-col pt-5 pb-3">
+              <Typography bold>
+                {l10n.getString(
+                  'settings-general-tracker_mechanics-save_mounting_reset'
+                )}
+              </Typography>
+              <Localized
+                id="settings-general-tracker_mechanics-save_mounting_reset-description"
+                elems={{ b: <b></b> }}
+              >
+                <Typography color="secondary"></Typography>
+              </Localized>
+            </div>
+            <CheckBox
+              variant="toggle"
+              outlined
+              control={control}
+              name="resetsSettings.saveMountingReset"
+              label={l10n.getString(
+                'settings-general-tracker_mechanics-save_mounting_reset-enabled-label'
+              )}
+            />
           </>
         </SettingsPagePaneLayout>
         <SettingsPagePaneLayout

diff --git a/gui/src/hooks/status-system.ts b/gui/src/hooks/status-system.ts
@@ -157,6 +157,8 @@ export function parseStatusToLocale(
       }
       return { trackerName: name };
     }
+    case StatusData.StatusUnassignedHMD:
+      return { trackerName: 'Not implemented.' }; // TODO
   }
 }
 

diff --git a/server/core/src/main/java/dev/slimevr/config/ResetsConfig.kt b/server/core/src/main/java/dev/slimevr/config/ResetsConfig.kt
@@ -40,6 +40,9 @@ class ResetsConfig {
 	// Yaw reset smoothing time in seconds
 	var yawResetSmoothTime = 0.0f
 
+	// Save automatic mounting reset calibration
+	var saveMountingReset = false
+
 	fun updateTrackersResetsSettings() {
 		for (t in VRServer.instance.allTrackers) {
 			if (t.needsReset) {

diff --git a/server/core/src/main/java/dev/slimevr/config/TrackerConfig.kt b/server/core/src/main/java/dev/slimevr/config/TrackerConfig.kt
@@ -13,6 +13,7 @@ class TrackerConfig {
 	var hide: Boolean = false
 	var adjustment: ObjectQuaternion? = null
 	var mountingOrientation: ObjectQuaternion? = null
+	var mountingResetOrientation: ObjectQuaternion? = null
 	var allowDriftCompensation: Boolean? = null
 
 	constructor()

diff --git a/server/core/src/main/java/dev/slimevr/config/VRConfig.kt b/server/core/src/main/java/dev/slimevr/config/VRConfig.kt
@@ -101,7 +101,10 @@ class VRConfig {
 			val config = getTracker(tracker)
 			tracker.readConfig(config)
 			if (tracker.isImu()) tracker.resetsHandler.readDriftCompensationConfig(driftCompensation)
-			if (tracker.needsReset) tracker.resetsHandler.readResetConfig(resetsConfig)
+			if (tracker.needsReset) {
+				tracker.resetsHandler.readResetConfig(resetsConfig)
+				tracker.saveMountingResetOrientation(config)
+			}
 			if (tracker.allowFiltering) {
 				tracker
 					.filteringHandler

diff --git a/server/core/src/main/java/dev/slimevr/protocol/rpc/settings/RPCSettingsBuilder.java b/server/core/src/main/java/dev/slimevr/protocol/rpc/settings/RPCSettingsBuilder.java
@@ -339,7 +339,8 @@ public static int createArmsResetModeSettings(
 				fbb,
 				resetsConfig.getResetMountingFeet(),
 				resetsConfig.getMode().getId(),
-				resetsConfig.getYawResetSmoothTime()
+				resetsConfig.getYawResetSmoothTime(),
+				resetsConfig.getSaveMountingReset()
 			);
 	}
 

diff --git a/server/core/src/main/java/dev/slimevr/protocol/rpc/settings/RPCSettingsHandler.kt b/server/core/src/main/java/dev/slimevr/protocol/rpc/settings/RPCSettingsHandler.kt
@@ -334,6 +334,7 @@ class RPCSettingsHandler(var rpcHandler: RPCHandler, var api: ProtocolAPI) {
 				resetsConfig.mode = mode
 			}
 			resetsConfig.resetMountingFeet = req.resetsSettings().resetMountingFeet()
+			resetsConfig.saveMountingReset = req.resetsSettings().saveMountingReset()
 			resetsConfig.yawResetSmoothTime = req.resetsSettings().yawResetSmoothTime()
 			resetsConfig.updateTrackersResetsSettings()
 		}

diff --git a/server/core/src/main/java/dev/slimevr/tracking/trackers/Tracker.kt b/server/core/src/main/java/dev/slimevr/tracking/trackers/Tracker.kt
@@ -215,6 +215,7 @@ class Tracker @JvmOverloads constructor(
 			getByDesignation(designation)?.let { trackerPosition = it }
 		} ?: run { trackerPosition = null }
 		if (needsMounting) {
+			// Load manual mounting
 			config.mountingOrientation?.let { resetsHandler.mountingOrientation = it.toValue() }
 		}
 		if (this.isImu() && config.allowDriftCompensation == null) {
@@ -241,13 +242,33 @@ class Tracker @JvmOverloads constructor(
 		trackerPosition?.let { config.designation = it.designation } ?: run { config.designation = null }
 		customName?.let { config.customName = it }
 		if (needsMounting) {
+			// Save manual mounting
 			config.mountingOrientation = resetsHandler.mountingOrientation.toObject()
 		}
 		if (this.isImu()) {
 			config.allowDriftCompensation = resetsHandler.allowDriftCompensation
 		}
 	}
 
+	/**
+	 * Loads the mounting reset quaternion from disk
+	 */
+	fun saveMountingResetOrientation(config: TrackerConfig) {
+		// Load automatic mounting
+		config.mountingResetOrientation?.let {
+			resetsHandler.trySetMountingReset(it.toValue())
+		}
+	}
+
+	/**
+	 * Saves the mounting reset quaternion to disk
+	 */
+	fun saveMountingResetOrientation(quat: Quaternion?) {
+		val configManager = VRServer.instance.configManager
+		configManager.vrConfig.getTracker(this).mountingResetOrientation = quat?.toObject()
+		configManager.saveConfig()
+	}
+
 	/**
 	 * Synchronized with the VRServer's 1000hz while loop
 	 */

diff --git a/server/core/src/main/java/dev/slimevr/tracking/trackers/TrackerResetsHandler.kt b/server/core/src/main/java/dev/slimevr/tracking/trackers/TrackerResetsHandler.kt
@@ -42,6 +42,7 @@ class TrackerResetsHandler(val tracker: Tracker) {
 	private var armsResetMode = ArmsResetModes.BACK
 	private var yawResetSmoothTime = 0.0f
 	private lateinit var fpsTimer: NanoTimer
+	var saveMountingReset = false
 	var allowDriftCompensation = false
 	var lastResetQuaternion: Quaternion? = null
 
@@ -112,7 +113,7 @@ class TrackerResetsHandler(val tracker: Tracker) {
 	}
 
 	/**
-	 * Reads/loads arms reset mode settings from given config
+	 * Reads/loads reset settings from the given config
 	 */
 	fun readResetConfig(config: ResetsConfig) {
 		resetMountingFeet = config.resetMountingFeet
@@ -121,6 +122,13 @@ class TrackerResetsHandler(val tracker: Tracker) {
 		if (!::fpsTimer.isInitialized) {
 			fpsTimer = VRServer.instance.fpsTimer
 		}
+		saveMountingReset = config.saveMountingReset
+	}
+
+	fun trySetMountingReset(quat: Quaternion) {
+		if (saveMountingReset) {
+			mountRotFix = quat
+		}
 	}
 
 	/**
@@ -323,6 +331,9 @@ class TrackerResetsHandler(val tracker: Tracker) {
 
 		// Make an adjustment quaternion from the angle
 		mountRotFix = EulerAngles(EulerOrder.YZX, 0f, yawAngle, 0f).toQuaternion()
+
+		// save mounting reset
+		if (saveMountingReset) tracker.saveMountingResetOrientation(mountRotFix)
 	}
 
 	fun clearMounting() {

diff --git a/solarxr-protocol b/solarxr-protocol