<!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: ivaria/bugplug.h Source File (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><a href="classes.html"><span>Classes</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> </ul> </div> <h1>ivaria/bugplug.h</h1><a href="bugplug_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> <a name="l00002"></a>00002 <span class="comment"> Copyright (C) 2002 by Jorrit Tyberghein</span> <a name="l00003"></a>00003 <span class="comment"></span> <a name="l00004"></a>00004 <span class="comment"> This library is free software; you can redistribute it and/or</span> <a name="l00005"></a>00005 <span class="comment"> modify it under the terms of the GNU Library General Public</span> <a name="l00006"></a>00006 <span class="comment"> License as published by the Free Software Foundation; either</span> <a name="l00007"></a>00007 <span class="comment"> version 2 of the License, or (at your option) any later version.</span> <a name="l00008"></a>00008 <span class="comment"></span> <a name="l00009"></a>00009 <span class="comment"> This library is distributed in the hope that it will be useful,</span> <a name="l00010"></a>00010 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span> <a name="l00011"></a>00011 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU</span> <a name="l00012"></a>00012 <span class="comment"> Library General Public License for more details.</span> <a name="l00013"></a>00013 <span class="comment"></span> <a name="l00014"></a>00014 <span class="comment"> You should have received a copy of the GNU Library General Public</span> <a name="l00015"></a>00015 <span class="comment"> License along with this library; if not, write to the Free</span> <a name="l00016"></a>00016 <span class="comment"> Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.</span> <a name="l00017"></a>00017 <span class="comment">*/</span> <a name="l00018"></a>00018 <a name="l00019"></a>00019 <span class="preprocessor">#ifndef __CS_IVARIA_BUGPLUG_H__</span> <a name="l00020"></a>00020 <span class="preprocessor"></span><span class="preprocessor">#define __CS_IVARIA_BUGPLUG_H__</span> <a name="l00021"></a>00021 <span class="preprocessor"></span> <a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="scf_8h.html" title="Crystal Space Shared Class Facility (SCF).">csutil/scf.h</a>"</span> <a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="graph3d_8h.html" title="3D graphics interface">ivideo/graph3d.h</a>"</span> <a name="l00028"></a>00028 <a name="l00029"></a>00029 <span class="keyword">struct </span><a class="code" href="structiBugPlug.html" title="Using this interface you can communicate with the BugPlug plugin.">iBugPlug</a>; <a name="l00030"></a>00030 <span class="keyword">struct </span><a class="code" href="structiMeshObject.html" title="This is a general mesh object that the engine can interact with.">iMeshObject</a>; <a name="l00031"></a>00031 <a name="l00032"></a>00032 <span class="keyword">class </span><a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>; <a name="l00033"></a>00033 <span class="keyword">class </span><a class="code" href="classcsReversibleTransform.html" title="A class which defines a reversible transformation from one coordinate system to another...">csReversibleTransform</a>; <a name="l00034"></a>00034 <span class="keyword">class </span><a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>; <a name="l00035"></a>00035 <span class="keyword">class </span><a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>; <a name="l00036"></a>00036 <a name="l00042"></a><a class="code" href="structiBugPlugRenderObject.html">00042</a> <span class="keyword">struct </span><a class="code" href="structiBugPlugRenderObject.html" title="An application/module can implement this interface to render something.">iBugPlugRenderObject</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> <a name="l00043"></a>00043 { <a name="l00044"></a>00044 SCF_INTERFACE(<a class="code" href="structiBugPlugRenderObject.html" title="An application/module can implement this interface to render something.">iBugPlugRenderObject</a>, 2,0,0); <a name="l00046"></a>00046 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlugRenderObject.html#cd2f04fabad4d939c884b6f0e72cec82" title="Render.">Render</a> (<a class="code" href="structiGraphics3D.html" title="This is the standard 3D graphics interface.">iGraphics3D</a>* g3d, <a class="code" href="structiBugPlug.html" title="Using this interface you can communicate with the BugPlug plugin.">iBugPlug</a>* bugplug) = 0; <a name="l00047"></a>00047 }; <a name="l00048"></a>00048 <a name="l00049"></a>00049 <a name="l00054"></a><a class="code" href="structiBugPlug.html">00054</a> <span class="keyword">struct </span><a class="code" href="structiBugPlug.html" title="Using this interface you can communicate with the BugPlug plugin.">iBugPlug</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> <a class="code" href="structiBase.html" title="This is the basic interface: all other interfaces should be derived from this one...">iBase</a> <a name="l00055"></a>00055 { <a name="l00056"></a>00056 SCF_INTERFACE(<a class="code" href="structiBugPlug.html" title="Using this interface you can communicate with the BugPlug plugin.">iBugPlug</a>,2,0,1); <a name="l00057"></a>00057 <span class="comment">//=========================================================================</span> <a name="l00058"></a>00058 <a name="l00066"></a>00066 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#ef02888308e5fc1fbc68ab75758cd622" title="Setup the &#39;debug sector&#39;.">SetupDebugSector</a> () = 0; <a name="l00067"></a>00067 <a name="l00074"></a>00074 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#4c707f5c6899abf7a828e62698e5ca0d" title="Add a colored filled box to the debug sector.">DebugSectorBox</a> (<span class="keyword">const</span> <a class="code" href="classcsBox3.html" title="A bounding box in 3D space.">csBox3</a>& box, <span class="keywordtype">float</span> r, <span class="keywordtype">float</span> g, <span class="keywordtype">float</span> b, <a name="l00075"></a>00075 <span class="keyword">const</span> <span class="keywordtype">char</span>* name = 0, <a class="code" href="structiMeshObject.html" title="This is a general mesh object that the engine can interact with.">iMeshObject</a>* mesh = 0, <a name="l00076"></a>00076 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> mixmode = <a class="code" href="group__gfx3d.html#g157a5b79fc02bff999d17b291dac354d" title="This mixmode uses alpha smooth blending, binary blending (ie enabled alpha test)...">CS_FX_COPY</a>) = 0; <a name="l00077"></a>00077 <a name="l00082"></a>00082 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#abb7141782f7aed16c273a42e20acd04" title="Add a transparent filled triangle to the debug sector.">DebugSectorTriangle</a> (<span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>& s1, <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>& s2, <a name="l00083"></a>00083 <span class="keyword">const</span> <a class="code" href="classcsVector3.html" title="A 3D vector.">csVector3</a>& s3, <span class="keywordtype">float</span> r, <span class="keywordtype">float</span> g, <span class="keywordtype">float</span> b, <a name="l00084"></a>00084 <a class="code" href="group__util.html#g91ad9478d81a7aaf2593e8d9c3d06a14" title="Shortcut for default unsigned int.">uint</a> mixmode = <a class="code" href="group__gfx3d.html#g59466bfe3d5df98a96bd96c81c90a854" title="Additive blending. Formula: =SRC+DST.">CS_FX_ADD</a>) = 0; <a name="l00085"></a>00085 <a name="l00093"></a>00093 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#3eeec279e472685aef12a171ca97c3bb" title="Switch BugPlug view to the debug sector.">SwitchDebugSector</a> (<span class="keyword">const</span> <a class="code" href="classcsReversibleTransform.html" title="A class which defines a reversible transformation from one coordinate system to another...">csReversibleTransform</a>& trans, <a name="l00094"></a>00094 <span class="keywordtype">bool</span> clear = <span class="keyword">true</span>) = 0; <a name="l00095"></a>00095 <a name="l00099"></a>00099 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiBugPlug.html#efd50d89999bd5fec27e4b20f777d051" title="Returns true if the debug sector is currently visible.">CheckDebugSector</a> () <span class="keyword">const</span> = 0; <a name="l00100"></a>00100 <a name="l00101"></a>00101 <span class="comment">//=========================================================================</span> <a name="l00102"></a>00102 <a name="l00108"></a>00108 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#31aea03296bbef0064ff65af65157992" title="Setup the &#39;debug 2dview&#39;.">SetupDebugView</a> () = 0; <a name="l00109"></a>00109 <a name="l00113"></a>00113 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiBugPlug.html#35a390ec2fefba76dec0bb75d600a543" title="Add a dragable point.">DebugViewPoint</a> (<span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>& point) = 0; <a name="l00114"></a>00114 <a name="l00118"></a>00118 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#a0165606f308b00b2db1cd33ba088afc" title="Add a line.">DebugViewLine</a> (<span class="keywordtype">int</span> i1, <span class="keywordtype">int</span> i2) = 0; <a name="l00119"></a>00119 <a name="l00123"></a>00123 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#1cdbe4170e7c5eac0f6b2c04e43869fd" title="Add a box.">DebugViewBox</a> (<span class="keywordtype">int</span> i1, <span class="keywordtype">int</span> i2) = 0; <a name="l00124"></a>00124 <a name="l00128"></a>00128 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiBugPlug.html#3c9f71ca9194af6b01344d182f1ffb63" title="Return the current number of points.">DebugViewPointCount</a> () <span class="keyword">const</span> = 0; <a name="l00129"></a>00129 <a name="l00133"></a>00133 <span class="keyword">virtual</span> <span class="keyword">const</span> <a class="code" href="classcsVector2.html" title="A 2D vector.">csVector2</a>& <a class="code" href="structiBugPlug.html#0503176b358dd009edfd207b692b42b6" title="Return a point.">DebugViewGetPoint</a> (<span class="keywordtype">int</span> i) <span class="keyword">const</span> = 0; <a name="l00134"></a>00134 <a name="l00138"></a>00138 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiBugPlug.html#ab446c0f4e40300ca9c9ed288520d194" title="Return the current number of lines.">DebugViewLineCount</a> () <span class="keyword">const</span> = 0; <a name="l00139"></a>00139 <a name="l00143"></a>00143 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#a79bcafc797e427c7c46f4eb1c066921" title="Return a line.">DebugViewGetLine</a> (<span class="keywordtype">int</span> i, <span class="keywordtype">int</span>& i1, <span class="keywordtype">int</span>& i2) <span class="keyword">const</span> = 0; <a name="l00144"></a>00144 <a name="l00148"></a>00148 <span class="keyword">virtual</span> <span class="keywordtype">int</span> <a class="code" href="structiBugPlug.html#ddfc07138d6fd927d04af76188b0637c" title="Return the current number of boxes.">DebugViewBoxCount</a> () <span class="keyword">const</span> = 0; <a name="l00149"></a>00149 <a name="l00153"></a>00153 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#96d0e4caeeb2378c096b792a24479922" title="Return a box.">DebugViewGetBox</a> (<span class="keywordtype">int</span> i, <span class="keywordtype">int</span>& i1, <span class="keywordtype">int</span>& i2) <span class="keyword">const</span> = 0; <a name="l00154"></a>00154 <a name="l00159"></a>00159 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#cd7d28e01683b1f075e14afbb692f98d" title="Add some rendering code that will be rendered right before the points and lines are...">DebugViewRenderObject</a> (<a class="code" href="structiBugPlugRenderObject.html" title="An application/module can implement this interface to render something.">iBugPlugRenderObject</a>* obj) = 0; <a name="l00160"></a>00160 <a name="l00165"></a>00165 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#2b6e84dd265bf4283e3e9e369e270c45" title="Indicate if BugPlug should clear the screen before rendering the debug view.">DebugViewClearScreen</a> (<span class="keywordtype">bool</span> cs) = 0; <a name="l00166"></a>00166 <a name="l00171"></a>00171 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#3b0eb5c0ee382ddedf01afb08b50d3a3" title="Switch BugPlug view to the debug view.">SwitchDebugView</a> (<span class="keywordtype">bool</span> clear = <span class="keyword">true</span>) = 0; <a name="l00172"></a>00172 <a name="l00176"></a>00176 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiBugPlug.html#8c49fcf0c6f7c637b4d50baed577bb66" title="Returns true if the debug view is currently visible.">CheckDebugView</a> () <span class="keyword">const</span> = 0; <a name="l00177"></a>00177 <a name="l00178"></a>00178 <span class="comment">//=========================================================================</span> <a name="l00179"></a>00179 <a name="l00187"></a>00187 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#95cb264d6c55c1016680bc9e4ca5c16d" title="Add an amount to a counter.">AddCounter</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* countername, <span class="keywordtype">int</span> amount = 1) = 0; <a name="l00188"></a>00188 <a name="l00197"></a>00197 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#b09a431df9fe665d490059ff1327489e" title="Add an amount to a enum-counter.">AddCounterEnum</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* countername, <span class="keywordtype">int</span> enumval, <a name="l00198"></a>00198 <span class="keywordtype">int</span> amount = 1) = 0; <a name="l00199"></a>00199 <a name="l00205"></a>00205 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#6e62b43d1ed0850d2c70b4dd9466b84f" title="Reset some counter manually.">ResetCounter</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* countername, <span class="keywordtype">int</span> value = 0) = 0; <a name="l00206"></a>00206 <a name="l00211"></a>00211 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="structiBugPlug.html#6d00df11848ee65a63e70f76ca1912c4" title="Remove a counter.">RemoveCounter</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* countername) = 0; <a name="l00212"></a>00212 <a name="l00213"></a>00213 <span class="comment">//=========================================================================</span> <a name="l00214"></a>00214 <a name="l00221"></a>00221 <span class="keyword">virtual</span> <span class="keywordtype">bool</span> <a class="code" href="structiBugPlug.html#3752acf5c027ee281f4e6a657409cfc5" title="Execute a bugplug command.">ExecCommand</a> (<span class="keyword">const</span> <span class="keywordtype">char</span>* command) = 0; <a name="l00222"></a>00222 }; <a name="l00223"></a>00223 <a name="l00224"></a>00224 <span class="preprocessor">#endif // __CS_IVARIA_BUGPLUG_H__</span> <a name="l00225"></a>00225 <span class="preprocessor"></span> </pre></div><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>