Progress

Description

The Progress utility class reports the progress of asynchronous tasks to Unity.

The Progress utility class can be used to report progress of asynchronous tasks in multiple ways. Here is an example of a task that runs on the EditorApplication.update loop and reports progress:

using System.Collections;
using UnityEditor;

class ProgressReport_EditorUpdate
{
    static IEnumerator s_CurrentEnumerator;

    [MenuItem("Examples/ProgressReport/EditorUpdate")]
    static void RunEditorUpdate()
    {
        if (s_CurrentEnumerator == null)
        {
            s_CurrentEnumerator = RunTaskWithReport();
        }
        EditorApplication.update -= RunTaskOnUpdate;
        EditorApplication.update += RunTaskOnUpdate;
    }

    static void RunTaskOnUpdate()
    {
        if (s_CurrentEnumerator == null)
        {
            return;
        }

        // Execute one step of the task
        var atEnd = !s_CurrentEnumerator.MoveNext();

        // If there is nothing more to do, remove the update callback
        if (atEnd)
        {
            s_CurrentEnumerator = null;
            EditorApplication.update -= RunTaskOnUpdate;
        }
    }

    static IEnumerator RunTaskWithReport()
    {
        // Create a new progress indicator
        int progressId = Progress.Start("Running one task");

        // Report the progress status at anytime
        for (int frame = 0; frame <= 1000; ++frame)
        {
            string description;
            if (frame < 250)
                description = "First part of the task";
            else if (frame < 750)
                description = "Second part of the task";
            else
                description = "Last part of the task";
            Progress.Report(progressId, frame / 1000.0f, description);

            // Do your computation that you want to report progress on
            // ...
            yield return null;
        }

        // The task is finished. Remove the associated progress indicator.
        Progress.Remove(progressId);
    }
}

Here is another example of a task that runs on a separate thread and reports progress:

using System.Threading;
using System.Threading.Tasks;
using UnityEditor;

class ProgressReport_Threaded
{
    [MenuItem("Examples/ProgressReport/Threaded")]
    static void RunThreaded()
    {
        Task.Run(RunTaskWithReport);
    }

    static void RunTaskWithReport()
    {
        // Create a new progress indicator
        int progressId = Progress.Start("Running one task");

        // Report the progress status at anytime
        for (int frame = 0; frame <= 1000; ++frame)
        {
            string description;
            if (frame < 250)
                description = "First part of the task";
            else if (frame < 750)
                description = "Second part of the task";
            else
                description = "Last part of the task";
            Progress.Report(progressId, frame / 1000.0f, description);

            // Do your computation that you want to report progress on
            ComputeSlowStep();
        }

        // The task is finished. Remove the associated progress indicator.
        Progress.Remove(progressId);
    }

    static void ComputeSlowStep()
    {
        // Simulate a slow computation with a 1 millisecond sleep
        Thread.Sleep(1);
    }
}

Static Properties

Static Methods

Events