Tanoda
Leap.Unity.ProgressBar Class Reference

This class allows you to easily give feedback of an action as it completes. More...

Public Member Functions

 ProgressBar (IProgressView view)
 Constructs a new progress bar given a progress view object that will display the progress information for this progress bar. More...
 
void Begin (int sections, string title, string info, Action action)
 Begins a new chunk. If this call is made from within a chunk it will generate a sub-chunk that represents a single step in the parent chunk. More...
 
void Step (string infoString="")
 Steps through one section of the current chunk. You can provide an optional info string that will be concatenated to the current info string before progress is displayed. More...
 

Detailed Description

This class allows you to easily give feedback of an action as it completes.

The progress bar is represented as a single 'Chunk' that is made of a certain number of sections. The progress bar is hierarchical, and so each section can itself be another chunk.

Definition at line 66 of file ProgressBar.cs.

Constructor & Destructor Documentation

◆ ProgressBar()

Leap.Unity.ProgressBar.ProgressBar ( IProgressView  view)

Constructs a new progress bar given a progress view object that will display the progress information for this progress bar.

Definition at line 92 of file ProgressBar.cs.

Member Function Documentation

◆ Begin()

void Leap.Unity.ProgressBar.Begin ( int  sections,
string  title,
string  info,
Action  action 
)

Begins a new chunk. If this call is made from within a chunk it will generate a sub-chunk that represents a single step in the parent chunk.

You must specify the number of sections this chunk contains. All title and info strings will be concatenated together when the progress bar is displayed.

You must specify a delegate that represents the action performed by this chunk. This delegate is allowed to call both Begin and StepProgress to progress through its work.

Definition at line 109 of file ProgressBar.cs.

◆ Step()

void Leap.Unity.ProgressBar.Step ( string  infoString = "")

Steps through one section of the current chunk. You can provide an optional info string that will be concatenated to the current info string before progress is displayed.

Definition at line 147 of file ProgressBar.cs.


The documentation for this class was generated from the following file: