<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>Crystal Space 1.2.1: iProgressMeter Struct Reference (Crystal Space 1.2.1 Public API Reference)</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<table border="0" cellpadding="0" cellspacing="0" width="100%" class="head">
<tr height="59">
<td class="head" width="202" valign="bottom" style="padding-left:0;"><a href="http://www.crystalspace3d.org/"><img src="csblur.png" width="236" height="59" alt="CrystalSpace" border="0"></a></td>
<td class="head"><h2>Public API Reference</h2></td>
</tr>
<tr height="11">
<td colspan="2" class="headshadow" valign="top" style="padding-left:0;"><img src="csblurb.png" width="236" height="11" alt="" border="0"></td>
</tr>
</table>
<div class="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="classes.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="classes.html"><span>Alphabetical List</span></a></li>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<h1>iProgressMeter Struct Reference</h1><!-- doxytag: class="iProgressMeter" --><!-- doxytag: inherits="iBase" -->This is a general interface for a progress meter.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="pmeter_8h-source.html">ivaria/pmeter.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for iProgressMeter:</div>
<div class="dynsection">
<p><center><img src="structiProgressMeter__inherit__graph.png" border="0" usemap="#iProgressMeter__inherit__map" alt="Inheritance graph"></center>
<map name="iProgressMeter__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csTextProgressMeter, iProgressMeter \>" alt="" coords="5,161,427,188"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="188,7,244,33"><area shape="rect" href="classcsTextProgressMeter.html" title="The csTextProgressMeter class displays a simple percentage-style textual progress..." alt="" coords="139,239,293,265"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="structiProgressMeter-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#4a409e88518bf95928f38dd7baba4f52">Abort</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Abort the meter. <a href="#4a409e88518bf95928f38dd7baba4f52"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#cac4e8a8ebf998fb46652df0def4a90b">Finalize</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Finalize the meter (i.e. we completed the task sooner than expected). <a href="#cac4e8a8ebf998fb46652df0def4a90b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#089cee3524d2f9ab320b76ce426bf976">GetCurrent</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the current value of the meter (<= total). <a href="#089cee3524d2f9ab320b76ce426bf976"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#1da874825163dd1a86170373779a790c">GetGranularity</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the refresh granularity. <a href="#1da874825163dd1a86170373779a790c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual int </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#2e43d0128cc1eb26f8fd7f97ee6eac4d">GetTotal</a> () const =0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the total element count represented by the meter. <a href="#2e43d0128cc1eb26f8fd7f97ee6eac4d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#16f05bdb0fd27e7cc3626fb9467d30a3">Reset</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the meter to 0%. <a href="#16f05bdb0fd27e7cc3626fb9467d30a3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#ff70c47a5a2a108891d1459e28f9ac2d">Restart</a> ()=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset the meter and print the initial tick mark ("0%"). <a href="#ff70c47a5a2a108891d1459e28f9ac2d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#31f78341fd497aaa707af35e29c7414e">SetGranularity</a> (int)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the refresh granularity. <a href="#31f78341fd497aaa707af35e29c7414e"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#046c945d4edcd0a86ccb333cdcfbddc3">SetProgressDescription</a> (const char *id, const char *description,...)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the id and description of what we are currently monitoring. <a href="#046c945d4edcd0a86ccb333cdcfbddc3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#a096f1f49c79723ee5d08944f1914adf">SetProgressDescriptionV</a> (const char *id, const char *description, va_list)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the id and description of what we are currently monitoring. <a href="#a096f1f49c79723ee5d08944f1914adf"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#833a633b836c194ee6d62ffa0da2ecf3">SetTotal</a> (int n)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Set the total element count represented by the meter and perform a reset. <a href="#833a633b836c194ee6d62ffa0da2ecf3"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="structiProgressMeter.html#a8fac9876d95230426a00342e5558b25">Step</a> (unsigned int n=1)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Increment the meter by n units, default 1. <a href="#a8fac9876d95230426a00342e5558b25"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a general interface for a progress meter.
<p>
The engine needs an implementation of this to be able to report progress on calculating lighting and other stuff.
<p>Definition at line <a class="el" href="pmeter_8h-source.html#l00033">33</a> of file <a class="el" href="pmeter_8h-source.html">pmeter.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="4a409e88518bf95928f38dd7baba4f52"></a><!-- doxytag: member="iProgressMeter::Abort" ref="4a409e88518bf95928f38dd7baba4f52" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::Abort </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Abort the meter.
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#8ff224ce6dbc6d8eda0b9c70d74d6344">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="cac4e8a8ebf998fb46652df0def4a90b"></a><!-- doxytag: member="iProgressMeter::Finalize" ref="cac4e8a8ebf998fb46652df0def4a90b" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::Finalize </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Finalize the meter (i.e. we completed the task sooner than expected).
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#3021d7174a4a1ecabeb65240ad7f2e69">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="089cee3524d2f9ab320b76ce426bf976"></a><!-- doxytag: member="iProgressMeter::GetCurrent" ref="089cee3524d2f9ab320b76ce426bf976" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iProgressMeter::GetCurrent </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the current value of the meter (<= total).
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#b12e87cdf06353d9345dfdd2e930ee1a">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="1da874825163dd1a86170373779a790c"></a><!-- doxytag: member="iProgressMeter::GetGranularity" ref="1da874825163dd1a86170373779a790c" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iProgressMeter::GetGranularity </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the refresh granularity.
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#f829ab989da14f941b3c2fb8be173961">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="2e43d0128cc1eb26f8fd7f97ee6eac4d"></a><!-- doxytag: member="iProgressMeter::GetTotal" ref="2e43d0128cc1eb26f8fd7f97ee6eac4d" args="() const =0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int iProgressMeter::GetTotal </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Get the total element count represented by the meter.
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#4d8c1c25ac3c0167d5df07125f029809">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="16f05bdb0fd27e7cc3626fb9467d30a3"></a><!-- doxytag: member="iProgressMeter::Reset" ref="16f05bdb0fd27e7cc3626fb9467d30a3" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::Reset </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the meter to 0%.
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#67247d0f38529e975342b8413a390128">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="ff70c47a5a2a108891d1459e28f9ac2d"></a><!-- doxytag: member="iProgressMeter::Restart" ref="ff70c47a5a2a108891d1459e28f9ac2d" args="()=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::Restart </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Reset the meter and print the initial tick mark ("0%").
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#0fc9fff3f43991b9b63787eeb62c026e">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="31f78341fd497aaa707af35e29c7414e"></a><!-- doxytag: member="iProgressMeter::SetGranularity" ref="31f78341fd497aaa707af35e29c7414e" args="(int)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::SetGranularity </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the refresh granularity.
<p>
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%.
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#bc504ddfd051fd03156062241172f747">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="046c945d4edcd0a86ccb333cdcfbddc3"></a><!-- doxytag: member="iProgressMeter::SetProgressDescription" ref="046c945d4edcd0a86ccb333cdcfbddc3" args="(const char *id, const char *description,...)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::SetProgressDescription </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"> </td>
<td class="paramname"> <em>...</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the id and description of what we are currently monitoring.
<p>
An id can be something like "crystalspace.engine.lighting.calculation". <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#e3f59ea198e81ebc2336da45a41380cf">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="a096f1f49c79723ee5d08944f1914adf"></a><!-- doxytag: member="iProgressMeter::SetProgressDescriptionV" ref="a096f1f49c79723ee5d08944f1914adf" args="(const char *id, const char *description, va_list)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::SetProgressDescriptionV </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>id</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>description</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">va_list </td>
<td class="paramname"></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the id and description of what we are currently monitoring.
<p>
An id can be something like "crystalspace.engine.lighting.calculation". <dl class="see" compact><dt><b>See also:</b></dt><dd><a class="el" href="group__util.html">Notes about string formatting in Crystal Space</a> </dd></dl>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#9b991bcf42de8168818e2fb59fe0da2a">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="833a633b836c194ee6d62ffa0da2ecf3"></a><!-- doxytag: member="iProgressMeter::SetTotal" ref="833a633b836c194ee6d62ffa0da2ecf3" args="(int n)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::SetTotal </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>n</em> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Set the total element count represented by the meter and perform a reset.
<p>
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#beec6383a8cbcc88ea566ae2ea682041">csTextProgressMeter</a>.</p>
</div>
</div><p>
<a class="anchor" name="a8fac9876d95230426a00342e5558b25"></a><!-- doxytag: member="iProgressMeter::Step" ref="a8fac9876d95230426a00342e5558b25" args="(unsigned int n=1)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void iProgressMeter::Step </td>
<td>(</td>
<td class="paramtype">unsigned int </td>
<td class="paramname"> <em>n</em> = <code>1</code> </td>
<td> ) </td>
<td width="100%"><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Increment the meter by n units, default 1.
<p>
If the meter reaches 100% it should automatically stop itself.
<p>Implemented in <a class="el" href="classcsTextProgressMeter.html#e0032e0814b26ed9a22c228117b27003">csTextProgressMeter</a>.</p>
</div>
</div><p>
<hr>The documentation for this struct was generated from the following file:<ul>
<li>ivaria/<a class="el" href="pmeter_8h-source.html">pmeter.h</a></ul>
<hr size="1"><address><small>Generated for Crystal Space 1.2.1 by
<a href="http://www.doxygen.org/index.html">doxygen</a> 1.5.3
</small></address> </div></body> </html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
bad97183153701b09df5fae1052b1c30
>
files
>
3484
