fix: repair color to pull entirely from state, no cache in ProbeManager

Author: dbirman

Assets/Scripts/Pinpoint/Probes/ProbeManager.cs

@@ -48,7 +48,7 @@ public class ProbeManager : MonoBehaviour
 
     // Static events
     public static readonly UnityEvent<HashSet<ProbeManager>> EphysLinkControlledProbesChangedEvent =
-        new();
+      new();
     public static readonly UnityEvent ActiveProbeUIUpdateEvent = new();
     #endregion
 
@@ -145,7 +145,7 @@ public static string[] GetAllChannelAnnotationData()
     private Vector3 _recRegionTopCoordWorldU;
 
     public (Vector3 tipCoordU, Vector3 endCoordU) RecRegionCoordWorldU =>
-        (_recRegionBaseCoordWorldU, _recRegionTopCoordWorldU);
+   (_recRegionBaseCoordWorldU, _recRegionTopCoordWorldU);
 
     // Text
     private const float minYaw = -180;
@@ -187,7 +187,7 @@ public bool Locked
     }
 
     public ManipulatorBehaviorController ManipulatorBehaviorController =>
-        gameObject.GetComponent<ManipulatorBehaviorController>();
+      gameObject.GetComponent<ManipulatorBehaviorController>();
 
     public bool IsEphysLinkControlled
     {
@@ -198,31 +198,28 @@ private set
             EphysLinkControlChangeEvent.Invoke();
             EphysLinkControlledProbesChangedEvent.Invoke(
                 Instances.Where(manager => manager.IsEphysLinkControlled).ToHashSet()
-            );
+   );
         }
     }
 
     public string APITarget { get; set; }
 
-    private Color _color;
+    /// <summary>
+    /// Get the probe color from Redux state. This property is read-only and should not be used to set color.
+    /// To set color, dispatch SceneActions.SET_PROBE_COLOR to Redux.
+    /// </summary>
     public Color Color
     {
-        get => _color;
-        set
+        get
         {
-            // try to return the current color
-            ProbeProperties.ReturnColor(_color);
-
-            _color = value;
-            _probeRenderer.material.color = _color;
-
-            foreach (ProbeUIManager puiManager in _probeUIManagers)
-                puiManager.UpdateColors();
-
-            UIUpdateEvent.Invoke();
-            if (ActiveProbeManager == this)
-                ActiveProbeUIUpdateEvent.Invoke();
-            Debug.Log(_color);
+#if APP_UI
+            if (_probeStateCache != null)
+            {
+                return _probeStateCache.ColorValue;
+            }
+#endif
+            // Fallback to renderer color if state not available
+            return _probeRenderer != null ? _probeRenderer.material.color : Color.white;
         }
     }
 
@@ -259,10 +256,6 @@ private async void Awake()
         UUID = Guid.NewGuid().ToString();
         UpdateName();
 
-        // Set color
-        if (_probeRenderer != null)
-            _color = ProbeProperties.NextColor;
-
         // Record default materials
         _defaultMaterials = new Dictionary<GameObject, Material>();
         _activeRenderers = new();
@@ -299,11 +292,6 @@ private void Start()
 #if UNITY_EDITOR
         Debug.Log($"(ProbeManager) New probe created with UUID: {UUID}");
 #endif
-        // Force update color
-        foreach (ProbeUIManager puiManager in _probeUIManagers)
-            puiManager.UpdateColors();
-        if (_probeRenderer)
-            _probeRenderer.material.color = _color;
 
         UIUpdateEvent.Invoke();
 
