ubergames/gtkradiant
0
0
Fork 0
mirror of https://github.com/UberGames/GtkRadiant.git synced 2024-11-23 12:22:19 +00:00
Code Issues Projects Releases Packages Wiki Activity
gtkradiant/Doxygen_files/example/classIEpair.html
TTimo 12b372f89c ok 
git-svn-id: svn://svn.icculus.org/gtkradiant/GtkRadiant@1 8a3a26a2-13c4-0310-b231-cf6edde360e5
2006-02-10 22:01:20 +00:00

414 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
</head>
<body bgcolor="black">
<div align="center">
<table cellpadding="0" cellspacing="0" border="0" width="94%">
<tr>
<td>
<img src="../images/top-title.gif" alt="" width="254" height="92">
</td>
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
</td>
<td align="left">
<img src="../images/top-right.gif" alt="" width="12" height="92">
</td>
</tr>
</table>
<table cellpadding="0" cellspacing="0" border="0" width="95%">
<tr>
<td valign="top" align="left">
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
</td>
<td valign="top" background="../images/body-upper-tile.gif">
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
</td>
<td valign="top" align="right">
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
</td>
</tr>
<tr>
<td background="../images/body-left-tile.gif" height="100%">&nbsp;</td>
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
<br><hr>
<center>
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
<!-- ----------------- End Header ----------------- -->
<!-- Generated by Doxygen 1.2.8.1 -->
<center>
<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>
<hr><h1>IEpair Class Reference</h1>Virtual class to allow plugin operations on entity pairs.
<a href="#_details">More...</a>
<p>
<a href="classIEpair-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Virtual class to allow plugin operations on entity pairs.
<p>
<p>
<dl compact><dt>
<b><a class="el" href="todo.html#_todo000001">Todo: </a></b><dd>
Write more complete documentation for this class so that it's use is clear</dl>
<p>
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
<p>
<p>
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>
<a name="a7" doxytag="IEpair::CalculateRotatedBounds"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::CalculateRotatedBounds (
</b></td>
<td valign="bottom"><b>
vec3_t <em>mins</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
vec3_t <em>maxs</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Compute the rotated bounds of the BBox based on "angle" and "angles" keys.
<p>
</td>
</tr>
</table>
<a name="a1" doxytag="IEpair::DecRef"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::DecRef (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Decrement the reference count.
<p>
</td>
</tr>
</table>
<a name="a3" doxytag="IEpair::FloatForKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
float IEpair::FloatForKey (
</b></td>
<td valign="bottom"><b>
char * <em>key</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a float from a key.
<p>
</td>
</tr>
</table>
<a name="a6" doxytag="IEpair::GetEntityOrigin"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::GetEntityOrigin (
</b></td>
<td valign="bottom"><b>
vec3_t <em>vec</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a vec3_t for the entities origin.
<p>
</td>
</tr>
</table>
<a name="a2" doxytag="IEpair::GetVectorForKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::GetVectorForKey (
</b></td>
<td valign="bottom"><b>
char * <em>key</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
vec3_t <em>vec</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a vector from a key.
<p>
</td>
</tr>
</table>
<a name="a0" doxytag="IEpair::IncRef"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::IncRef (
</b></td>
<td valign="bottom"><b>
)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Increment the number of references to this object.
<p>
</td>
</tr>
</table>
<a name="a5" doxytag="IEpair::SetKeyValue"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
void IEpair::SetKeyValue (
</b></td>
<td valign="bottom"><b>
char * <em>key</em>,
</b></td>
</tr>
<tr>
<td></td>
<td><b>
char * <em>value</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Set a key value to char *value.
<p>
<dl compact><dt>
<b>Parameters: </b><dd>
<table border=0 cellspacing=2 cellpadding=0>
<tr><td valign=top><em>key</em>
&nbsp;</td><td>
The (char *) containing the keyname </td></tr>
<tr><td valign=top><em>value</em>
&nbsp;</td><td>
The (char *) to set the key value to </td></tr>
</table>
</dl> </td>
</tr>
</table>
<a name="a4" doxytag="IEpair::ValueForKey"></a><p>
<table width="100%" cellpadding="2" cellspacing="0" border="0">
<tr>
<td class="md">
<table cellpadding="0" cellspacing="0" border="0">
<tr>
<td nowrap valign="top"><b>
char * IEpair::ValueForKey (
</b></td>
<td valign="bottom"><b>
char * <em>key</em>&nbsp;)<code> [pure virtual]</code>
</b></td>
</tr>
</table>
</td>
</tr>
</table>
<table cellspacing=5 cellpadding=0 border=0>
<tr>
<td>
&nbsp;
</td>
<td>
<p>
Get a string (char *) from a key.
<p>
</td>
</tr>
</table>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="test_8c-source.html">iepairs.h</a></ul>
<!-- ---------------- Start Footer ----------------- -->
</td></tr></table>
</center>
<br><br>
<div align="center">
<table width="95%" cellpadding="1" cellspacing="0">
<tr>
<td width="50%">
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
</td>
<td align="right">
<a href="mailto:ttimo@idsoftware.com">
<i>ttimo@idsoftware.com</i>
</a>
</td>
</tr>
</table>
</div>
<br>
<br>
</div></td>
<td background="../images/body-right-tile.gif" height="100%">&nbsp;</td>
</tr>
<tr>
<td valign="top" align="left">
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
</td>
<td valign="top" background="../images/body-lower-tile.gif">
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
</td>
<td valign="top" align="right">
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
</td>
</tr>
</table>
</td>
<td valign="top">
</td>
</tr>
</table>
</div>
</body>
</html>
Reference in a new issue View git blame Copy permalink