maj/OpenArena
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

*** empty log message ***

Browse Source
This commit is contained in:
Tom Hicks
2006-07-19 00:03:26 -04:00
parent 6d640f3148
commit fdc4f9e0ce
177 changed files with 679 additions and 951 deletions
Download Patch File Download Diff File Expand all files Collapse all files

333
doc/html/class_open_arena_1_1_camera.html
View File

@@ -20,7 +20,7 @@
</ul></div>
<div class="nav">
<a class="el" href="namespace_open_arena.html">OpenArena</a>::<a class="el" href="class_open_arena_1_1_camera.html">Camera</a></div>
<h1>OpenArena::Camera Class Reference</h1><!-- doxytag: class="OpenArena::Camera" -->Write brief comment for <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> here.
<h1>OpenArena::Camera Class Reference</h1><!-- doxytag: class="OpenArena::Camera" -->The <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> class represents a camera or view in 3-dimensional space.
<a href="#_details">More...</a>
<p>
<code>#include &lt;camera.h&gt;</code>
@@ -34,42 +34,42 @@
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#a9aa0d60f8f88ed64e695dcd2a5ead25">Position</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns this Camera's position. <a href="#a9aa0d60f8f88ed64e695dcd2a5ead25"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#55fdaa3adbb54036cbeabb58621151c7">View</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#55fdaa3adbb54036cbeabb58621151c7">View</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for View here. <a href="#55fdaa3adbb54036cbeabb58621151c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#1059827a14e8be84398b344e2c9a6ac6">UpVector</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns the view vector of this camera. <a href="#55fdaa3adbb54036cbeabb58621151c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#1059827a14e8be84398b344e2c9a6ac6">UpVector</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for UpVector here. <a href="#1059827a14e8be84398b344e2c9a6ac6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#90e293115cfc8b82e56c5975af2b2340">Strafe</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns a vector pointing up with respect to the view. <a href="#1059827a14e8be84398b344e2c9a6ac6"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#90e293115cfc8b82e56c5975af2b2340">Strafe</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for Strafe here. <a href="#90e293115cfc8b82e56c5975af2b2340"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Returns this Camera's strafe vector. <a href="#90e293115cfc8b82e56c5975af2b2340"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#e442c80b0291b9e72e188b8f267f0f8b">PositionCamera</a> (double xpos, double ypos, double zpos, double xview, double yview, double zview, double xup, double yup, double zup)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for PositionCamera here. <a href="#e442c80b0291b9e72e188b8f267f0f8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#4a3de91ff9f5fc148e4f88e0133469cc">PositionCamera</a> (<a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a> pos, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a> view, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a> up)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relocates and reorients this <a class="el" href="class_open_arena_1_1_camera.html">Camera</a>. <a href="#e442c80b0291b9e72e188b8f267f0f8b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#c647757a221f41f78487fb11fc9cedb9">PositionCamera</a> (<a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a> pos, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a> view, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a> up)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for PositionCamera here. <a href="#4a3de91ff9f5fc148e4f88e0133469cc"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#fcfe20c3df7e62bbcc8fa5008e8ea23d">Camera::RotateView</a> (double angle, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a> axis)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Relocates and reorients this <a class="el" href="class_open_arena_1_1_camera.html">Camera</a>. <a href="#c647757a221f41f78487fb11fc9cedb9"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#8d3d5a12988ca56c7d86caecab77f891">RotateView</a> (double angle, <a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a> axis)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for RotateView here. <a href="#fcfe20c3df7e62bbcc8fa5008e8ea23d"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rotates the camera a given ammount around a given axis. <a href="#8d3d5a12988ca56c7d86caecab77f891"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#74996afcd49ed188350c9dcaf46c9064">RotateView</a> (double angle, double X, double Y, double Z)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for RotateView here. <a href="#74996afcd49ed188350c9dcaf46c9064"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Rotates the camera a given ammount around a given axis. <a href="#74996afcd49ed188350c9dcaf46c9064"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#c6d1ddc9aedc346967227e7892ced12c">SetViewByMouse</a> (<a class="el" href="class_open_arena_1_1_window.html">Window</a> window)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for SetViewByMouse here. <a href="#c6d1ddc9aedc346967227e7892ced12c"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Updates the view and up vectors based on mouse movement. <a href="#c6d1ddc9aedc346967227e7892ced12c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#7c509721078606ef3d1348be2314b704">StrafeCamera</a> (double speed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for StrafeCamera here. <a href="#7c509721078606ef3d1348be2314b704"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the camera along its strafe axis a given distance. <a href="#7c509721078606ef3d1348be2314b704"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#d9a8e82dfd65dc414630142769b2e939">MoveCamera</a> (double speed)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for MoveCamera here. <a href="#d9a8e82dfd65dc414630142769b2e939"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Moves the camera along its view vector a given number of units. <a href="#d9a8e82dfd65dc414630142769b2e939"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#28bc2891a2d4f08cd3208bdf40cb7e21">Update</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for Update here. <a href="#28bc2891a2d4f08cd3208bdf40cb7e21"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Recalculates the strafe vector. <a href="#28bc2891a2d4f08cd3208bdf40cb7e21"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#157113367b26e66f41a7c03a96041237">Look</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for Look here. <a href="#157113367b26e66f41a7c03a96041237"></a><br></td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Calls gluLookAt to tell OpenGL where to render from. <a href="#157113367b26e66f41a7c03a96041237"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#0431a9b2752d9074011a2bb29b1dfd21">RotateHorizontal</a> (float angle)</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for RotateHorizontal here. <a href="#0431a9b2752d9074011a2bb29b1dfd21"></a><br></td></tr>
@@ -86,6 +86,8 @@
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#42750b47e5606fb71ba715da9a4b3a9a">GetForwardVector</a> ()</td></tr>
<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Write brief comment for GetForwardVector here. <a href="#42750b47e5606fb71ba715da9a4b3a9a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">void&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#d29881ee271ce07f1d4164e22ae1fdac">UpdateVectors</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Private Attributes</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_open_arena_1_1_camera.html#d7de81b78e41164443888012d105ed55">m_vPosition</a></td></tr>
@@ -97,11 +99,11 @@
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Write brief comment for <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> here.
The <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> class represents a camera or view in 3-dimensional space.
<p>
Write detailed description for <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
The <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> class maintains location, view, and orientation (up view) vectors. The <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> can be moved and rotated in any direction. It includes a wrapper, <a class="el" href="class_open_arena_1_1_camera.html#157113367b26e66f41a7c03a96041237">Look()</a>, for gluLookAt.<p>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
<p>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
@@ -127,51 +129,6 @@ Creates a new <a class="el" href="class_open_arena_1_1_camera.html">Camera</a> o
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="fcfe20c3df7e62bbcc8fa5008e8ea23d"></a><!-- doxytag: member="OpenArena::Camera::Camera::RotateView" ref="fcfe20c3df7e62bbcc8fa5008e8ea23d" args="(double angle, Vec3d axis)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenArena::Camera::Camera::RotateView </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td>
<td class="paramname"> <em>axis</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Write brief comment for RotateView here.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>Description of parameter angle.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>axis</em>&nbsp;</td><td>Description of parameter axis.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for RotateView here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for RotateView here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
<a class="anchor" name="42750b47e5606fb71ba715da9a4b3a9a"></a><!-- doxytag: member="OpenArena::Camera::GetForwardVector" ref="42750b47e5606fb71ba715da9a4b3a9a" args="()" -->
<div class="memitem">
<div class="memproto">
@@ -278,16 +235,10 @@ Write detailed description for GetUpVector here.<p>
<div class="memdoc">
<p>
Write brief comment for Look here.
Calls gluLookAt to tell OpenGL where to render from.
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for Look here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for Look here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd>Uses the position, view, and up vectors.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -308,21 +259,15 @@ Write detailed description for Look here.<p>
<div class="memdoc">
<p>
Write brief comment for MoveCamera here.
Moves the camera along its view vector a given number of units.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>speed</em>&nbsp;</td><td>Description of parameter speed.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>speed</em>&nbsp;</td><td>The distance to move the camera.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for MoveCamera here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for MoveCamera here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -348,26 +293,26 @@ Returns this Camera's position.
Returns this Camera's position.
</div>
</div><p>
<a class="anchor" name="4a3de91ff9f5fc148e4f88e0133469cc"></a><!-- doxytag: member="OpenArena::Camera::PositionCamera" ref="4a3de91ff9f5fc148e4f88e0133469cc" args="(Vec3f pos, Vec3f view, Vec3f up)" -->
<a class="anchor" name="c647757a221f41f78487fb11fc9cedb9"></a><!-- doxytag: member="OpenArena::Camera::PositionCamera" ref="c647757a221f41f78487fb11fc9cedb9" args="(Vec3d pos, Vec3d view, Vec3d up)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenArena::Camera::PositionCamera </td>
<td>(</td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td>
<td class="paramname"> <em>pos</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td>
<td class="paramname"> <em>view</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3f</a>&nbsp;</td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td>
<td class="paramname"> <em>up</em></td><td>&nbsp;</td>
</tr>
<tr>
@@ -380,23 +325,17 @@ Returns this Camera's position.
<div class="memdoc">
<p>
Write brief comment for PositionCamera here.
Relocates and reorients this <a class="el" href="class_open_arena_1_1_camera.html">Camera</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>Description of parameter pos.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>view</em>&nbsp;</td><td>Description of parameter view.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>up</em>&nbsp;</td><td>Description of parameter up.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>pos</em>&nbsp;</td><td>The new position vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>view</em>&nbsp;</td><td>The new view vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>up</em>&nbsp;</td><td>The new up vector.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for PositionCamera here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for PositionCamera here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -468,29 +407,23 @@ Write detailed description for PositionCamera here.<p>
<div class="memdoc">
<p>
Write brief comment for PositionCamera here.
Relocates and reorients this <a class="el" href="class_open_arena_1_1_camera.html">Camera</a>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>xpos</em>&nbsp;</td><td>Description of parameter xpos.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>ypos</em>&nbsp;</td><td>Description of parameter ypos.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zpos</em>&nbsp;</td><td>Description of parameter zpos.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>xview</em>&nbsp;</td><td>Description of parameter xview.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>yview</em>&nbsp;</td><td>Description of parameter yview.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zview</em>&nbsp;</td><td>Description of parameter zview.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>xup</em>&nbsp;</td><td>Description of parameter xup.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>yup</em>&nbsp;</td><td>Description of parameter yup.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zup</em>&nbsp;</td><td>Description of parameter zup.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>xpos</em>&nbsp;</td><td>The x-coordinate of the new position vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>ypos</em>&nbsp;</td><td>The y-coordinate of the new position vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zpos</em>&nbsp;</td><td>The z-coordinate of the new position vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>xview</em>&nbsp;</td><td>The x-coordinate of the new view vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>yview</em>&nbsp;</td><td>The y-coordinate of the new view vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zview</em>&nbsp;</td><td>The z-coordinate of the new view vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>xup</em>&nbsp;</td><td>The x-coordinate of the new up vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>yup</em>&nbsp;</td><td>The y-coordinate of the new up vector.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>zup</em>&nbsp;</td><td>The z-coordinate of the new up vector.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for PositionCamera here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for PositionCamera here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -602,24 +535,58 @@ Write detailed description for RotateVertical here.<p>
<div class="memdoc">
<p>
Write brief comment for RotateView here.
Rotates the camera a given ammount around a given axis.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>Description of parameter angle.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>X</em>&nbsp;</td><td>Description of parameter X.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em>&nbsp;</td><td>Description of parameter Y.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Z</em>&nbsp;</td><td>Description of parameter Z.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>The number of degrees to rotate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>X</em>&nbsp;</td><td>The x component of the vector representing the axis to rotate around</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Y</em>&nbsp;</td><td>The y component of the vector representing the axis to rotate around</td></tr>
<tr><td valign="top"></td><td valign="top"><em>Z</em>&nbsp;</td><td>The z component of the vector representing the axis to rotate around</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<dl compact><dt><b>Remarks:</b></dt><dd>The vector should be normalized as the values get passed directly to glRotatef().</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="8d3d5a12988ca56c7d86caecab77f891"></a><!-- doxytag: member="OpenArena::Camera::RotateView" ref="8d3d5a12988ca56c7d86caecab77f891" args="(double angle, Vec3d axis)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenArena::Camera::RotateView </td>
<td>(</td>
<td class="paramtype">double&nbsp;</td>
<td class="paramname"> <em>angle</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="class_open_arena_1_1_vec3d.html">Vec3d</a>&nbsp;</td>
<td class="paramname"> <em>axis</em></td><td>&nbsp;</td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Rotates the camera a given ammount around a given axis.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>angle</em>&nbsp;</td><td>The number of degrees to rotate.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>axis</em>&nbsp;</td><td>A vector representing the axis to rotate around.</td></tr>
</table>
</dl>
Write detailed description for RotateView here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for RotateView here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
This method passes the arguments to glRotatef()<p>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -640,21 +607,15 @@ Write detailed description for RotateView here.<p>
<div class="memdoc">
<p>
Write brief comment for SetViewByMouse here.
Updates the view and up vectors based on mouse movement.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>window</em>&nbsp;</td><td>Description of parameter window.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>window</em>&nbsp;</td><td>The <a class="el" href="class_open_arena_1_1_window.html">Window</a> used to get the mouse coordinates.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for SetViewByMouse here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for SetViewByMouse here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd>This will be removed in favor of some sort of event trigger.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -674,17 +635,12 @@ Write detailed description for SetViewByMouse here.<p>
<div class="memdoc">
<p>
Write brief comment for Strafe here.
Returns this Camera's strafe vector.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for Strafe here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for Strafe here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
The strafe axis is an axis perpendicular to both the up vector and the view vector.<p>
<dl compact><dt><b>Returns:</b></dt><dd>This Camera's strafe vector.</dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -705,21 +661,15 @@ Write detailed description for Strafe here.<p>
<div class="memdoc">
<p>
Write brief comment for StrafeCamera here.
Moves the camera along its strafe axis a given distance.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>speed</em>&nbsp;</td><td>Description of parameter speed.</td></tr>
<tr><td valign="top"></td><td valign="top"><em>speed</em>&nbsp;</td><td>The distance to move.</td></tr>
</table>
</dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for StrafeCamera here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for StrafeCamera here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -739,16 +689,29 @@ Write detailed description for StrafeCamera here.<p>
<div class="memdoc">
<p>
Write brief comment for Update here.
Recalculates the strafe vector.
<p>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
<a class="anchor" name="d29881ee271ce07f1d4164e22ae1fdac"></a><!-- doxytag: member="OpenArena::Camera::UpdateVectors" ref="d29881ee271ce07f1d4164e22ae1fdac" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void OpenArena::Camera::UpdateVectors </td>
<td>(</td>
<td class="paramname"> </td>
<td>&nbsp;)&nbsp;</td>
<td width="100%"><code> [private]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for Update here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for Update here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
</div>
</div><p>
@@ -768,17 +731,11 @@ Write detailed description for Update here.<p>
<div class="memdoc">
<p>
Write brief comment for UpVector here.
Returns a vector pointing up with respect to the view.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for UpVector here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for UpVector here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>A vector pointing up with respect to the view.</dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -798,17 +755,11 @@ Write detailed description for UpVector here.<p>
<div class="memdoc">
<p>
Write brief comment for View here.
Returns the view vector of this camera.
<p>
<dl compact><dt><b>Returns:</b></dt><dd>Write description of return value here.</dd></dl>
<dl compact><dt><b>Exceptions:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>&lt;exception</em>&nbsp;</td><td>class&gt; Description of criteria for throwing this exception.</td></tr>
</table>
</dl>
Write detailed description for View here.<p>
<dl compact><dt><b>Remarks:</b></dt><dd>Write remarks for View here.</dd></dl>
<dl compact><dt><b>See also:</b></dt><dd>Separate items with the '|' character. </dd></dl>
<dl compact><dt><b>Returns:</b></dt><dd>The view vector of this camera.</dd></dl>
<dl compact><dt><b>Remarks:</b></dt><dd></dd></dl>
<dl compact><dt><b>See also:</b></dt><dd></dd></dl>
</div>
</div><p>
@@ -874,8 +825,8 @@ Write detailed description for View here.<p>
</div>
</div><p>
<hr>The documentation for this class was generated from the following files:<ul>
<li>My Documents/Visual Studio 2005/Projects/openarena-clean/src/<a class="el" href="camera_8h.html">camera.h</a><li>My Documents/Visual Studio 2005/Projects/openarena-clean/src/<a class="el" href="camera_8cpp.html">camera.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Mon Jul 10 21:41:11 2006 for OpenArena by&nbsp;
<li>src/<a class="el" href="camera_8h.html">camera.h</a><li>src/<a class="el" href="camera_8cpp.html">camera.cpp</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Tue Jul 11 00:17:52 2006 for OpenArena by&nbsp;
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>