Enter your search terms GNU-Darwin Web Submit search form

iProgressMeter Struct Reference This is a general interface for a progress meter. More... #include <pmeter.h> Inheritance diagram for iProgressMeter: List of all members. Public Methods virtual void  SetProgressDescription (const char *id, const char *description,...)=0   Set the id and description of what we are currently monitoring. More... virtual void  SetProgressDescriptionV (const char *id, const char *description, va_list)=0   Set the id and description of what we are currently monitoring. More... virtual void  Step ()=0   Increment the meter by one unit. More... 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. More... 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. Member Function Documentation void iProgressMeter::SetGranularity ( int ) [pure virtual]   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%. Reimplemented in csTextProgressMeter. void iProgressMeter::SetProgressDescription ( const char * id, const char * description, ... ) [pure virtual]   Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Reimplemented in csTextProgressMeter. void iProgressMeter::SetProgressDescriptionV ( const char * id, const char * description, va_list ) [pure virtual]   Set the id and description of what we are currently monitoring. An id can be something like "crystalspace.engine.lighting.calculation". Reimplemented in csTextProgressMeter. void iProgressMeter::Step ( ) [pure virtual]   Increment the meter by one unit. If the meter reaches 100% it should automatically stop itself. Reimplemented in csTextProgressMeter. The documentation for this struct was generated from the following file: pmeter.h Generated for Crystal Space by doxygen 1.2.5 written by Dimitri van Heesch, ©1997-2000