Progress reporting of async texture creation

Assets/Editor/EditorProgressView.cs

@@ -26,11 +26,11 @@ public void FinishProgress(ProgressStatus status = ProgressStatus.Succeeded)
             EditorApplication.update -= EditorUpdate;
         }
 
-        public void UpdateProgress(float progress, string description)
+        public void UpdateProgress(float totalProgress, float currentStageProgress, string description)
         {
-            this.cachedProgress = progress;
+            this.cachedProgress = totalProgress;
             this.cachedDescription = description;
-            ShowProgress(progress, description);
+            ShowProgress(totalProgress, description);
         }
 
         private void EditorUpdate()
@@ -42,7 +42,7 @@ private void ShowProgress(float progress, string description)
         {
             if (progressId != -1)
             {
-                Progress.Report(progressId, progress, description);
+                Progress.Report(progressId, progress, progress == 1.0f ? "Done" : description);
             }
         }
     }

Assets/Editor/RAWDatasetImporterEditorWIndow.cs

@@ -45,9 +45,8 @@ public RAWDatasetImporterEditorWindow(string filePath)
 
         private async Task ImportDatasetAsync()
         {
-            using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView()))
+            using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView(), "RAW import"))
             {
-                progressHandler.Start("RAW import", "Importing RAW...");
                 progressHandler.ReportProgress(0.0f, "Importing RAW dataset");
 
                 RawDatasetImporter importer = new RawDatasetImporter(fileToImport, dimX, dimY, dimZ, dataFormat, endianness, bytesToSkip);
@@ -73,8 +72,6 @@ private async Task ImportDatasetAsync()
                     Debug.LogError("Failed to import datset");
                 }
 
-                progressHandler.Finish();
-
                 this.Close();
             }
         }

Assets/Editor/VolumeRenderedObjectCustomInspector.cs

@@ -1,24 +1,53 @@
 using UnityEngine;
 using UnityEditor;
+using System.Collections.Generic;
+using System.Threading.Tasks;
 
 namespace UnityVolumeRendering
 {
     [CustomEditor(typeof(VolumeRenderedObject))]
-    public class VolumeRenderedObjectCustomInspector : Editor
+    public class VolumeRenderedObjectCustomInspector : Editor, IProgressView
     {
         private bool tfSettings = true;
         private bool lightSettings = true;
         private bool otherSettings = true;
+        private float currentProgress = 1.0f;
+        private string currentProgressDescrition = "";
+
+        public void StartProgress(string title, string description)
+        {
+        }
+
+        public void FinishProgress(ProgressStatus status = ProgressStatus.Succeeded)
+        {
+            currentProgress = 1.0f;
+        }
+
+        public void UpdateProgress(float totalProgress, float currentStageProgress, string description)
+        {
+            currentProgressDescrition = description;
+            currentProgress = totalProgress;
+        }
 
         public override void OnInspectorGUI()
         {
             VolumeRenderedObject volrendObj = (VolumeRenderedObject)target;
 
+            if (currentProgress < 1.0f)
+            {
+                Rect rect = EditorGUILayout.BeginVertical();
+                EditorGUI.ProgressBar(rect, currentProgress, currentProgressDescrition);
+                GUILayout.Space(18);
+                EditorGUILayout.EndVertical();
+            }
+
             // Render mode
             RenderMode oldRenderMode = volrendObj.GetRenderMode();
             RenderMode newRenderMode = (RenderMode)EditorGUILayout.EnumPopup("Render mode", oldRenderMode);
             if (newRenderMode != oldRenderMode)
-                volrendObj.SetRenderMode(newRenderMode);
+            {
+                Task task = volrendObj.SetRenderModeAsync(newRenderMode, new ProgressHandler(this));
+            }
 
             // Visibility window
             Vector2 visibilityWindow = volrendObj.GetVisibilityWindow();
@@ -33,7 +62,9 @@ public override void OnInspectorGUI()
                 // Transfer function type
                 TFRenderMode tfMode = (TFRenderMode)EditorGUILayout.EnumPopup("Transfer function type", volrendObj.GetTransferFunctionMode());
                 if (tfMode != volrendObj.GetTransferFunctionMode())
-                    volrendObj.SetTransferFunctionMode(tfMode);
+                {
+                    Task task = volrendObj.SetTransferFunctionModeAsync(tfMode, new ProgressHandler(this));
+                }
 
                 // Show TF button
                 if (GUILayout.Button("Edit transfer function"))
@@ -51,7 +82,9 @@ public override void OnInspectorGUI()
             if (lightSettings)
             {
                 if (volrendObj.GetRenderMode() == RenderMode.DirectVolumeRendering)
-                    volrendObj.SetLightingEnabled(GUILayout.Toggle(volrendObj.GetLightingEnabled(), "Enable lighting"));
+                {
+                    Task task = volrendObj.SetLightingEnabledAsync(GUILayout.Toggle(volrendObj.GetLightingEnabled(), "Enable lighting"), new ProgressHandler(this));
+                }
                 else
                     volrendObj.SetLightingEnabled(false);
 

Assets/Editor/VolumeRendererEditorFunctions.cs

@@ -41,10 +41,9 @@ static async void DicomImportAsync()
             if (Directory.Exists(dir))
             {
                 Debug.Log("Async dataset load. Hold on.");
-                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView()))
+                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView(), "DICOM import"))
                 {
                     await DicomImportDirectoryAsync(dir, progressHandler);
-                    progressHandler.Finish();
                 }
             }
             else
