iProgressMeter Struct Reference
This is a general interface for a progress meter. More...
#include <pmeter.h>
Inheritance diagram for iProgressMeter:

Public Methods | |
virtual void | SetProgressDescription (const char *id, const char *description,...)=0 |
Set the id and description of what we are currently monitoring. | |
virtual void | SetProgressDescriptionV (const char *id, const char *description, va_list)=0 |
Set the id and description of what we are currently monitoring. | |
virtual void | Step ()=0 |
Increment the meter by one unit. | |
virtual void | Reset ()=0 |
Reset the meter to 0%. | |
virtual void | Restart ()=0 |
Reset the meter and print the initial tick mark ("0%"). | |
virtual void | Abort ()=0 |
Abort the meter. | |
virtual void | Finalize ()=0 |
Finalize the meter (i.e. we completed the task sooner than expected). | |
virtual void | SetTotal (int n)=0 |
Set the total element count represented by the meter and perform a reset. | |
virtual int | GetTotal () const=0 |
Get the total element count represented by the meter. | |
virtual int | GetCurrent () const=0 |
Get the current value of the meter (<= total). | |
virtual void | SetGranularity (int)=0 |
Set the refresh granularity. | |
virtual int | GetGranularity () const=0 |
Get the refresh granularity. |
Detailed Description
This is a general interface for a progress meter.The engine needs an implementation of this to be able to report progress on calculating lighting and other stuff.
Definition at line 32 of file pmeter.h.
Member Function Documentation
|
Abort the meter.
Implemented in csTextProgressMeter. |
|
Finalize the meter (i.e. we completed the task sooner than expected).
Implemented in csTextProgressMeter. |
|
Get the current value of the meter (<= total).
Implemented in csTextProgressMeter. |
|
Get the refresh granularity.
Implemented in csTextProgressMeter. |
|
Get the total element count represented by the meter.
Implemented in csTextProgressMeter. |
|
Reset the meter to 0%.
Implemented in csTextProgressMeter. Referenced by csTextProgressMeter::SetTotal(). |
|
Reset the meter and print the initial tick mark ("0%").
Implemented in csTextProgressMeter. |
|
Set the refresh granularity. Valid values are 1-100, inclusive. Default is 10. The meter is only refreshed after each "granularity" * number of units have passed. For instance, if granularity is 20, then * the meter will only be updated at most 5 times, or every 20%. Implemented in csTextProgressMeter. |
|
Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Implemented in csTextProgressMeter. |
|
Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Implemented in csTextProgressMeter. |
|
Set the total element count represented by the meter and perform a reset.
Implemented in csTextProgressMeter. |
|
Increment the meter by one unit. If the meter reaches 100% it should automatically stop itself. Implemented in csTextProgressMeter. |
The documentation for this struct was generated from the following file:
- ivaria/pmeter.h
Generated for Crystal Space by doxygen 1.2.18