Quantum.ProgressBar Class Reference

A progress bar implementation used by the navmesh importing. The progress bar is only showed when the LogLevel is set to Debug. More...

Inherits IDisposable.

Public Member Functions
	ProgressBar (string title, bool isCancelable=false, bool logStopwatch=false)
	Create a progress bar instance. More...
void	Dispose ()
	Dispose, hide the progress bar UI. More...
void	SetInfo (string value)
	Uses Info property. More...
void	SetProgress (float value)
	Uses Progress property."/> More...

Properties
string	Info [get, set]
	Set the new sub headline for the progress bar and reset the progress. More...
float	Progress [get, set]
	Set the progress of the current task. More...

Detailed Description

A progress bar implementation used by the navmesh importing. The progress bar is only showed when the LogLevel is set to Debug.

Constructor & Destructor Documentation

ProgressBar()

Quantum.ProgressBar.ProgressBar ( string  title, bool  isCancelable = false, bool  logStopwatch = false  )

inline

Create a progress bar instance.

Parameters

title	The title
isCancelable	Is the process cancelable
logStopwatch	Should the timer result be logged out periodically

Member Function Documentation

SetInfo()

void Quantum.ProgressBar.SetInfo ( string  value )

inline

Uses Info property.

Parameters

value

Into value

SetProgress()

void Quantum.ProgressBar.SetProgress ( float  value )

inline

Uses Progress property."/>

Parameters

value

Progress value between 0..1

Dispose()

void Quantum.ProgressBar.Dispose ( )

inline

Dispose, hide the progress bar UI.

Property Documentation

Info

string Quantum.ProgressBar.Info

getset

Set the new sub headline for the progress bar and reset the progress.

Progress

float Quantum.ProgressBar.Progress

getset

Set the progress of the current task.