gtkradiant/Doxygen_files/example/test_8c-source.html

141 lines
7.2 KiB
HTML
Raw Normal View History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
</head>
<body bgcolor="black">
<div align="center">
<table cellpadding="0" cellspacing="0" border="0" width="94%">
<tr>
<td>
<img src="../images/top-title.gif" alt="" width="254" height="92">
</td>
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
</td>
<td align="left">
<img src="../images/top-right.gif" alt="" width="12" height="92">
</td>
</tr>
</table>
<table cellpadding="0" cellspacing="0" border="0" width="95%">
<tr>
<td valign="top" align="left">
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
</td>
<td valign="top" background="../images/body-upper-tile.gif">
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
</td>
<td valign="top" align="right">
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
</td>
</tr>
<tr>
<td background="../images/body-left-tile.gif" height="100%">&nbsp;</td>
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
<br><hr>
<center>
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
<!-- ----------------- End Header ----------------- -->
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<a class="qindex" href="index.html">Main Page</a> &nbsp; <a class="qindex" href="classes.html">Alphabetical List</a> &nbsp; <a class="qindex" href="annotated.html">Compound List</a> &nbsp; <a class="qindex" href="files.html">File List</a> &nbsp; <a class="qindex" href="functions.html">Compound Members</a> &nbsp; <a class="qindex" href="pages.html">Related Pages</a> &nbsp; </center>
<hr><h1>iepairs.h</h1><a href="test_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">//! Virtual class to allow plugin operations on entity pairs</font>
00002 <font class="comment"></font><font class="comment">/*!</font>
00003 <font class="comment"> \todo Write more complete documentation for this class so that it's use</font>
00004 <font class="comment"> is clear</font>
00005 <font class="comment"> </font>
00006 <font class="comment"> An interface to entity keys and key pairs that allows plugins to;</font>
00007 <font class="comment"> read and write entity keys and key values, get a key value as a</font>
00008 <font class="comment"> vec3_t</font>
00009 <font class="comment">*/</font>
<a name="l00010"></a><a class="code" href="classIEpair.html">00010</a> <font class="keyword">class </font><a class="code" href="classIEpair.html">IEpair</a>
00011 {
00012 <font class="keyword">public</font>:<font class="comment"></font>
00013 <font class="comment"> //! Increment the number of references to this object</font>
00014 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a0">IncRef</a> () = 0;
00015 <font class="comment"></font>
00016 <font class="comment"> //! Decrement the reference count</font>
00017 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a1">DecRef</a> () = 0;
00018 <font class="comment"></font>
00019 <font class="comment"> //! Get a vector from a key</font>
00020 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a2">GetVectorForKey</a>( <font class="keywordtype">char</font>* key, vec3_t vec ) = 0;
00021 <font class="comment"></font>
00022 <font class="comment"> //! Get a float from a key</font>
00023 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classIEpair.html#a3">FloatForKey</a>( <font class="keywordtype">char</font> *key ) = 0;
00024 <font class="comment"></font>
00025 <font class="comment"> //! Get a string (char *) from a key</font>
00026 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">char</font>* <a class="code" href="classIEpair.html#a4">ValueForKey</a>( <font class="keywordtype">char</font> *key ) = 0;
00027 <font class="comment"></font>
00028 <font class="comment"> //! Set a key value to char *value</font>
00029 <font class="comment"></font><font class="comment"> /*!</font>
00030 <font class="comment"> \param key The (char *) containing the keyname</font>
00031 <font class="comment"> \param value The (char *) to set the key value to</font>
00032 <font class="comment"> */</font>
00033 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a5">SetKeyValue</a>( <font class="keywordtype">char</font> *key, <font class="keywordtype">char</font> *value ) = 0;
00034 <font class="comment"></font>
00035 <font class="comment"> //! Get a vec3_t for the entities origin</font>
00036 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a6">GetEntityOrigin</a>( vec3_t vec ) = 0;
00037 <font class="comment"></font>
00038 <font class="comment"> //! Compute the rotated bounds of the BBox based on "angle" and "angles" keys</font>
00039 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a7">CalculateRotatedBounds</a>( vec3_t mins, vec3_t maxs ) = 0;
00040 };
</pre></div>
<!-- ---------------- Start Footer ----------------- -->
</td></tr></table>
</center>
<br><br>
<div align="center">
<table width="95%" cellpadding="1" cellspacing="0">
<tr>
<td width="50%">
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
</td>
<td align="right">
<a href="mailto:ttimo@idsoftware.com">
<i>ttimo@idsoftware.com</i>
</a>
</td>
</tr>
</table>
</div>
<br>
<br>
</div></td>
<td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>
</tr>
<tr>
<td valign="top" align="left">
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
</td>
<td valign="top" background="../images/body-lower-tile.gif">
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
</td>
<td valign="top" align="right">
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
</td>
</tr>
</table>
</td>
<td valign="top">
</td>
</tr>
</table>
</div>
</body>
</html>