<!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: csGeomDebugHelper Class 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>csGeomDebugHelper Class Reference<br>
<small>
[<a class="el" href="group__geom__utils.html">Geometry utilities</a>]</small>
</h1><!-- doxytag: class="csGeomDebugHelper" --><!-- doxytag: inherits="scfImplementation1< csGeomDebugHelper, iDebugHelper >" -->This is a class that does unit testing (and other debug stuff) for most of csgeom classes.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="math3d_8h-source.html">csgeom/math3d.h</a>></code>
<p>
<div class="dynheader">
Inheritance diagram for csGeomDebugHelper:</div>
<div class="dynsection">
<p><center><img src="classcsGeomDebugHelper__inherit__graph.png" border="0" usemap="#csGeomDebugHelper__inherit__map" alt="Inheritance graph"></center>
<map name="csGeomDebugHelper__inherit__map">
<area shape="rect" href="classscfImplementation1.html" title="scfImplementation1\< csGeomDebugHelper, iDebugHelper \>" alt="" coords="69,161,483,188"><area shape="rect" href="classscfImplementation.html" title="scfImplementation\< csGeomDebugHelper \>" alt="" coords="5,84,315,111"><area shape="rect" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one..." alt="" coords="329,7,385,33"><area shape="rect" href="structiDebugHelper.html" title="Some object that wants to implement unit testing, debugging and/or benchmarking can..." alt="" coords="339,84,448,111"><area shape="rect" href="classCS_1_1Memory_1_1CustomAllocated.html" title="Class that overrides operator new/operator delete/etc." alt="" coords="49,7,271,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classcsGeomDebugHelper-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 <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGeomDebugHelper.html#acad9aa80f37ae736179d8ed3497724b">Benchmark</a> (int)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a benchmark. <a href="#acad9aa80f37ae736179d8ed3497724b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGeomDebugHelper.html#8f4e36efccc2a832e0d30f56b6adca7e">DebugCommand</a> (const char *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a debug command as defined by the module itself. <a href="#8f4e36efccc2a832e0d30f56b6adca7e"></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="classcsGeomDebugHelper.html#4a2b0c27c0c3007e179a48995111a7be">Dump</a> (<a class="el" href="structiGraphics3D.html">iGraphics3D</a> *)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do a graphical dump of the current state of this object. <a href="#4a2b0c27c0c3007e179a48995111a7be"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a>< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGeomDebugHelper.html#845d93026c9b21c326bdaa42553b76e1">Dump</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Do a text dump of the current state of this object. <a href="#845d93026c9b21c326bdaa42553b76e1"></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="classcsGeomDebugHelper.html#9dde7df87f36bc24aac6a182a93b166a">GetSupportedTests</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return a bit field indicating what types of functions this specific unit test implementation supports. <a href="#9dde7df87f36bc24aac6a182a93b166a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a>< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGeomDebugHelper.html#b0185b1cf8381603272994299bafa714">StateTest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a state test. <a href="#b0185b1cf8381603272994299bafa714"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual <a class="el" href="classcsPtr.html">csPtr</a>< <a class="el" href="structiString.html">iString</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classcsGeomDebugHelper.html#1359b441a59d28c6b3eda7a1b268c1d7">UnitTest</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Perform a unit test. <a href="#1359b441a59d28c6b3eda7a1b268c1d7"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
This is a class that does unit testing (and other debug stuff) for most of csgeom classes.
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00698">698</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="acad9aa80f37ae736179d8ed3497724b"></a><!-- doxytag: member="csGeomDebugHelper::Benchmark" ref="acad9aa80f37ae736179d8ed3497724b" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__util.html#g28e82998c4c2d1197a1d412bba7da793">csTicks</a> csGeomDebugHelper::Benchmark </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> <em>num_iterations</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform a benchmark.
<p>
This function will return a number indicating how long the benchmark lasted in milliseconds.
<p>Implements <a class="el" href="structiDebugHelper.html#25c2acc4eb241ee157d4ee44a18ec076">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00714">714</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="8f4e36efccc2a832e0d30f56b6adca7e"></a><!-- doxytag: member="csGeomDebugHelper::DebugCommand" ref="8f4e36efccc2a832e0d30f56b6adca7e" args="(const char *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool csGeomDebugHelper::DebugCommand </td>
<td>(</td>
<td class="paramtype">const char * </td>
<td class="paramname"> <em>cmd</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform a debug command as defined by the module itself.
<p>
Returns 'false' if the command was not recognized.
<p>Implements <a class="el" href="structiDebugHelper.html#ef3ec51d8b43aec5a72607f8d1cd05f5">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00725">725</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="4a2b0c27c0c3007e179a48995111a7be"></a><!-- doxytag: member="csGeomDebugHelper::Dump" ref="4a2b0c27c0c3007e179a48995111a7be" args="(iGraphics3D *)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void csGeomDebugHelper::Dump </td>
<td>(</td>
<td class="paramtype"><a class="el" href="structiGraphics3D.html">iGraphics3D</a> * </td>
<td class="paramname"> <em>g3d</em> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do a graphical dump of the current state of this object.
<p>
<p>Implements <a class="el" href="structiDebugHelper.html#092959d6706ec98e4758f1cfd4efc413">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00722">722</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="845d93026c9b21c326bdaa42553b76e1"></a><!-- doxytag: member="csGeomDebugHelper::Dump" ref="845d93026c9b21c326bdaa42553b76e1" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiString.html">iString</a>> csGeomDebugHelper::Dump </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Do a text dump of the current state of this object.
<p>
Returns 0 if not supported or else a string which you should <a class="el" href="classscfImplementation.html#9b996efbd8891c74a46f2c6705b56f89" title="Decrement the reference count.">DecRef()</a> after use.
<p>Implements <a class="el" href="structiDebugHelper.html#8f8586bce8979a6af565408a803090a9">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00718">718</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="9dde7df87f36bc24aac6a182a93b166a"></a><!-- doxytag: member="csGeomDebugHelper::GetSupportedTests" ref="9dde7df87f36bc24aac6a182a93b166a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual int csGeomDebugHelper::GetSupportedTests </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return a bit field indicating what types of functions this specific unit test implementation supports.
<p>
This will return a combination of the CS_DBGHELP_... flags:<ul>
<li><a class="el" href="group__util.html#gca559d327ade26b0b01a4b81971425da" title="supports UnitTest().">CS_DBGHELP_UNITTEST</a></li><li><a class="el" href="group__util.html#gb947e222fa11aa06a0939357a6afa288" title="supports Benchmark().">CS_DBGHELP_BENCHMARK</a></li><li><a class="el" href="group__util.html#g8d1ef1bb1e14f29cfeea992cbcdbc476" title="supports non graphical Dump().">CS_DBGHELP_TXTDUMP</a></li><li><a class="el" href="group__util.html#ga37681913a5cf1a42c4d0fcda4854907" title="supports graphical Dump().">CS_DBGHELP_GFXDUMP</a></li><li><a class="el" href="group__util.html#g1b51643f1313d00e27898aa64c57b9d1" title="supports StateTest().">CS_DBGHELP_STATETEST</a> </li></ul>
<p>Implements <a class="el" href="structiDebugHelper.html#b1be8b6d44cbc36aa342283a879090a2">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00705">705</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
<p>References <a class="el" href="dbghelp_8h-source.html#l00038">CS_DBGHELP_UNITTEST</a>.</p>
</div>
</div><p>
<a class="anchor" name="b0185b1cf8381603272994299bafa714"></a><!-- doxytag: member="csGeomDebugHelper::StateTest" ref="b0185b1cf8381603272994299bafa714" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiString.html">iString</a>> csGeomDebugHelper::StateTest </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline, virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform a state test.
<p>
This function will test if the current state of the object is ok. It will return 0 if it is ok. Otherwise an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> is returned containing some information about the errors. <a class="el" href="classscfImplementation.html#9b996efbd8891c74a46f2c6705b56f89" title="Decrement the reference count.">DecRef()</a> this returned string after using it.
<p>Implements <a class="el" href="structiDebugHelper.html#39f26006470eca6787836a607142c7d5">iDebugHelper</a>.</p>
<p>Definition at line <a class="el" href="math3d_8h-source.html#l00710">710</a> of file <a class="el" href="math3d_8h-source.html">math3d.h</a>.</p>
</div>
</div><p>
<a class="anchor" name="1359b441a59d28c6b3eda7a1b268c1d7"></a><!-- doxytag: member="csGeomDebugHelper::UnitTest" ref="1359b441a59d28c6b3eda7a1b268c1d7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="classcsPtr.html">csPtr</a><<a class="el" href="structiString.html">iString</a>> csGeomDebugHelper::UnitTest </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Perform a unit test.
<p>
This function will try to test as much as possible of the given module. This function returns 0 if the test succeeded. Otherwise an <a class="el" href="structiString.html" title="This is a SCF-compatible interface for csString.">iString</a> is returned containing some information about the errors. <a class="el" href="classscfImplementation.html#9b996efbd8891c74a46f2c6705b56f89" title="Decrement the reference count.">DecRef()</a> this returned string after using it.
<p>Implements <a class="el" href="structiDebugHelper.html#aac65ad9e321a6edba9843f8bfd51702">iDebugHelper</a>.</p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>csgeom/<a class="el" href="math3d_8h-source.html">math3d.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
>
578
