aboutsummaryrefslogtreecommitdiff
path: root/docs/doxygen/nel/a02463.html
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--docs/doxygen/nel/a02463.html386
1 files changed, 386 insertions, 0 deletions
diff --git a/docs/doxygen/nel/a02463.html b/docs/doxygen/nel/a02463.html
new file mode 100644
index 00000000..07fa5850
--- /dev/null
+++ b/docs/doxygen/nel/a02463.html
@@ -0,0 +1,386 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
+<title>NeL: NL3D::U3dMouseListener class Reference</title>
+<link href="doxygen.css" rel="stylesheet" type="text/css">
+</head><body>
+<!-- Generated by Doxygen 1.3.6 -->
+<div class="qindex"> <form class="search" action="search.php" method="get">
+<a class="qindex" href="main.html">Main&nbsp;Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class&nbsp;Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical&nbsp;List</a> | <a class="qindex" href="annotated.html">Data&nbsp;Structures</a> | <a class="qindex" href="files.html">File&nbsp;List</a> | <a class="qindex" href="namespacemembers.html">Namespace&nbsp;Members</a> | <a class="qindex" href="functions.html">Data&nbsp;Fields</a> | <a class="qindex" href="globals.html">Globals</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a> | <span class="search"><u>S</u>earch&nbsp;for&nbsp;<input class="search" type="text" name="query" value="" size="20" accesskey="s"/></span></form></div>
+<h1>NL3D::U3dMouseListener Class Reference</h1><code>#include &lt;<a class="el" href="a06591.html">u_3d_mouse_listener.h</a>&gt;</code>
+<p>
+<p>Inheritance diagram for NL3D::U3dMouseListener:
+<p><center><img src="a02463.png" usemap="#NL3D::U3dMouseListener_map" border="0" alt=""></center>
+<map name="NL3D::U3dMouseListener_map">
+<area href="a02462.html" alt="NL3D::CEvent3dMouseListener" shape="rect" coords="0,56,188,80">
+</map>
+<hr><a name="_details"></a><h2>Detailed Description</h2>
+3d mouse listener<p>
+<dl compact><dt><b>Author:</b></dt><dd>Cyril 'Hulud' Corvazier <p>
+Nevrax France </dd></dl>
+<dl compact><dt><b>Date:</b></dt><dd>2001 </dd></dl>
+
+<p>
+
+<p>
+Definition at line <a class="el" href="a06591.html#l00043">43</a> of file <a class="el" href="a06591.html">u_3d_mouse_listener.h</a>.<table border=0 cellpadding=0 cellspacing=0>
+<tr><td></td></tr>
+<tr><td colspan=2><br><h2>Public Types</h2></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>enum &nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">TMouseMode</a> { <a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw2">nelStyle</a>,
+<a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw0">edit3d</a>,
+<a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw1">firstPerson</a>
+ }</td></tr>
+
+<tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr>
+<tr><td colspan="2"><div class="groupHeader">Get</div></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual <a class="el" href="a03128.html">CVector</a>&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1368_0">getHotSpot</a> () const=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual const <a class="el" href="a02851.html">NLMISC::CMatrix</a> &amp;&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1368_1">getViewMatrix</a> ()=0</td></tr>
+
+<tr><td colspan="2"><div class="groupHeader">Setup</div></td></tr>
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_0">setFrustrum</a> (const <a class="el" href="a02562.html">CFrustum</a> &amp;frustrum)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_1">setHotSpot</a> (const <a class="el" href="a03128.html">CVector</a> &amp;hotSpot)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_2">setMatrix</a> (const <a class="el" href="a02851.html">NLMISC::CMatrix</a> &amp;<a class="el" href="a04223.html#a578">matrix</a>)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_3">setMouseMode</a> (<a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">TMouseMode</a> mouseMode)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_4">setSpeed</a> (float speed)=0</td></tr>
+
+<tr><td class="memItemLeft" nowrap align=right valign=top>virtual void&nbsp;</td><td class="memItemRight" valign=bottom><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_5">setViewport</a> (const <a class="el" href="a03704.html">NL3D::CViewport</a> &amp;viewport)=0</td></tr>
+
+</table>
+<hr><h2>Member Enumeration Documentation</h2>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerw3" doxytag="NL3D::U3dMouseListener::TMouseMode" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> enum <a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">NL3D::U3dMouseListener::TMouseMode</a>
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Mouse mode. There is two move modes: 3d editor style and NeL style. Default mode is NeL style.<p>
+(nelStyle) NeL style is: MouseRotateHotSpot: CTRL + RIGHTMOUSE MouseTranslateXYHotSpot: CTRL + LEFTMOUSE MouseTranslateZHotSpot: CTRL + SHIFT + LEFTMOUSE MouseZoomHotSpot: ALT + LEFTMOUSE<p>
+(edit3dStyle) 3d editor style is: MouseRotateHotSpot: ALT + MIDDLEMOUSE MouseTranslateXYHotSpot: MIDDLEMOUSE MouseTranslateZHotSpot: CTRL + MIDDLEMOUSE<p>
+(firstPerson) First person shoorter style is: MouseRotateView: MOUSE MOVE KeyUp: MOVE FORWARD KeyDown: MOVE BACKWARD Left: STRAF LEFT Right: STRAF RIGHT PageUp: MOVE UP PageDown: MOVE DOWN<dl compact><dt><b>Enumeration values: </b></dt><dd>
+<table border=0 cellspacing=2 cellpadding=0>
+<tr><td valign=top><em><a class="anchor" name="NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw2" doxytag="nelStyle" ></a>nelStyle</em>&nbsp;</td><td>
+</td></tr>
+<tr><td valign=top><em><a class="anchor" name="NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw0" doxytag="edit3d" ></a>edit3d</em>&nbsp;</td><td>
+</td></tr>
+<tr><td valign=top><em><a class="anchor" name="NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw1" doxytag="firstPerson" ></a>firstPerson</em>&nbsp;</td><td>
+</td></tr>
+</table>
+</dl>
+
+<p>
+Definition at line <a class="el" href="a06591.html#l00070">70</a> of file <a class="el" href="a06591.html">u_3d_mouse_listener.h</a>.
+<p>
+<div class="fragment"><pre>00070 { <a class="code" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw2">nelStyle</a>, <a class="code" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw0">edit3d</a>, <a class="code" href="a02463.html#NL3D_1_1U3dMouseListenerw3NL3D_1_1U3dMouseListenerw1">firstPerson</a> };
+</pre></div> </td>
+ </tr>
+</table>
+<hr><h2>Member Function Documentation</h2>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1368_0" doxytag="NL3D::U3dMouseListener::getHotSpot" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual <a class="el" href="a03128.html">CVector</a> NL3D::U3dMouseListener::getHotSpot </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap> const<code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Get the current hot spot. <dl compact><dt><b>Returns:</b></dt><dd>the target used when the mouse move. It can be for exemple the center. of the selected object. The hotspot is not modified by mouse events. </dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1368_1">getViewMatrix()</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz193_1">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1368_1" doxytag="NL3D::U3dMouseListener::getViewMatrix" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual const <a class="el" href="a02851.html">NLMISC::CMatrix</a>&amp; NL3D::U3dMouseListener::getViewMatrix </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Get the current view matrix. This matrix is updated with mouse events. <dl compact><dt><b>Returns:</b></dt><dd>The current view matrix. </dd></dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1367_2">setMatrix()</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz193_3">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_0" doxytag="NL3D::U3dMouseListener::setFrustrum" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setFrustrum </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="a02562.html">CFrustum</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>frustrum</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the current frustrum to use. <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>frustrum</em>&nbsp;</td><td>is the frustrum.</td></tr>
+ </table>
+</dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_8">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_1" doxytag="NL3D::U3dMouseListener::setHotSpot" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setHotSpot </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="a03128.html">CVector</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>hotSpot</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the current hot spot. <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>hotSpot</em>&nbsp;</td><td>is the target to use when the mouse move. It can be for exemple the center. of the selected object. The hotspot is not modified by mouse events. </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1368_1">getViewMatrix()</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_9">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_2" doxytag="NL3D::U3dMouseListener::setMatrix" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setMatrix </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="a02851.html">NLMISC::CMatrix</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>matrix</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the current view matrix to use. <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>matrix</em>&nbsp;</td><td>is the matrix to set. </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerz1368_1">getViewMatrix()</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_10">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_3" doxytag="NL3D::U3dMouseListener::setMouseMode" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setMouseMode </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top"><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">TMouseMode</a>&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>mouseMode</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the mouse mode. <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>mouseMode</em>&nbsp;</td><td>is the mode you want to use. </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">TMouseMode</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_14">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_4" doxytag="NL3D::U3dMouseListener::setSpeed" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setSpeed </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">float&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>speed</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the speed for first person mode. Default 10.f; <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>speed</em>&nbsp;</td><td>is in unit per second. </td></tr>
+ </table>
+</dl>
+<dl compact><dt><b>See also:</b></dt><dd><a class="el" href="a02463.html#NL3D_1_1U3dMouseListenerw3">TMouseMode</a></dd></dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_15">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<a class="anchor" name="NL3D_1_1U3dMouseListenerz1367_5" doxytag="NL3D::U3dMouseListener::setViewport" ></a><p>
+<table class="mdTable" width="100%" cellpadding="2" cellspacing="0">
+ <tr>
+ <td class="mdRow">
+ <table cellpadding="0" cellspacing="0" border="0">
+ <tr>
+ <td class="md" nowrap valign="top"> virtual void NL3D::U3dMouseListener::setViewport </td>
+ <td class="md" valign="top">(&nbsp;</td>
+ <td class="md" nowrap valign="top">const <a class="el" href="a03704.html">NL3D::CViewport</a> &amp;&nbsp;</td>
+ <td class="mdname1" valign="top" nowrap> <em>viewport</em> </td>
+ <td class="md" valign="top">&nbsp;)&nbsp;</td>
+ <td class="md" nowrap><code> [pure virtual]</code></td>
+ </tr>
+
+ </table>
+ </td>
+ </tr>
+</table>
+<table cellspacing=5 cellpadding=0 border=0>
+ <tr>
+ <td>
+ &nbsp;
+ </td>
+ <td>
+
+<p>
+Set the viewport in use in the window. By default, the viewport is fullwindow. <dl compact><dt><b>Parameters:</b></dt><dd>
+ <table border="0" cellspacing="2" cellpadding="0">
+ <tr><td valign=top><em>viewport</em>&nbsp;</td><td>is the viewport to use. All events outside the viewport are ignored.</td></tr>
+ </table>
+</dl>
+
+<p>
+Implemented in <a class="el" href="a02462.html#NL3D_1_1CEvent3dMouseListenerz192_16">NL3D::CEvent3dMouseListener</a>. </td>
+ </tr>
+</table>
+<hr>The documentation for this class was generated from the following file:<ul>
+<li><a class="el" href="a06591.html">u_3d_mouse_listener.h</a></ul>
+<hr size="1"><address style="align: right;"><small>Generated on Tue Mar 16 08:42:16 2004 for NeL by
+<a href="http://www.doxygen.org/index.html">
+<img src="doxygen.png" alt="doxygen" align="middle" border=0 >
+</a>1.3.6 </small></address>
+</body>
+</html>