VizKit
3.3.7
|
A VisualProgressIndicator communicates the progress of a process. More...
#include <VisualProgressIndicator.h>
Public Member Functions | |
VisualProgressIndicator () | |
The constructor. | |
~VisualProgressIndicator () | |
The destructor. | |
VisualProgressIndicator (const VisualProgressIndicator &other) | |
Copy constructor. | |
VisualProgressIndicator & | operator= (const VisualProgressIndicator &other) |
Assignment operator. | |
double | getState (void) const |
Returns the current state of the progress indicator. | |
void | setState (double state) |
Sets the state of the progress indicator. | |
Static Public Attributes | |
static const double | kProgressNotStarted = -1.0 |
Progress did not start yet. | |
static const double | kProgressUnknown = -2.0 |
Progress is not known (possibly because the complete amount of data is not known). | |
Private Member Functions | |
void | copy (const VisualProgressIndicator &other) |
Copy method for assignment operator and copy constructor. | |
Private Attributes | |
double | currentProgressState |
The current state of the progress. |
A VisualProgressIndicator communicates the progress of a process.
Basically the indicator goes from 0.0 to 1.0.
The constructor.
The destructor.
VisualProgressIndicator::VisualProgressIndicator | ( | const VisualProgressIndicator & | other | ) |
Copy constructor.
other | Reference to another VisualProgressIndicator. |
void VisualProgressIndicator::copy | ( | const VisualProgressIndicator & | other | ) | [private] |
Copy method for assignment operator and copy constructor.
other | Another VisualProgressIndicator. |
double VisualProgressIndicator::getState | ( | void | ) | const |
Returns the current state of the progress indicator.
VisualProgressIndicator & VisualProgressIndicator::operator= | ( | const VisualProgressIndicator & | other | ) |
Assignment operator.
other | Reference to another VisualProgressIndicator. |
void VisualProgressIndicator::setState | ( | double | state | ) |
Sets the state of the progress indicator.
state | The state of the progress indicator. |
double VizKit::VisualProgressIndicator::currentProgressState [private] |
The current state of the progress.
const double VisualProgressIndicator::kProgressNotStarted = -1.0 [static] |
Progress did not start yet.
const double VisualProgressIndicator::kProgressUnknown = -2.0 [static] |
Progress is not known (possibly because the complete amount of data is not known).