@@ -56,7 +55,6 @@ static async void DicomImportAsync()
         static async Task DicomImportDirectoryAsync(string dir, ProgressHandler progressHandler)
         {
             Debug.Log("Async dataset load. Hold on.");
-            progressHandler.Start("DICOM import", "Importing DICOM...");
 
             bool recursive = true;
 
@@ -75,22 +73,23 @@ static async Task DicomImportDirectoryAsync(string dir, ProgressHandler progress
 
             if (fileCandidates.Any())
             {
-                progressHandler.StartStage(0.6f, "Loading DICOM series");
+                progressHandler.StartStage(0.2f, "Loading DICOM series");
 
                 IImageSequenceImporter importer = ImporterFactory.CreateImageSequenceImporter(ImageSequenceFormat.DICOM);
                 IEnumerable<IImageSequenceSeries> seriesList = await importer.LoadSeriesAsync(fileCandidates, new ImageSequenceImportSettings { progressHandler = progressHandler });
                 float numVolumesCreated = 0;
 
                 progressHandler.EndStage();
-                progressHandler.StartStage(0.4f);
+                progressHandler.StartStage(0.8f);
 
                 int seriesIndex = 0, numSeries = seriesList.Count();
                 foreach (IImageSequenceSeries series in seriesList)
                 {
-                    progressHandler.ReportProgress(seriesIndex, numSeries, $"Importing series {seriesIndex} of {numSeries}");
-                    progressHandler.StartStage(0.8f);
+                    progressHandler.StartStage((seriesIndex + 1) / numSeries, $"Importing series {seriesIndex} of {numSeries}");
+                    progressHandler.StartStage(0.7f, $"Importing series {seriesIndex} of {numSeries}");
                     VolumeDataset dataset = await importer.ImportSeriesAsync(series, new ImageSequenceImportSettings { progressHandler = progressHandler });
                     progressHandler.EndStage();
+                    progressHandler.StartStage(0.3f, "Creating object");
                     if (dataset != null)
                     {
                         if (EditorPrefs.GetBool("DownscaleDatasetPrompt"))
@@ -103,10 +102,12 @@ static async Task DicomImportDirectoryAsync(string dir, ProgressHandler progress
                             }
                         }
 
-                        VolumeRenderedObject obj = await VolumeObjectFactory.CreateObjectAsync(dataset);
+                        VolumeRenderedObject obj = await VolumeObjectFactory.CreateObjectAsync(dataset, progressHandler);
                         obj.transform.position = new Vector3(numVolumesCreated, 0, 0);
                         numVolumesCreated++;
                     }
+                    progressHandler.EndStage();
+                    progressHandler.EndStage();
                     seriesIndex++;
                 }
 
@@ -138,9 +139,8 @@ static async void ImportNRRDDatasetAsync()
             if (File.Exists(file))
             {
                 Debug.Log("Async dataset load. Hold on.");
-                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView()))
+                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView(), "NRRD import"))
                 {
-                    progressHandler.Start("NRRD import", "Importing NRRD...");
                     progressHandler.ReportProgress(0.0f, "Importing NRRD dataset");
 
                     IImageFileImporter importer = ImporterFactory.CreateImageFileImporter(ImageFileFormat.NRRD);
@@ -155,7 +155,6 @@ static async void ImportNRRDDatasetAsync()
                     {
                         Debug.LogError("Failed to import datset");
                     }
-                    progressHandler.Finish();
                 }
             }
             else
@@ -176,9 +175,8 @@ static async void ImportNIFTIDatasetAsync()
             if (File.Exists(file))
             {
                 Debug.Log("Async dataset load. Hold on.");
-                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView()))
+                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView(), "NIFTI import"))
                 {
-                    progressHandler.Start("NIfTI import", "Importing NIfTI...");
                     progressHandler.ReportProgress(0.0f, "Importing NIfTI dataset");
 
                     IImageFileImporter importer = ImporterFactory.CreateImageFileImporter(ImageFileFormat.NIFTI);
@@ -194,7 +192,6 @@ static async void ImportNIFTIDatasetAsync()
                     {
                         Debug.LogError("Failed to import datset");
                     }
-                    progressHandler.Finish();
                 }
             }
             else
@@ -215,9 +212,8 @@ static async void ImportParDatasetAsync()
             if (File.Exists(file))
             {
                 Debug.Log("Async dataset load. Hold on.");
-                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView()))
+                using (ProgressHandler progressHandler = new ProgressHandler(new EditorProgressView(), "AVSP import"))
                 {
-                    progressHandler.Start("VASP import", "Importing VASP...");
                     progressHandler.ReportProgress(0.0f, "Importing VASP dataset");
 
                     IImageFileImporter importer = ImporterFactory.CreateImageFileImporter(ImageFileFormat.VASP);
@@ -233,7 +229,6 @@ static async void ImportParDatasetAsync()
                     {
                         Debug.LogError("Failed to import datset");
                     }
-                    progressHandler.Finish();
                 }
             }
             else

Assets/Scripts/Importing/ImageFileImporter/SimpleITK/SimpleITKImageFileImporter.cs

@@ -41,7 +41,8 @@ public async Task<VolumeDataset> ImportAsync(string filePath)
 
             return volumeDataset;
         }
-        private void ImportInternal(VolumeDataset volumeDataset, float[] pixelData,VectorUInt32 size,VectorDouble spacing,string filePath)
+
+        private void ImportInternal(VolumeDataset volumeDataset, float[] pixelData, VectorUInt32 size, VectorDouble spacing,string filePath)
         {
             ImageFileReader reader = new ImageFileReader();
 

Assets/Scripts/Importing/ImageSequenceImporter/OpenDICOM/DICOMImporter.cs

@@ -404,7 +404,7 @@ private void CalculateSliceLocations(List<DICOMSliceFile> slices)
             Vector3 yBase = new Vector3(cosines[3], cosines[4], cosines[5]);
             Vector3 normal = Vector3.Cross(xBase, yBase);
 
-            for(int i = 1; i < slices.Count; i++)
+            for(int i = 0; i < slices.Count; i++)
             {
                 Vector3 position = slices[i].position;
                 // Project p onto n. d = dot(p,n) / |n| = dot(p,n)

Assets/Scripts/Importing/ImageSequenceImporter/SimpleITK/SimpleITKImageSequenceImporter.cs

@@ -126,10 +126,11 @@ public async Task<VolumeDataset> ImportSeriesAsync(IImageSequenceSeries series,
             if (sequenceSeries.files.Count == 0)
             {
                 Debug.LogError("Empty series. No files to load.");
+                settings.progressHandler.Fail();
                 return null;
             }
 
-            await Task.Run(() => ImportSeriesInternal(dicomNames,sequenceSeries,image,size,pixelData,volumeDataset));
+            await Task.Run(() => ImportSeriesInternal(dicomNames, sequenceSeries, image, size, pixelData, volumeDataset));
 
             return volumeDataset;
         }
@@ -169,7 +170,7 @@ private void ImportSeriesInternal(VectorString dicomNames, ImageSequenceSeries s
             volumeDataset.dimX = (int)size[0];
             volumeDataset.dimY = (int)size[1];
             volumeDataset.dimZ = (int)size[2];
-            volumeDataset.datasetName = "test";
+            volumeDataset.datasetName = System.IO.Path.GetFileName(dicomNames[0]);
             volumeDataset.filePath = dicomNames[0];
             volumeDataset.scale = new Vector3(
                 (float)(spacing[0] * size[0]) / 1000.0f, // mm to m

Assets/Scripts/Progress/IProgressHandler.cs

@@ -6,5 +6,6 @@ public interface IProgressHandler
         void EndStage();
         void ReportProgress(float progress, string description = "");
         void ReportProgress(int currentStep, int totalSteps, string description = "");
+        void Fail();
     }
 }

Assets/Scripts/Progress/NullProgressHandler.cs

@@ -2,6 +2,8 @@ namespace UnityVolumeRendering
 {
     public class NullProgressHandler : IProgressHandler
     {
+        public static readonly IProgressHandler instance = new NullProgressHandler();
+
         public void StartStage(float weight, string description = "")
         {
         }
@@ -17,5 +19,9 @@ public void ReportProgress(float progress, string description = "")
         public void ReportProgress(int currentStep, int totalSteps, string description = "")
         {
         }
+
+        public void Fail()
+        {
+        }
     }
 }