Doxygen_files/example/classIEpair.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">\r
   2 <html>\r
   3 <head>\r
   4         <title>IEPairsClassDocumentationExample  Doxygen Documentation</title>\r
   5         <link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">\r
   6         <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">\r
   7 </head>\r
   8 <body bgcolor="black">\r
   9 \r
  10 <div align="center">\r
  11 \r
  12 <table cellpadding="0" cellspacing="0" border="0" width="94%">\r
  13  <tr>\r
  14   <td>\r
  15    <img src="../images/top-title.gif" alt="" width="254" height="92">\r
  16   </td>\r
  17   <td background="../images/top-tile.gif" valign="top" align="right" width="100%">\r
  18    <br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">\r
  19   </td>\r
  20   <td align="left">\r
  21    <img src="../images/top-right.gif" alt="" width="12" height="92">\r
  22   </td>\r
  23  </tr>\r
  24 </table>\r
  25 \r
  26 <table cellpadding="0" cellspacing="0" border="0" width="95%">\r
  27  <tr>\r
  28   <td valign="top" align="left">\r
  29    <img src="../images/body-upper-left.gif" alt="" width="19" height="12">\r
  30   </td>\r
  31   <td valign="top" background="../images/body-upper-tile.gif">\r
  32    <img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">\r
  33   </td>\r
  34   <td valign="top" align="right">\r
  35    <img src="../images/body-upper-right.gif" alt="" width="19" height="12">\r
  36   </td>\r
  37         </tr>\r
  38         <tr>\r
  39    <td background="../images/body-left-tile.gif" height="100%">&nbsp;</td>\r
  40    <td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>\r
  41    <br><hr>\r
  42    \r
  43         <center>\r
  44         <table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>\r
  45 \r
  46 <!-- ----------------- End Header ----------------- -->\r
  47 \r
  48                 \r
  49 <!-- Generated by Doxygen 1.2.8.1 -->\r
  50 <center>\r
  51 <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>\r
  52 <hr><h1>IEpair  Class Reference</h1>Virtual class to allow plugin operations on entity pairs. \r
  53 <a href="#_details">More...</a>\r
  54 <p>\r
  55 <a href="classIEpair-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>\r
  56 <tr><td colspan=2><br><h2>Public Methods</h2></td></tr>\r
  57 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a0">IncRef</a> ()=0</td></tr>\r
  58 <tr><td>&nbsp;</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>\r
  59 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a1">DecRef</a> ()=0</td></tr>\r
  60 <tr><td>&nbsp;</td><td><font size=-1><em>Decrement the reference count.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>\r
  61 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a2">GetVectorForKey</a> (char *key, vec3_t vec)=0</td></tr>\r
  62 <tr><td>&nbsp;</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>\r
  63 <tr><td nowrap align=right valign=top>virtual float&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a3">FloatForKey</a> (char *key)=0</td></tr>\r
  64 <tr><td>&nbsp;</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>\r
  65 <tr><td nowrap align=right valign=top>virtual char*&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a4">ValueForKey</a> (char *key)=0</td></tr>\r
  66 <tr><td>&nbsp;</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>\r
  67 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a5">SetKeyValue</a> (char *key, char *value)=0</td></tr>\r
  68 <tr><td>&nbsp;</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>\r
  69 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a6">GetEntityOrigin</a> (vec3_t vec)=0</td></tr>\r
  70 <tr><td>&nbsp;</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>\r
  71 <tr><td nowrap align=right valign=top>virtual void&nbsp;</td><td valign=bottom><a class="el" href="classIEpair.html#a7">CalculateRotatedBounds</a> (vec3_t mins, vec3_t maxs)=0</td></tr>\r
  72 <tr><td>&nbsp;</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>\r
  73 </table>\r
  74 <hr><a name="_details"></a><h2>Detailed Description</h2>\r
  75 Virtual class to allow plugin operations on entity pairs.\r
  76 <p>\r
  77 \r
  78 <p>\r
  79 <dl compact><dt>\r
  80 <b><a class="el" href="todo.html#_todo000001">Todo: </a></b><dd>\r
  81 Write more complete documentation for this class so that it's use is clear</dl>\r
  82 <p>\r
  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 \r
  84 <p>\r
  85 \r
  86 <p>\r
  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>\r
  88 <a name="a7" doxytag="IEpair::CalculateRotatedBounds"></a><p>\r
  89 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
  90   <tr>\r
  91     <td class="md">\r
  92       <table cellpadding="0" cellspacing="0" border="0">\r
  93         <tr>\r
  94           <td nowrap valign="top"><b> \r
  95 void IEpair::CalculateRotatedBounds (\r
  96           </b></td>\r
  97           <td valign="bottom"><b>\r
  98 vec3_t <em>mins</em>, \r
  99           </b></td>\r
 100         </tr>\r
 101         <tr>\r
 102           <td></td>\r
 103           <td><b>\r
 104 vec3_t <em>maxs</em>&nbsp;)<code> [pure virtual]</code>\r
 105           </b></td>\r
 106         </tr>\r
 107 \r
 108       </table>\r
 109     </td>\r
 110   </tr>\r
 111 </table>\r
 112 <table cellspacing=5 cellpadding=0 border=0>\r
 113   <tr>\r
 114     <td>\r
 115       &nbsp;\r
 116     </td>\r
 117     <td>\r
 118 \r
 119 <p>\r
 120 Compute the rotated bounds of the BBox based on "angle" and "angles" keys.\r
 121 <p>\r
 122     </td>\r
 123   </tr>\r
 124 </table>\r
 125 <a name="a1" doxytag="IEpair::DecRef"></a><p>\r
 126 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 127   <tr>\r
 128     <td class="md">\r
 129       <table cellpadding="0" cellspacing="0" border="0">\r
 130         <tr>\r
 131           <td nowrap valign="top"><b> \r
 132 void IEpair::DecRef (\r
 133           </b></td>\r
 134           <td valign="bottom"><b>\r
 135 )<code> [pure virtual]</code>\r
 136           </b></td>\r
 137         </tr>\r
 138 \r
 139       </table>\r
 140     </td>\r
 141   </tr>\r
 142 </table>\r
 143 <table cellspacing=5 cellpadding=0 border=0>\r
 144   <tr>\r
 145     <td>\r
 146       &nbsp;\r
 147     </td>\r
 148     <td>\r
 149 \r
 150 <p>\r
 151 Decrement the reference count.\r
 152 <p>\r
 153     </td>\r
 154   </tr>\r
 155 </table>\r
 156 <a name="a3" doxytag="IEpair::FloatForKey"></a><p>\r
 157 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 158   <tr>\r
 159     <td class="md">\r
 160       <table cellpadding="0" cellspacing="0" border="0">\r
 161         <tr>\r
 162           <td nowrap valign="top"><b> \r
 163 float IEpair::FloatForKey (\r
 164           </b></td>\r
 165           <td valign="bottom"><b>\r
 166 char * <em>key</em>&nbsp;)<code> [pure virtual]</code>\r
 167           </b></td>\r
 168         </tr>\r
 169 \r
 170       </table>\r
 171     </td>\r
 172   </tr>\r
 173 </table>\r
 174 <table cellspacing=5 cellpadding=0 border=0>\r
 175   <tr>\r
 176     <td>\r
 177       &nbsp;\r
 178     </td>\r
 179     <td>\r
 180 \r
 181 <p>\r
 182 Get a float from a key.\r
 183 <p>\r
 184     </td>\r
 185   </tr>\r
 186 </table>\r
 187 <a name="a6" doxytag="IEpair::GetEntityOrigin"></a><p>\r
 188 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 189   <tr>\r
 190     <td class="md">\r
 191       <table cellpadding="0" cellspacing="0" border="0">\r
 192         <tr>\r
 193           <td nowrap valign="top"><b> \r
 194 void IEpair::GetEntityOrigin (\r
 195           </b></td>\r
 196           <td valign="bottom"><b>\r
 197 vec3_t <em>vec</em>&nbsp;)<code> [pure virtual]</code>\r
 198           </b></td>\r
 199         </tr>\r
 200 \r
 201       </table>\r
 202     </td>\r
 203   </tr>\r
 204 </table>\r
 205 <table cellspacing=5 cellpadding=0 border=0>\r
 206   <tr>\r
 207     <td>\r
 208       &nbsp;\r
 209     </td>\r
 210     <td>\r
 211 \r
 212 <p>\r
 213 Get a vec3_t for the entities origin.\r
 214 <p>\r
 215     </td>\r
 216   </tr>\r
 217 </table>\r
 218 <a name="a2" doxytag="IEpair::GetVectorForKey"></a><p>\r
 219 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 220   <tr>\r
 221     <td class="md">\r
 222       <table cellpadding="0" cellspacing="0" border="0">\r
 223         <tr>\r
 224           <td nowrap valign="top"><b> \r
 225 void IEpair::GetVectorForKey (\r
 226           </b></td>\r
 227           <td valign="bottom"><b>\r
 228 char * <em>key</em>, \r
 229           </b></td>\r
 230         </tr>\r
 231         <tr>\r
 232           <td></td>\r
 233           <td><b>\r
 234 vec3_t <em>vec</em>&nbsp;)<code> [pure virtual]</code>\r
 235           </b></td>\r
 236         </tr>\r
 237 \r
 238       </table>\r
 239     </td>\r
 240   </tr>\r
 241 </table>\r
 242 <table cellspacing=5 cellpadding=0 border=0>\r
 243   <tr>\r
 244     <td>\r
 245       &nbsp;\r
 246     </td>\r
 247     <td>\r
 248 \r
 249 <p>\r
 250 Get a vector from a key.\r
 251 <p>\r
 252     </td>\r
 253   </tr>\r
 254 </table>\r
 255 <a name="a0" doxytag="IEpair::IncRef"></a><p>\r
 256 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 257   <tr>\r
 258     <td class="md">\r
 259       <table cellpadding="0" cellspacing="0" border="0">\r
 260         <tr>\r
 261           <td nowrap valign="top"><b> \r
 262 void IEpair::IncRef (\r
 263           </b></td>\r
 264           <td valign="bottom"><b>\r
 265 )<code> [pure virtual]</code>\r
 266           </b></td>\r
 267         </tr>\r
 268 \r
 269       </table>\r
 270     </td>\r
 271   </tr>\r
 272 </table>\r
 273 <table cellspacing=5 cellpadding=0 border=0>\r
 274   <tr>\r
 275     <td>\r
 276       &nbsp;\r
 277     </td>\r
 278     <td>\r
 279 \r
 280 <p>\r
 281 Increment the number of references to this object.\r
 282 <p>\r
 283     </td>\r
 284   </tr>\r
 285 </table>\r
 286 <a name="a5" doxytag="IEpair::SetKeyValue"></a><p>\r
 287 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 288   <tr>\r
 289     <td class="md">\r
 290       <table cellpadding="0" cellspacing="0" border="0">\r
 291         <tr>\r
 292           <td nowrap valign="top"><b> \r
 293 void IEpair::SetKeyValue (\r
 294           </b></td>\r
 295           <td valign="bottom"><b>\r
 296 char * <em>key</em>, \r
 297           </b></td>\r
 298         </tr>\r
 299         <tr>\r
 300           <td></td>\r
 301           <td><b>\r
 302 char * <em>value</em>&nbsp;)<code> [pure virtual]</code>\r
 303           </b></td>\r
 304         </tr>\r
 305 \r
 306       </table>\r
 307     </td>\r
 308   </tr>\r
 309 </table>\r
 310 <table cellspacing=5 cellpadding=0 border=0>\r
 311   <tr>\r
 312     <td>\r
 313       &nbsp;\r
 314     </td>\r
 315     <td>\r
 316 \r
 317 <p>\r
 318 Set a key value to char *value.\r
 319 <p>\r
 320 <dl compact><dt>\r
 321 <b>Parameters: </b><dd>\r
 322 <table border=0 cellspacing=2 cellpadding=0>\r
 323 <tr><td valign=top><em>key</em>\r
 324 &nbsp;</td><td>\r
 325 The (char *) containing the keyname </td></tr>\r
 326 <tr><td valign=top><em>value</em>\r
 327 &nbsp;</td><td>\r
 328 The (char *) to set the key value to </td></tr>\r
 329 </table>\r
 330 </dl>    </td>\r
 331   </tr>\r
 332 </table>\r
 333 <a name="a4" doxytag="IEpair::ValueForKey"></a><p>\r
 334 <table width="100%" cellpadding="2" cellspacing="0" border="0">\r
 335   <tr>\r
 336     <td class="md">\r
 337       <table cellpadding="0" cellspacing="0" border="0">\r
 338         <tr>\r
 339           <td nowrap valign="top"><b> \r
 340 char * IEpair::ValueForKey (\r
 341           </b></td>\r
 342           <td valign="bottom"><b>\r
 343 char * <em>key</em>&nbsp;)<code> [pure virtual]</code>\r
 344           </b></td>\r
 345         </tr>\r
 346 \r
 347       </table>\r
 348     </td>\r
 349   </tr>\r
 350 </table>\r
 351 <table cellspacing=5 cellpadding=0 border=0>\r
 352   <tr>\r
 353     <td>\r
 354       &nbsp;\r
 355     </td>\r
 356     <td>\r
 357 \r
 358 <p>\r
 359 Get a string (char *) from a key.\r
 360 <p>\r
 361     </td>\r
 362   </tr>\r
 363 </table>\r
 364 <hr>The documentation for this class was generated from the following file:<ul>\r
 365 <li><a class="el" href="test_8c-source.html">iepairs.h</a></ul>\r
 366 \r
 367                 <!--  ---------------- Start Footer ----------------- -->\r
 368                 </td></tr></table>\r
 369                 </center>\r
 370 \r
 371                 <br><br>\r
 372                 <div align="center">\r
 373                         <table width="95%" cellpadding="1" cellspacing="0">\r
 374                         <tr>\r
 375                                 <td width="50%">\r
 376                                         <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>\r
 377                                 </td>\r
 378                                 <td align="right">\r
 379                                         <a href="mailto:ttimo@idsoftware.com">\r
 380                                                 <i>ttimo@idsoftware.com</i>\r
 381                                         </a>\r
 382                                 </td>\r
 383                         </tr>\r
 384                         </table>\r
 385                 </div>\r
 386                 \r
 387                 <br>\r
 388                 <br>\r
 389                 </div></td>\r
 390          <td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>\r
 391         </tr>\r
 392         <tr>\r
 393                 <td valign="top" align="left">\r
 394                  <img src="../images/body-lower-left.gif" alt="" width="19" height="12">\r
 395                 </td>\r
 396                 <td valign="top" background="../images/body-lower-tile.gif">\r
 397                  <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">\r
 398                 </td>\r
 399                 <td valign="top" align="right">\r
 400                  <img src="../images/body-lower-right.gif" alt="" width="19" height="12">\r
 401                 </td>\r
 402         </tr>\r
 403 </table>\r
 404 \r
 405 </td>\r
 406 <td valign="top">\r
 407 </td>\r
 408 </tr>\r
 409 </table>\r
 410 \r
 411 </div>\r
 412 \r
 413 </body>\r
 414 </html>\r