aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a03873.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a03873.html341
1 files changed, 341 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a03873.html b/docs/doxygen/nel/a03873.html
new file mode 100644
index 00000000..db34f200
--- /dev/null
+++ b/docs/doxygen/nel/a03873.html
@@ -0,0 +1,341 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NLMISC::IProgressCallback class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NLMISC::IProgressCallback Class Reference</h1><code>#include &lt;<a class="el" href="a06210.html">progress_callback.h</a>&gt;</code>
+<p>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+Progress callback interface <dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2002 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06210.html#l00041">41</a> of file <a class="el" href="a06210.html">progress_callback.h</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>float&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka0">getCropedValue</a> (float <a class="el" href="a04223.html#a658">value</a>) const </td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka1">IProgressCallback</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka2">popCropedValues</a> ()</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka3">progress</a> (float progressValue)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka4">pushCropedValues</a> (float min, float max)</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacka5">~IProgressCallback</a> ()</td></tr>
+
+<tr><td colspan=2><br><h2>Data Fields</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::string&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacko0">DisplayString</a></td></tr>
+
+<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Display string. <a href="#NLMISC_1_1IProgressCallbacko0"></a><br><br></td></tr>
+<tr><td colspan=2><br><h2>Private Attributes</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>std::vector&lt; <a class="el" href="a03874.html">CCropedValues</a> &gt;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a></td></tr>
+
+</table>
+<hr><h2>Constructor &amp; Destructor Documentation</h2>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka1" doxytag="NLMISC::IProgressCallback::IProgressCallback" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> NLMISC::IProgressCallback::IProgressCallback </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06209.html#l00040">40</a> of file <a class="el" href="a06209.html">progress_callback.cpp</a>.
+<p>
+References <a class="el" href="a06210.html#l00089">_CropedValues</a>.
+<p>
+<div class="fragment"><pre>00041 {
+00042 <a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.push_back (CCropedValues (0, 1));
+00043 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka5" doxytag="NLMISC::IProgressCallback::~IProgressCallback" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual NLMISC::IProgressCallback::~<a class="el" href="a03873.html">IProgressCallback</a> </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [inline, virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06210.html#l00046">46</a> of file <a class="el" href="a06210.html">progress_callback.h</a>.
+<p>
+<div class="fragment"><pre>00046 {}
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka0" doxytag="NLMISC::IProgressCallback::getCropedValue" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> float NLMISC::IProgressCallback::getCropedValue </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>value</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const</td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Get croped value
+<p>
+Definition at line <a class="el" href="a06209.html#l00033">33</a> of file <a class="el" href="a06209.html">progress_callback.cpp</a>.
+<p>
+References <a class="el" href="a06210.html#l00089">_CropedValues</a>, <a class="el" href="a06210.html#l00086">NLMISC::IProgressCallback::CCropedValues::Max</a>, <a class="el" href="a06210.html#l00085">NLMISC::IProgressCallback::CCropedValues::Min</a>, <a class="el" href="a05622.html#l00290">nlassert</a>, and <a class="el" href="a05646.html#l01132">value</a>.
+<p>
+Referenced by <a class="el" href="a06209.html#l00045">pushCropedValues()</a>.
+<p>
+<div class="fragment"><pre>00034 {
+00035 <a class="code" href="a04199.html#a6">nlassert</a> (<a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.size ()&gt;0);
+00036 <span class="keyword">const</span> CCropedValues &amp;values = <a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.back ();
+00037 <span class="keywordflow">return</span> <a class="code" href="a04223.html#a658">value</a>*(values.Max-values.Min)+values.Min;
+00038 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka2" doxytag="NLMISC::IProgressCallback::popCropedValues" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLMISC::IProgressCallback::popCropedValues </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Push crop values
+<p>
+Definition at line <a class="el" href="a06209.html#l00052">52</a> of file <a class="el" href="a06209.html">progress_callback.cpp</a>.
+<p>
+References <a class="el" href="a06210.html#l00089">_CropedValues</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>.
+<p>
+<div class="fragment"><pre>00053 {
+00054 <a class="code" href="a04199.html#a6">nlassert</a> (<a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.size ()&gt;1);
+00055 <a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.pop_back ();
+00056 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka3" doxytag="NLMISC::IProgressCallback::progress" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLMISC::IProgressCallback::progress </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>progressValue</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Call back<p>
+progressValue should be 0 ~ 1
+<p>
+Definition at line <a class="el" href="a06209.html#l00058">58</a> of file <a class="el" href="a06209.html">progress_callback.cpp</a>.
+<p>
+Referenced by <a class="el" href="a05874.html#l00091">NL3D::CLandscapeUser::flushTiles()</a>, <a class="el" href="a05465.html#l00358">NLSOUND::CAudioMixerUser::init()</a>, <a class="el" href="a06378.html#l00771">NL3D::CShapeBank::preLoadShapes()</a>, and <a class="el" href="a05874.html#l00193">NL3D::CLandscapeUser::refreshAllZonesAround()</a>.
+<p>
+<div class="fragment"><pre>00059 {
+00060 }
+</pre></div> </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacka4" doxytag="NLMISC::IProgressCallback::pushCropedValues" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> void NLMISC::IProgressCallback::pushCropedValues </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname" nowrap> <em>min</em>, </td>
+ </tr>
+ <tr>
+ <td class="md" nowrap align="right"></td>
+ <td></td>
+ <td class="md" nowrap>float&nbsp;</td>
+ <td class="mdname" nowrap> <em>max</em></td>
+ </tr>
+ <tr>
+ <td></td>
+ <td class="md">)&nbsp;</td>
+ <td class="md" colspan="2"></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Push crop values
+<p>
+Definition at line <a class="el" href="a06209.html#l00045">45</a> of file <a class="el" href="a06209.html">progress_callback.cpp</a>.
+<p>
+References <a class="el" href="a06210.html#l00089">_CropedValues</a>, <a class="el" href="a06209.html#l00033">getCropedValue()</a>, <a class="el" href="a05484.html#l00038">min</a>, and <a class="el" href="a05622.html#l00290">nlassert</a>.
+<p>
+<div class="fragment"><pre>00046 {
+00047 <a class="code" href="a04199.html#a6">nlassert</a> (<a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.size ()&gt;0);
+00048 <span class="comment">//const CCropedValues &amp;values = _CropedValues.back ();</span>
+00049 <a class="code" href="a03873.html#NLMISC_1_1IProgressCallbackr0">_CropedValues</a>.push_back (CCropedValues (getCropedValue (min), getCropedValue (max)));
+00050 }
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Field Documentation</h2>
+<a class="anchor" name="NLMISC_1_1IProgressCallbackr0" doxytag="NLMISC::IProgressCallback::_CropedValues" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::vector&lt;<a class="el" href="a03874.html">CCropedValues</a>&gt; <a class="el" href="a03873.html#NLMISC_1_1IProgressCallbackr0">NLMISC::IProgressCallback::_CropedValues</a><code> [private]</code>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06210.html#l00089">89</a> of file <a class="el" href="a06210.html">progress_callback.h</a>.
+<p>
+Referenced by <a class="el" href="a06209.html#l00033">getCropedValue()</a>, <a class="el" href="a06209.html#l00040">IProgressCallback()</a>, <a class="el" href="a06209.html#l00052">popCropedValues()</a>, and <a class="el" href="a06209.html#l00045">pushCropedValues()</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NLMISC_1_1IProgressCallbacko0" doxytag="NLMISC::IProgressCallback::DisplayString" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> std::string <a class="el" href="a03873.html#NLMISC_1_1IProgressCallbacko0">NLMISC::IProgressCallback::DisplayString</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Display string.
+<p>
+
+<p>
+Definition at line <a class="el" href="a06210.html#l00073">73</a> of file <a class="el" href="a06210.html">progress_callback.h</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following files:<ul>
+<li><a class="el" href="a06210.html">progress_callback.h</a><li><a class="el" href="a06209.html">progress_callback.cpp</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 13:46:59 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>