Class ProgressTracker

Keeps track of the SBP build progress.

Inheritance

object

ProgressTracker

ProgressLoggingTracker

Implements

IProgressTracker

IContextObject

IDisposable

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: UnityEditor.Build.Pipeline.Utilities

Assembly: Unity.ScriptableBuildPipeline.Editor.dll

Syntax

public class ProgressTracker : IProgressTracker, IContextObject, IDisposable

Constructors

ProgressTracker()

Stores information about the current task.

Declaration

public ProgressTracker()

Properties

CurrentTask

Stores the id of currently running task.

Declaration

protected int CurrentTask { get; set; }

Property Value

Type	Description
int

CurrentTaskTitle

Stores the name of the currently running task.

Declaration

protected string CurrentTaskTitle { get; set; }

Property Value

Type	Description
string

Progress

Stores the amount of progress done as a decimal.

Declaration

public float Progress { get; }

Property Value

Type	Description
float

TaskCount

Stores the number of tasks

Declaration

public int TaskCount { get; set; }

Property Value

Type	Description
int

TimeStamp

Stores current the time stamp.

Declaration

protected long TimeStamp { get; set; }

Property Value

Type	Description
long

UpdateFrequency

Stores the task update frequency.

Declaration

protected long UpdateFrequency { get; set; }

Property Value

Type	Description
long

UpdatesPerSecond

Stores the amount of updates per second.

Declaration

public uint UpdatesPerSecond { get; set; }

Property Value

Type	Description
uint

Methods

Dispose()

Disposes of the progress tracker instance.

Declaration

public void Dispose()

Dispose(bool)

Disposes of the progress tracker instance and clears the popup progress bar.

Declaration

protected virtual void Dispose(bool disposing)

Parameters

Type	Name	Description
bool	disposing	Set to true to clear the popup progress bar. Set to false to leave the progress bar as is.

UpdateInfo(string)

Updates the information displayed for currently running task.

Declaration

public virtual bool UpdateInfo(string taskInfo)

Parameters

Type	Name	Description
string	taskInfo	The task information.

Returns

Type	Description
bool	Returns true if the progress bar is running. Returns false if the user cancels the progress bar.

UpdateTask(string)

Updates the progress bar to reflect the new running task.

Declaration

public virtual bool UpdateTask(string taskTitle)

Parameters

Type	Name	Description
string	taskTitle	The name of the new task.

Returns

Type	Description
bool	Returns true if the progress bar is running. Returns false if the user cancels the progress bar.

Implements

IProgressTracker

IContextObject

IDisposable