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