fix: changing BLDistance to BLRatio, works much better, also fixing a tedious bug where the Probes GO had a non-zero transform

Author: dbirman

Assets/Prefabs/Managers/Probes.prefab

@@ -27,7 +27,7 @@ Transform:
   m_GameObject: {fileID: 5815862267276796598}
   serializedVersion: 2
   m_LocalRotation: {x: 0, y: 0, z: 0, w: 1}
-  m_LocalPosition: {x: 0, y: 3.668, z: 1.4000001}
+  m_LocalPosition: {x: 0, y: 0, z: 0}
   m_LocalScale: {x: 1, y: 1, z: 1}
   m_ConstrainProportionsScale: 0
   m_Children: []

Assets/Scenes/TrajectoryPlanner.unity

@@ -3138,6 +3138,10 @@ PrefabInstance:
       propertyPath: m_AnchoredPosition.x
       value: 0
       objectReference: {fileID: 0}
+    - target: {fileID: 341190943836276264, guid: 94cdeca105038d74ea47b57e6b99eb4e, type: 3}
+      propertyPath: m_IsOn
+      value: 0
+      objectReference: {fileID: 0}
     - target: {fileID: 341190943836276264, guid: 94cdeca105038d74ea47b57e6b99eb4e, type: 3}
       propertyPath: onValueChanged.m_PersistentCalls.m_Calls.Array.data[0].m_Target
       value: 
@@ -9516,7 +9520,7 @@ PrefabInstance:
       objectReference: {fileID: 0}
     - target: {fileID: 8016510558008620337, guid: 482bfae3ba88b424e96d7fcd669f7b73, type: 3}
       propertyPath: BregmaLambdaChangedEvent.m_PersistentCalls.m_Calls.Array.data[0].m_MethodName
-      value: ChangeBLDistance
+      value: ChangeBLRatio
       objectReference: {fileID: 0}
     - target: {fileID: 8016510558008620337, guid: 482bfae3ba88b424e96d7fcd669f7b73, type: 3}
       propertyPath: BregmaLambdaChangedEvent.m_PersistentCalls.m_Calls.Array.data[1].m_MethodName
@@ -11462,34 +11466,6 @@ PrefabInstance:
       propertyPath: _channelMapAssetRefs.Array.data[10].m_AssetGUID
       value: 6c610f1cb26c1f44a98acd88b4bdd650
       objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalPosition.x
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalPosition.y
-      value: 3.668
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalPosition.z
-      value: 1.4000001
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalRotation.w
-      value: 1
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalRotation.x
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalRotation.y
-      value: 0
-      objectReference: {fileID: 0}
-    - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
-      propertyPath: m_LocalRotation.z
-      value: 0
-      objectReference: {fileID: 0}
     - target: {fileID: 5480079517456965108, guid: de6f5b0508e9ae947a6bd003a9efd91a, type: 3}
       propertyPath: m_LocalEulerAnglesHint.x
       value: 0

Assets/Scripts/Pinpoint/Probes/Controllers/CartesianProbeController.cs

@@ -707,7 +707,7 @@ public override void SetProbePosition()
         transform.rotation = _initialRotation;
 
         // Manually adjust the coordinates and rotation
-        transform.position += Insertion.PositionWorldT();
+        transform.position = Insertion.PositionWorldT();
         transform.RotateAround(_probeTipT.position, transform.up, Insertion.Yaw);
         transform.RotateAround(_probeTipT.position, transform.right, Insertion.Pitch);
         transform.RotateAround(_probeTipT.position, _probeTipT.up, Insertion.Roll);

Assets/Scripts/Pinpoint/TrajectoryPlannerManager.cs

@@ -214,6 +214,11 @@ public async void Startup()
                 () => _probeQuickSettings.GetComponentInChildren<QuickSettingsLockBehavior>().UpdateSprite(ProbeManager.ActiveProbeManager.ProbeController.Locked));
             ProbeManager.ActiveProbeUIUpdateEvent.AddListener(() => SetSurfaceDebugColor(ProbeManager.ActiveProbeManager.Color));
 
+            if (_firstTime || _atlasReset)
+            {
+                Settings.BregmaLambdaRatio = 1f;
+            }
+
             // Complete
             PlayerPrefs.SetInt("scene-atlas-reset", 0);
             StartupEvent_Complete.Invoke();
@@ -1025,14 +1030,12 @@ public void SetBLUI()
         /// <summary>
         /// Change the bregma-lamba distance. By default this is 4.15f, so if it isn't that value, then we need to add an isometric scaling to the current transform
         /// </summary>
