Fixing slice renderer bugs + documenting SliceRenderer

Author: dbirman

Assets/Scripts/TP_SliceRenderer.cs

@@ -28,21 +28,22 @@ public class TP_SliceRenderer : MonoBehaviour
     // Start is called before the first frame update
     void Start()
     {
-        annotationDataset = tpmanager.GetAnnotationDataset();
-
         sagittalTex = new Texture2D(baseSize[0], baseSize[1]);
         sagittalTex.filterMode = FilterMode.Point;
         mlIdx = Mathf.RoundToInt(baseSize[2] / 2);
-
         sagittalSliceGO.GetComponent<Renderer>().material.mainTexture = sagittalTex;
 
         coronalTex = new Texture2D(baseSize[2], baseSize[1]);
         coronalTex.filterMode = FilterMode.Point;
         apIdx = Mathf.RoundToInt(baseSize[0] / 2);
-
         coronalSliceGO.GetComponent<Renderer>().material.mainTexture = coronalTex;
     }
 
+    public void AsyncStart()
+    {
+        annotationDataset = tpmanager.GetAnnotationDataset();
+    }
+
     private void Update()
     {
         if (localPrefs.GetSlice3D())
@@ -60,7 +61,10 @@ private void Update()
             if (needToRender) RenderAnnotationLayer();
         }
     }
-
+    
+    /// <summary>
+    /// Shift the position of the sagittal and coronal slices to match the tip of the active probe
+    /// </summary>
     private void UpdateSlicePosition()
     {
         ProbeController activeProbeController = tpmanager.GetActiveProbeController();
@@ -75,6 +79,11 @@ private void UpdateSlicePosition()
         apIdx = Mathf.RoundToInt((apPosition + 6.6f) * 40);
     }
 
+    /// <summary>
+    /// When the camera swtiches from looking from the "left" or "right" of a slice, flip the direction we are rendering
+    /// [TODO: this would be better to solve with a two-sided shader, the current approach causes a lot of lag]
+    /// </summary>
+    /// <returns></returns>
     private bool UpdateCameraPosition()
     {
         Vector3 camPosition = Camera.main.transform.position;
@@ -118,6 +127,9 @@ private bool UpdateCameraPosition()
         return false;
     }
 
+    /// <summary>
+    /// Draw onto the sagittal and coronal slices the annotations at the current slice position in the CCF
+    /// </summary>
     private void RenderAnnotationLayer()
     {
         // Render sagittal slice

Assets/Scripts/TrajectoryPlannerManager.cs

@@ -16,6 +16,7 @@ public class TrajectoryPlannerManager : MonoBehaviour
     [SerializeField] private TP_RecRegionSlider recRegionSlider;
     [SerializeField] private Collider ccfCollider;
     [SerializeField] private TP_InPlaneSlice inPlaneSlice;
+    [SerializeField] private TP_SliceRenderer sliceRenderer;
     [SerializeField] private TP_Search searchControl;
     [SerializeField] private TMP_InputField searchInput;
 
@@ -94,6 +95,12 @@ private void Awake()
     private uint[] annotationMap_ints;
     private int annotationDatasetWait = 0;
     private AnnotationDataset annotationDataset;
+
+    /// <summary>
+    /// Loads the annotation dataset files from their Addressable AssetReference objects
+    /// 
+    /// Asynchronous dependencies: inPlaneSlice, localPrefs
+    /// </summary>
     private void LoadAnnotationDataset()
     {
         dataIndexes.LoadAssetAsync<TextAsset>().Completed += handle =>
@@ -126,6 +133,9 @@ private void LoadAnnotationDataset()
         Debug.Log("Annotation dataset loading");
     }
 
+    /// <summary>
+    /// Called asynchronously when LoadAnnotationDataset loads all three indexes. Builds the dataset object and calls dependencies.
+    /// </summary>
     private void LoadAnnotationDatasetCompleted()
     {
         Debug.Log("Annotation dataset loaded");
@@ -136,18 +146,18 @@ private void LoadAnnotationDatasetCompleted()
         inPlaneSlice.StartAnnotationDataset();
 
         localPrefs.AsyncStart();
-    }
-
-
-    private void Start()
-    {
+        sliceRenderer.AsyncStart();
     }
 
     public void ClickSearchArea(GameObject target)
     {
         searchControl.ClickArea(target);
     }
 
+    /// <summary>
+    /// 
+    /// </summary>
+    /// <param name="value"></param>
     public void ToggleBeryl(int value)
     {
         switch (value)