1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
4 <title>IEPairsClassDocumentationExample Doxygen Documentation</title>
5 <link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
6 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
12 <table cellpadding="0" cellspacing="0" border="0" width="94%">
15 <img src="../images/top-title.gif" alt="" width="254" height="92">
17 <td background="../images/top-tile.gif" valign="top" align="right" width="100%">
18 <br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
21 <img src="../images/top-right.gif" alt="" width="12" height="92">
26 <table cellpadding="0" cellspacing="0" border="0" width="95%">
28 <td valign="top" align="left">
29 <img src="../images/body-upper-left.gif" alt="" width="19" height="12">
31 <td valign="top" background="../images/body-upper-tile.gif">
32 <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
34 <td valign="top" align="right">
35 <img src="../images/body-upper-right.gif" alt="" width="19" height="12">
39 <td background="../images/body-left-tile.gif" height="100%"> </td>
40 <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
44 <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
46 <!-- ----------------- End Header ----------------- -->
49 <!-- Generated by Doxygen 1.2.8.1 -->
51 <a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
52 <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>
53 00002 <font class="comment"></font><font class="comment">/*!</font>
54 00003 <font class="comment"> \todo Write more complete documentation for this class so that it's use</font>
55 00004 <font class="comment"> is clear</font>
56 00005 <font class="comment"> </font>
57 00006 <font class="comment"> An interface to entity keys and key pairs that allows plugins to;</font>
58 00007 <font class="comment"> read and write entity keys and key values, get a key value as a</font>
59 00008 <font class="comment"> vec3_t</font>
60 00009 <font class="comment">*/</font>
61 <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>
63 00012 <font class="keyword">public</font>:<font class="comment"></font>
64 00013 <font class="comment"> //! Increment the number of references to this object</font>
65 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;
66 00015 <font class="comment"></font>
67 00016 <font class="comment"> //! Decrement the reference count</font>
68 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;
69 00018 <font class="comment"></font>
70 00019 <font class="comment"> //! Get a vector from a key</font>
71 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;
72 00021 <font class="comment"></font>
73 00022 <font class="comment"> //! Get a float from a key</font>
74 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;
75 00024 <font class="comment"></font>
76 00025 <font class="comment"> //! Get a string (char *) from a key</font>
77 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;
78 00027 <font class="comment"></font>
79 00028 <font class="comment"> //! Set a key value to char *value</font>
80 00029 <font class="comment"></font><font class="comment"> /*!</font>
81 00030 <font class="comment"> \param key The (char *) containing the keyname</font>
82 00031 <font class="comment"> \param value The (char *) to set the key value to</font>
83 00032 <font class="comment"> */</font>
84 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;
85 00034 <font class="comment"></font>
86 00035 <font class="comment"> //! Get a vec3_t for the entities origin</font>
87 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;
88 00037 <font class="comment"></font>
89 00038 <font class="comment"> //! Compute the rotated bounds of the BBox based on "angle" and "angles" keys</font>
90 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;
93 <!-- ---------------- Start Footer ----------------- -->
99 <table width="95%" cellpadding="1" cellspacing="0">
102 <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
105 <a href="mailto:ttimo@idsoftware.com">
106 <i>ttimo@idsoftware.com</i>
116 <td background="../images/body-right-tile.gif" height="100%"> </td>
119 <td valign="top" align="left">
120 <img src="../images/body-lower-left.gif" alt="" width="19" height="12">
122 <td valign="top" background="../images/body-lower-tile.gif">
123 <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
125 <td valign="top" align="right">
126 <img src="../images/body-lower-right.gif" alt="" width="19" height="12">