Doxygen_files/example/test_8c-source.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>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>\r
  53 00002 <font class="comment"></font><font class="comment">/*!</font>\r
  54 00003 <font class="comment">  \todo Write more complete documentation for this class so that it's use</font>\r
  55 00004 <font class="comment">  is clear</font>\r
  56 00005 <font class="comment">                        </font>\r
  57 00006 <font class="comment">  An interface to entity keys and key pairs that allows plugins to;</font>\r
  58 00007 <font class="comment">  read and write entity keys and key values, get a key value as a</font>\r
  59 00008 <font class="comment">  vec3_t</font>\r
  60 00009 <font class="comment">*/</font>\r
  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>\r
  62 00011 {\r
  63 00012   <font class="keyword">public</font>:<font class="comment"></font>\r
  64 00013 <font class="comment">    //! Increment the number of references to this object</font>\r
  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;\r
  66 00015                                 <font class="comment"></font>\r
  67 00016 <font class="comment">    //! Decrement the reference count</font>\r
  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;\r
  69 00018                                 <font class="comment"></font>\r
  70 00019 <font class="comment">    //! Get a vector from a key</font>\r
  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;\r
  72 00021                                 <font class="comment"></font>\r
  73 00022 <font class="comment">    //! Get a float from a key</font>\r
  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;\r
  75 00024                                 <font class="comment"></font>\r
  76 00025 <font class="comment">    //! Get a string (char *) from a key</font>\r
  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;\r
  78 00027                                 <font class="comment"></font>\r
  79 00028 <font class="comment">    //! Set a key value to char *value</font>\r
  80 00029 <font class="comment"></font><font class="comment">    /*!</font>\r
  81 00030 <font class="comment">      \param key The (char *) containing the keyname</font>\r
  82 00031 <font class="comment">      \param value The (char *) to set the key value to</font>\r
  83 00032 <font class="comment">    */</font>\r
  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;\r
  85 00034                                 <font class="comment"></font>\r
  86 00035 <font class="comment">    //! Get a vec3_t for the entities origin</font>\r
  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;\r
  88 00037                                 <font class="comment"></font>\r
  89 00038 <font class="comment">    //! Compute the rotated bounds of the BBox based on "angle" and "angles" keys</font>\r
  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;\r
  91 00040 };\r
  92 </pre></div>\r
  93                 <!--  ---------------- Start Footer ----------------- -->\r
  94                 </td></tr></table>\r
  95                 </center>\r
  96 \r
  97                 <br><br>\r
  98                 <div align="center">\r
  99                         <table width="95%" cellpadding="1" cellspacing="0">\r
 100                         <tr>\r
 101                                 <td width="50%">\r
 102                                         <i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>\r
 103                                 </td>\r
 104                                 <td align="right">\r
 105                                         <a href="mailto:ttimo@idsoftware.com">\r
 106                                                 <i>ttimo@idsoftware.com</i>\r
 107                                         </a>\r
 108                                 </td>\r
 109                         </tr>\r
 110                         </table>\r
 111                 </div>\r
 112                 \r
 113                 <br>\r
 114                 <br>\r
 115                 </div></td>\r
 116          <td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>\r
 117         </tr>\r
 118         <tr>\r
 119                 <td valign="top" align="left">\r
 120                  <img src="../images/body-lower-left.gif" alt="" width="19" height="12">\r
 121                 </td>\r
 122                 <td valign="top" background="../images/body-lower-tile.gif">\r
 123                  <img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">\r
 124                 </td>\r
 125                 <td valign="top" align="right">\r
 126                  <img src="../images/body-lower-right.gif" alt="" width="19" height="12">\r
 127                 </td>\r
 128         </tr>\r
 129 </table>\r
 130 \r
 131 </td>\r
 132 <td valign="top">\r
 133 </td>\r
 134 </tr>\r
 135 </table>\r
 136 \r
 137 </div>\r
 138 \r
 139 </body>\r
 140 </html>\r