@@ -313,18 +301,18 @@ private void Start()
 #if APP_UI
         // Subscribe to state and initialize properties.
         _probeStateSubscription = PinpointApp.StoreServiceStore.Subscribe(
-            state =>
+                  state =>
                 state
-                    .Get<SceneState>(SliceNames.SCENE_SLICE)
-                    .Probes.FirstOrDefault(probeState => probeState.Name == name),
-            state =>
-            {
-                if (state == _probeStateCache) return;
-                _probeStateCache = state;
-                OnProbeStateChanged(state);
-            },
-            new SubscribeOptions<ProbeState> { fireImmediately = true }
-        );
+                  .Get<SceneState>(SliceNames.SCENE_SLICE)
+                .Probes.FirstOrDefault(probeState => probeState.Name == name),
+           state =>
+                  {
+                      if (state == _probeStateCache) return;
+                      _probeStateCache = state;
+                      OnProbeStateChanged(state);
+                  },
+      new SubscribeOptions<ProbeState> { fireImmediately = true }
+              );
 #endif
     }
 
@@ -335,8 +323,6 @@ private void Start()
     /// </summary>
     public void Cleanup()
     {
-        ProbeProperties.ReturnColor(Color);
-
         ColliderManager.RemoveProbeColliderInstances(_probeColliders);
 
         // Force disable Ephys Link
@@ -382,11 +368,22 @@ private async void OnProbeStateChanged(ProbeState state)
         // Core Identity.
         name = state.Name;
 
-        // Probe Configuration.
-        _probeRenderer.material.color = state.ColorValue;
+        // Probe Configuration - Update renderer color from state.
+        if (_probeRenderer != null)
+        {
+            _probeRenderer.material.color = state.ColorValue;
+        }
 
         ProbeDisplay = state.ProbeDisplayType;
 
+        // Notify UI managers to update their colors from state.
+        foreach (ProbeUIManager puiManager in _probeUIManagers)
+            puiManager.UpdateColors();
+
+        UIUpdateEvent.Invoke();
+        if (ActiveProbeManager == this)
+            ActiveProbeUIUpdateEvent.Invoke();
+
         // Channel Maps.
         await _channelMapLoadedSource.Task;
         _channelMap.SetSelectionLayer(state.SelectionLayerName);
@@ -433,8 +430,8 @@ public async Task<ChannelMap> GetChannelMap()
     public void Update2ActiveTransform()
     {
         _probeController.SetSpaceTransform(
-            BrainAtlasManager.ActiveReferenceAtlas.AtlasSpace,
-            BrainAtlasManager.ActiveAtlasTransform
+      BrainAtlasManager.ActiveReferenceAtlas.AtlasSpace,
+ BrainAtlasManager.ActiveAtlasTransform
         );
     }
 
@@ -459,13 +456,13 @@ public void UpdateName()
 #if !APP_UI
         if (OverrideName != null)
         {
-            name = OverrideName;
-        }
+ name = OverrideName;
+     }
         else
         {
 
             // Check if this probe is in the brain
-            name = _probeInBrain ? $"{_probeUIManagers[0].MaxArea}-{UUID[..8]}" : UUID[..8];
+      name = _probeInBrain ? $"{_probeUIManagers[0].MaxArea}-{UUID[..8]}" : UUID[..8];
 
         }
 #endif
@@ -482,11 +479,11 @@ public void ProbeMoved()
 
         // Update the world coordinates for the tip position
         Vector3 startCoordWorldT =
-            _probeController.ProbeTipT.position
-            + -_probeController.ProbeTipT.forward * channelCoords.startPosmm;
+    _probeController.ProbeTipT.position
+        + -_probeController.ProbeTipT.forward * channelCoords.startPosmm;
         Vector3 endCoordWorldT =
-            _probeController.ProbeTipT.position
-            + -_probeController.ProbeTipT.forward * channelCoords.endPosmm;
+        _probeController.ProbeTipT.position
+      + -_probeController.ProbeTipT.forward * channelCoords.endPosmm;
         _recRegionBaseCoordWorldU = BrainAtlasManager.WorldT2WorldU(startCoordWorldT, true);
         _recRegionTopCoordWorldU = BrainAtlasManager.WorldT2WorldU(endCoordWorldT, true);
     }