-        /// <param name="newBLDistance"></param>
-        public void ChangeBLDistance(float newBLDistance)
+        /// <param name="blRatio"></param>
+        public void ChangeBLRatio(float blRatio)
         {
-            if (BrainAtlasManager.ActiveReferenceAtlas == null || newBLDistance == _blDistance.DefaultBLDistance)
+            if (BrainAtlasManager.ActiveReferenceAtlas == null)
                 return;
 
-            float blRatio = newBLDistance / _blDistance.DefaultBLDistance;
-
 #if UNITY_EDITOR
             Debug.Log($"(BL Distance) Re-scaling to {blRatio}");
 #endif

Assets/Scripts/Pinpoint/UI/BregmaLambdaBehavior.cs

@@ -35,13 +35,15 @@ public void SetBLRange(float min, float max, float blDistance)
         _blSlider.SetValueWithoutNotify(blDistance);
     }
 
-    public void SetText(float value)
+    public void SetSliderAndText(float ratio)
     {
-        _sliderText.text = $"{Mathf.RoundToInt(value * 100f) / 100f}";
+        _blSlider.SetValueWithoutNotify(ratio * _blDistance);
+        _sliderText.text = $"{Mathf.RoundToInt(ratio * _blDistance * 100f) / 100f}";
     }
 
     private void SetSetting(float value)
     {
-        Settings.BregmaLambdaDistance = value;
+        // Convert to ratio then set
+        Settings.BregmaLambdaRatio = value / _blDistance;
     }
 }

Assets/Scripts/Pinpoint/Utilities/Settings.cs

@@ -340,20 +340,20 @@ public static string AtlasTransformName
         }
     }
 
-    private const float BREGMALAMBDA_DEFAULT = -1f;
+    private const float BREGMALAMBDA_DEFAULT = 1f;
     public UnityEvent<float> BregmaLambdaChangedEvent;
 
-    public static float BregmaLambdaDistance
+    public static float BregmaLambdaRatio
     {
         get
         {
-            return data.BregmaLambdaDistance;
+            return data.BregmaLambdaRatio;
         }
         set
         {
-            data.BregmaLambdaDistance = value;
+            data.BregmaLambdaRatio = value;
             Save();
-            Instance.BregmaLambdaChangedEvent.Invoke(data.BregmaLambdaDistance);
+            Instance.BregmaLambdaChangedEvent.Invoke(data.BregmaLambdaRatio);
         }
     }
 
@@ -629,7 +629,7 @@ private void Load(bool fromDefaults = false)
             data.ShowAtlas3DSlices = SHOW3DSLICE_DEFAULT;
             data.RelativeCoord = RELCOORD_DEFAULT;
             data.AtlasTransformName = INVIVO_DEFAULT;
-            data.BregmaLambdaDistance = BREGMALAMBDA_DEFAULT;
+            data.BregmaLambdaRatio = BREGMALAMBDA_DEFAULT;
 
             // ephys link
             data.EphysLinkServerIP = "";
@@ -713,9 +713,9 @@ private void Apply()
 
         // the relative coordinate needs to be set, since it gets propagated downstream
         ReferenceCoord = data.RelativeCoord;
-        BregmaLambdaDistance = data.BregmaLambdaDistance;
+        BregmaLambdaRatio = data.BregmaLambdaRatio;
 
-        // Accounts
+            // Accounts
         _stayLoggedInToggle.SetIsOnWithoutNotify(StayLoggedIn);
 
         // API
@@ -820,7 +820,7 @@ private struct InternalData
         public int ShowAtlas3DSlices;
         public Vector3 RelativeCoord;
         public string AtlasTransformName;
-        public float BregmaLambdaDistance;
+        public float BregmaLambdaRatio;
 
         // Ephys link
         public string EphysLinkServerIP;

Packages/packages-lock.json

@@ -223,14 +223,14 @@
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "8f1d5e978814b53f242ddd32e18c9f6dfc29cc23"
+      "hash": "0bc6ec2b1fb9c71341d63a366a542662986d4141"
     },
     "vbl.urchin": {
       "version": "https://github.com/VirtualBrainLab/Urchin.git?path=/UnityClient/Packages/vbl.urchin",
       "depth": 0,
       "source": "git",
       "dependencies": {},
-      "hash": "3933774b041f0ce14d99bff3cbf747018edc29ff"
+      "hash": "212b78ec0f757bd88b76d470b872a36730408f9f"
     },
     "com.unity.modules.ai": {
       "version": "1.0.0",