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>IEpair Class Reference</h1>Virtual class to allow plugin operations on entity pairs.
53 <a href="#_details">More...</a>
55 <a href="classIEpair-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
56 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
57 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a0">IncRef</a> ()=0</td></tr>
58 <tr><td> </td><td><font size=-1><em>Increment the number of references to this object.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
59 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a1">DecRef</a> ()=0</td></tr>
60 <tr><td> </td><td><font size=-1><em>Decrement the reference count.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
61 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a2">GetVectorForKey</a> (char *key, vec3_t vec)=0</td></tr>
62 <tr><td> </td><td><font size=-1><em>Get a vector from a key.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
63 <tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classIEpair.html#a3">FloatForKey</a> (char *key)=0</td></tr>
64 <tr><td> </td><td><font size=-1><em>Get a float from a key.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
65 <tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="classIEpair.html#a4">ValueForKey</a> (char *key)=0</td></tr>
66 <tr><td> </td><td><font size=-1><em>Get a string (char *) from a key.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
67 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a5">SetKeyValue</a> (char *key, char *value)=0</td></tr>
68 <tr><td> </td><td><font size=-1><em>Set a key value to char *value.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
69 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a6">GetEntityOrigin</a> (vec3_t vec)=0</td></tr>
70 <tr><td> </td><td><font size=-1><em>Get a vec3_t for the entities origin.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
71 <tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a7">CalculateRotatedBounds</a> (vec3_t mins, vec3_t maxs)=0</td></tr>
72 <tr><td> </td><td><font size=-1><em>Compute the rotated bounds of the BBox based on "angle" and "angles" keys.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
74 <hr><a name="_details"></a><h2>Detailed Description</h2>
75 Virtual class to allow plugin operations on entity pairs.
80 <b><a class="el" href="todo.html#_todo000001">Todo: </a></b><dd>
81 Write more complete documentation for this class so that it's use is clear</dl>
83 An interface to entity keys and key pairs that allows plugins to; read and write entity keys and key values, get a key value as a vec3_t
87 Definition at line <a class="el" href="test_8c-source.html#l00010">10</a> of file <a class="el" href="test_8c-source.html">iepairs.h</a>.<hr><h2>Member Function Documentation</h2>
88 <a name="a7" doxytag="IEpair::CalculateRotatedBounds"></a><p>
89 <table width="100%" cellpadding="2" cellspacing="0" border="0">
92 <table cellpadding="0" cellspacing="0" border="0">
94 <td nowrap valign="top"><b>
95 void IEpair::CalculateRotatedBounds (
97 <td valign="bottom"><b>
104 vec3_t <em>maxs</em> )<code> [pure virtual]</code>
112 <table cellspacing=5 cellpadding=0 border=0>
120 Compute the rotated bounds of the BBox based on "angle" and "angles" keys.
125 <a name="a1" doxytag="IEpair::DecRef"></a><p>
126 <table width="100%" cellpadding="2" cellspacing="0" border="0">
129 <table cellpadding="0" cellspacing="0" border="0">
131 <td nowrap valign="top"><b>
132 void IEpair::DecRef (
134 <td valign="bottom"><b>
135 )<code> [pure virtual]</code>
143 <table cellspacing=5 cellpadding=0 border=0>
151 Decrement the reference count.
156 <a name="a3" doxytag="IEpair::FloatForKey"></a><p>
157 <table width="100%" cellpadding="2" cellspacing="0" border="0">
160 <table cellpadding="0" cellspacing="0" border="0">
162 <td nowrap valign="top"><b>
163 float IEpair::FloatForKey (
165 <td valign="bottom"><b>
166 char * <em>key</em> )<code> [pure virtual]</code>
174 <table cellspacing=5 cellpadding=0 border=0>
182 Get a float from a key.
187 <a name="a6" doxytag="IEpair::GetEntityOrigin"></a><p>
188 <table width="100%" cellpadding="2" cellspacing="0" border="0">
191 <table cellpadding="0" cellspacing="0" border="0">
193 <td nowrap valign="top"><b>
194 void IEpair::GetEntityOrigin (
196 <td valign="bottom"><b>
197 vec3_t <em>vec</em> )<code> [pure virtual]</code>
205 <table cellspacing=5 cellpadding=0 border=0>
213 Get a vec3_t for the entities origin.
218 <a name="a2" doxytag="IEpair::GetVectorForKey"></a><p>
219 <table width="100%" cellpadding="2" cellspacing="0" border="0">
222 <table cellpadding="0" cellspacing="0" border="0">
224 <td nowrap valign="top"><b>
225 void IEpair::GetVectorForKey (
227 <td valign="bottom"><b>
234 vec3_t <em>vec</em> )<code> [pure virtual]</code>
242 <table cellspacing=5 cellpadding=0 border=0>
250 Get a vector from a key.
255 <a name="a0" doxytag="IEpair::IncRef"></a><p>
256 <table width="100%" cellpadding="2" cellspacing="0" border="0">
259 <table cellpadding="0" cellspacing="0" border="0">
261 <td nowrap valign="top"><b>
262 void IEpair::IncRef (
264 <td valign="bottom"><b>
265 )<code> [pure virtual]</code>
273 <table cellspacing=5 cellpadding=0 border=0>
281 Increment the number of references to this object.
286 <a name="a5" doxytag="IEpair::SetKeyValue"></a><p>
287 <table width="100%" cellpadding="2" cellspacing="0" border="0">
290 <table cellpadding="0" cellspacing="0" border="0">
292 <td nowrap valign="top"><b>
293 void IEpair::SetKeyValue (
295 <td valign="bottom"><b>
302 char * <em>value</em> )<code> [pure virtual]</code>
310 <table cellspacing=5 cellpadding=0 border=0>
318 Set a key value to char *value.
321 <b>Parameters: </b><dd>
322 <table border=0 cellspacing=2 cellpadding=0>
323 <tr><td valign=top><em>key</em>
325 The (char *) containing the keyname </td></tr>
326 <tr><td valign=top><em>value</em>
328 The (char *) to set the key value to </td></tr>
333 <a name="a4" doxytag="IEpair::ValueForKey"></a><p>
334 <table width="100%" cellpadding="2" cellspacing="0" border="0">
337 <table cellpadding="0" cellspacing="0" border="0">
339 <td nowrap valign="top"><b>
340 char * IEpair::ValueForKey (
342 <td valign="bottom"><b>
343 char * <em>key</em> )<code> [pure virtual]</code>
351 <table cellspacing=5 cellpadding=0 border=0>
359 Get a string (char *) from a key.
364 <hr>The documentation for this class was generated from the following file:<ul>
365 <li><a class="el" href="test_8c-source.html">iepairs.h</a></ul>
367 <!-- ---------------- Start Footer ----------------- -->
373 <table width="95%" cellpadding="1" cellspacing="0">
376 <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
379 <a href="mailto:ttimo@idsoftware.com">
380 <i>ttimo@idsoftware.com</i>
390 <td background="../images/body-right-tile.gif" height="100%"> </td>
393 <td valign="top" align="left">
394 <img src="../images/body-lower-left.gif" alt="" width="19" height="12">
396 <td valign="top" background="../images/body-lower-tile.gif">
397 <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
399 <td valign="top" align="right">
400 <img src="../images/body-lower-right.gif" alt="" width="19" height="12">