@@ -499,7 +496,7 @@ public void ProbeMoved()
     private void DispatchProbeWorldState()
     {
         // Get tip world coordinates
-        var (tipCoordWorldU, tipRightWorldU, tipUpWorldU, tipForwardWorldU) = 
+        var (tipCoordWorldU, tipRightWorldU, tipUpWorldU, tipForwardWorldU) =
             _probeController.GetTipWorldU();
 
         // Get tip position in WorldT
@@ -558,7 +555,7 @@ public async void UpdateSelectionLayer(string selectionLayerName)
     /// <summary>
     /// Update the channel map data according to the selected channels
     /// Defaults to the first 384 channels
-    ///
+    /// 
     /// Sets channelMinY/channelMaxY in mm
     /// </summary>
     public void UpdateChannelMap()
@@ -1056,9 +1053,9 @@ public void UpdateSurfacePosition()
     )
     {
         if (BrainAtlasManager.Instance == null || BrainAtlasManager.ActiveReferenceAtlas == null)
- return (new Vector3(float.NaN, float.NaN, float.NaN), false);
-        
-     // note: the backward axis on the probe is the probe's "up" axis
+            return (new Vector3(float.NaN, float.NaN, float.NaN), false);
+
+        // note: the backward axis on the probe is the probe's "up" axis
         (Vector3 tipCoordWorldU, _, _, Vector3 tipForwardWorldU) = _probeController.GetTipWorldU();
 
         Vector3 tipAtlasIdxU = BrainAtlasManager.ActiveReferenceAtlas.World2AtlasIdx(
@@ -1135,8 +1132,8 @@ public void UpdateSurfacePosition()
     public Vector3 FindEntryIdxCoordinate(Vector3 bottomIdxCoordU, Vector3 downVector)
     {
         if (BrainAtlasManager.Instance == null || BrainAtlasManager.ActiveReferenceAtlas == null)
-     return new Vector3(float.NaN, float.NaN, float.NaN);
-   
+            return new Vector3(float.NaN, float.NaN, float.NaN);
+
         float searchDistance =
        BrainAtlasManager.ActiveReferenceAtlas.Dimensions.z
 * 1000f
@@ -1313,7 +1310,7 @@ private void SetMaterialsDefault()
     private void SetMaterialsLine()
     {
 #if UNITY_EDITOR && !APP_UI
-        Debug.Log($"Setting materials for {name} to line");
+Debug.Log($"Setting materials for {name} to line");
 #endif
         foreach (var childRenderer in _activeRenderers)
             childRenderer.enabled = false;
@@ -1338,8 +1335,8 @@ private void SetMaterialsLine()
 
             var channelData = GetChannelRangemm();
             _lineRenderer.SetPositions(
-                new Vector3[] { Vector3.zero, Vector3.up * channelData.fullHeight }
-            );
+            new Vector3[] { Vector3.zero, Vector3.up * channelData.fullHeight }
+          );
         }
     }
 

Assets/Scripts/Pinpoint/Probes/UI/ProbeUIManager.cs

@@ -1,23 +1,28 @@
 using BrainAtlas;
 using System;
 using System.Collections.Generic;
+using System.Linq;
+using Models;
+using Models.Scene;
+using Services;
+using UI;
+using Unity.AppUI.MVVM;
+using Unity.AppUI.Redux;
 using UnityEngine;
 using UnityEngine.Serialization;
 using UnityEngine.UI;
 
 public class ProbeUIManager : MonoBehaviour
 {
-    [FormerlySerializedAs("probePanelPrefab")] [SerializeField] private GameObject _probePanelPrefab;
+    [FormerlySerializedAs("probePanelPrefab")][SerializeField] private GameObject _probePanelPrefab;
     private GameObject probePanelGO;
     private TP_ProbePanel probePanel;
 
-    [FormerlySerializedAs("probeManager")] [SerializeField] private ProbeManager _probeManager;
+    [FormerlySerializedAs("probeManager")][SerializeField] private ProbeManager _probeManager;
 
-    [FormerlySerializedAs("electrodeBase")] [SerializeField] private GameObject _electrodeBase;
-    [FormerlySerializedAs("order")] [SerializeField] private int _order;
+    [FormerlySerializedAs("electrodeBase")][SerializeField] private GameObject _electrodeBase;
+    [FormerlySerializedAs("order")][SerializeField] private int _order;
 
-    private Color defaultColor;
-    private Color selectedColor;
     private bool _selected;
 
     private bool probeMovedDirty = false;
@@ -76,14 +81,12 @@ public Transform ShankTipT()
         return _electrodeBase.transform;
     }
 
+    /// <summary>
+    /// Update colors by pulling directly from Redux state.
+    /// This method retrieves the color from state and applies it to the UI.
+    /// </summary>
     public void UpdateColors()
     {
-        defaultColor = _probeManager.Color;
-        defaultColor.a = 0.5f;
-
-        selectedColor = defaultColor;
-        selectedColor.a = 0.75f;
-
         UpdateUIManagerColor();
     }
 
@@ -202,7 +205,7 @@ private async void ProbedMovedHelper()
     /// <param name="tipIdxWorldT"></param>
     /// <param name="topIdxWorldT"></param>
     /// <returns></returns>
-    private (List<int>, List<int>, List<string>)  InterpolateAnnotationIDs(Vector3 tipIdxWorldT, Vector3 topIdxWorldT)
+    private (List<int>, List<int>, List<string>) InterpolateAnnotationIDs(Vector3 tipIdxWorldT, Vector3 topIdxWorldT)
     {
         // pixel height at which changes happen
         List<int> areaPositionPixels = new();
@@ -293,12 +296,48 @@ public void ProbeSelected(bool selected)
         UpdateUIManagerColor();
     }
 
+    /// <summary>
+    /// Update the UI manager color by pulling the probe color from Redux state.
+    /// Computes default and selected colors with appropriate alpha values on demand.
+    /// </summary>
     private void UpdateUIManagerColor()
     {
-        if (_selected)
-            probePanelGO.GetComponent<Image>().color = selectedColor;
-        else
-            probePanelGO.GetComponent<Image>().color = defaultColor;
+#if APP_UI
+        // Get color from Redux state
+        var storeService = PinpointApp.Services.GetRequiredService<StoreService>();
+        var sceneState = storeService.Store.GetState<SceneState>(SliceNames.SCENE_SLICE);
+        var probeState = sceneState.Probes.FirstOrDefault(p => p.Name == _probeManager.name);
+
+        if (probeState != null)
+        {
+            // Compute colors from state with appropriate alpha values
+            Color defaultColor = probeState.ColorValue;
+            defaultColor.a = 0.5f;
+
+            Color selectedColor = probeState.ColorValue;
+            selectedColor.a = 0.75f;
+
+            // Apply the appropriate color
+            var imageComponent = probePanelGO.GetComponent<Image>();
+            if (imageComponent != null)
+            {
+                imageComponent.color = _selected ? selectedColor : defaultColor;
+            }
+        }
+#else
+    // Fallback for non-APP_UI builds - get color from ProbeManager
+    Color defaultColor = _probeManager.Color;
+        defaultColor.a = 0.5f;
+
+        Color selectedColor = _probeManager.Color;
+  selectedColor.a = 0.75f;
+
+        var imageComponent = probePanelGO.GetComponent<Image>();
+        if (imageComponent != null)
+   {
+     imageComponent.color = _selected ? selectedColor : defaultColor;
+        }
+#endif
     }
 
     public void ResizeProbePanel(int newPxHeight)

Assets/Scripts/Pinpoint/TrajectoryPlannerManager.cs

@@ -989,7 +989,7 @@ private void LoadSavedProbesFromStringArray(string[] savedProbes)
 
                     newProbeManager.UpdateSelectionLayer(probeData.SelectionLayerName);
                     newProbeManager.OverrideName = probeData.Name;
-                    newProbeManager.Color = probeData.Color;
+                    //newProbeManager.Color = probeData.Color;
                     newProbeManager.APITarget = probeData.APITarget;
                 }
             }