source: OGRE/trunk/ogrenew/Docs/api/html/OgreEventDispatcher_8h-source.html @ 692

Revision 692, 12.3 KB checked in by mattausch, 18 years ago (diff)

adding ogre 1.2 and dependencies
Line 
1<html>
2<head>
3<title>OgreEventDispatcher.h Source File - OGRE Documentation</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
4<link type="text/css" rel="stylesheet" href="style.css">
5</head>
6
7<body>
8<!-- Generated by Doxygen 1.3.6 -->
9<div class="qindex"><a class="qindex" href="index.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">Class&nbsp;List</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">Class&nbsp;Members</a> | <a class="qindex" href="globals.html">File&nbsp;Members</a> | <a class="qindex" href="pages.html">Related&nbsp;Pages</a></div>
10<h1>OgreEventDispatcher.h</h1><a href="OgreEventDispatcher_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <span class="comment">/*</span>
1100002 <span class="comment">-----------------------------------------------------------------------------</span>
1200003 <span class="comment">This source file is part of OGRE</span>
1300004 <span class="comment">    (Object-oriented Graphics Rendering Engine)</span>
1400005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span>
1500006 <span class="comment"></span>
1600007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span>
1700008 <span class="comment">Also see acknowledgements in Readme.html</span>
1800009 <span class="comment"></span>
1900010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span>
2000011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span>
2100012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span>
2200013 <span class="comment">version.</span>
2300014 <span class="comment"></span>
2400015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span>
2500016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span>
2600017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span>
2700018 <span class="comment"></span>
2800019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span>
2900020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span>
3000021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span>
3100022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span>
3200023 <span class="comment">-----------------------------------------------------------------------------</span>
3300024 <span class="comment">*/</span>
3400025
3500026 <span class="comment">/***************************************************************************</span>
3600027 <span class="comment">OgreEventDispatcher.h  -  </span>
3700028 <span class="comment">    Handles the Dispatching of events to a EventTarget (mainly a PositionTarget for </span>
3800029 <span class="comment">    mouse moving). The EventTargets are managed by a target manager.</span>
3900030 <span class="comment"></span>
4000031 <span class="comment">    A EventDispatcher is needed for each TargetManager. ie 1 dispatcher for the OverlayManager,</span>
4100032 <span class="comment">    for managing the 2D GUI components, and another EventDispatcher for a SceneManager </span>
4200033 <span class="comment">    managing the 3D objects.(NOTE currently the SceneManager isn't a TargetManager.. this is a TODO).</span>
4300034 <span class="comment"></span>
4400035 <span class="comment">-------------------</span>
4500036 <span class="comment">begin                : Nov 19 2002</span>
4600037 <span class="comment">copyright            : (C) 2002 by Kenny Sabir</span>
4700038 <span class="comment">email                : kenny@sparksuit.com</span>
4800039 <span class="comment">***************************************************************************/</span>
4900040
5000041
5100042
5200043 <span class="preprocessor">#ifndef __EventDispatcher_H__</span>
5300044 <span class="preprocessor"></span><span class="preprocessor">#define __EventDispatcher_H__</span>
5400045 <span class="preprocessor"></span>
5500046 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
5600047
5700048 <span class="keyword">namespace </span>Ogre {
5800049
59<a name="l00058"></a><a class="code" href="classOgre_1_1EventDispatcher.html">00058</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> EventDispatcher
6000059     {
6100060     <span class="keyword">protected</span>:
62<a name="l00061"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp0">00061</a>         <a class="code" href="classOgre_1_1TargetManager.html">TargetManager</a>* mTargetManager;     
6300062
64<a name="l00069"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp1">00069</a>         <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* mFocus; <span class="comment">// isn't implemented yet</span>
6500070
66<a name="l00075"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp2">00075</a>         <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* mMouseDragSource;
6700076
68<a name="l00080"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp3">00080</a>         <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* mKeyCursorOn;   
6900081
70<a name="l00085"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp4">00085</a>             <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* mTargetLastEntered;
7100086
72<a name="l00091"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp5">00091</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mMouseX;
73<a name="l00092"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp6">00092</a>         <a class="code" href="namespaceOgre.html#a465">Real</a> mMouseY;
7400093
75<a name="l00099"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp7">00099</a>         <span class="keywordtype">bool</span> mDragging;       <span class="comment">// i.e. mouse grab</span>
7600100
77<a name="l00107"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp8">00107</a>         <span class="keywordtype">bool</span> mDragDropOn;
7800108
79<a name="l00112"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp9">00112</a>         <span class="keywordtype">bool</span> mDragDropActive;
8000113
81<a name="l00114"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp10">00114</a>         <span class="keywordtype">int</span> mEventMask;
8200115
8300116         <span class="comment">//-------------------</span>
8400117         <span class="comment">// protected methods    </span>
8500118
8600119         <span class="keywordtype">bool</span> processKeyEvent(<a class="code" href="classOgre_1_1KeyEvent.html">KeyEvent</a>* e) ;
8700120
8800129         <span class="keywordtype">bool</span> processMouseEvent(<a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e) ;
8900130
9000140         <span class="keywordtype">void</span> retargetMouseEvent(<a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* target, <a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e) ;
9100141
9200151         <span class="keywordtype">void</span> retargetMouseEvent(<a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* target, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e, <span class="keywordtype">bool</span> consume = <span class="keyword">false</span>) ;
9300152
9400158         <span class="keywordtype">void</span> retargetKeyEvent(<a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* target, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e) ;
9500159
9600160         <span class="comment">/*</span>
9700161 <span class="comment">        * Generates enter/exit events as mouse moves over lw PositionTargets</span>
9800162 <span class="comment">        * @param targetOver Target mouse is over (including native container)</span>
9900163 <span class="comment">        * @param e          Mouse event in native container</span>
10000164 <span class="comment">        */</span>
10100165
10200166         <span class="keywordtype">void</span> trackMouseEnterExit(<a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* targetOver, <a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e) ;
10300167
10400168         <span class="comment">/*</span>
10500169 <span class="comment">        * Generates FocusIn/FocusOut events as the keyboard focus changes.</span>
10600170 <span class="comment">        * @param targetOver Target mouse is over (including native container)</span>
10700171 <span class="comment">        * @param e           Mouse event in native container</span>
10800172 <span class="comment">        */</span>
10900173         <span class="keywordtype">void</span> trackKeyEnterExit(<a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* targetOver, <a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e);
11000174
11100175     <span class="keyword">public</span>:
11200176         EventDispatcher(<a class="code" href="classOgre_1_1TargetManager.html">TargetManager</a>* pTargetManager);
11300177         <span class="keyword">virtual</span> ~EventDispatcher();       
11400178
11500186         <span class="keywordtype">bool</span> dispatchEvent(<a class="code" href="classOgre_1_1InputEvent.html">InputEvent</a>* e);
11600187
11700197         <span class="keywordtype">void</span> setDragDrop(<span class="keywordtype">bool</span> dragDropOn);
11800198
119<a name="l00202"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatchera4">00202</a>         <span class="keyword">inline</span> <a class="code" href="namespaceOgre.html#a465">Real</a> getMouseX()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMouseX; }
120<a name="l00206"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatchera5">00206</a>         <span class="keyword">inline</span> <a class="code" href="namespaceOgre.html#a465">Real</a> getMouseY()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> mMouseY; }
12100207     };
12200208
12300209 }
12400210
12500211
12600212 <span class="preprocessor">#endif </span>
127</pre></div><hr>
128<p>
129Copyright &copy; 2000-2005 by The OGRE Team<br />
130<!--Creative Commons License--><a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/"><img alt="Creative Commons License" border="0" src="http://creativecommons.org/images/public/somerights20.png"/></a><br/>
131This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by-sa/2.5/">Creative Commons Attribution-ShareAlike 2.5 License</a>.<br/>
132                <!--/Creative Commons License--><!-- <rdf:RDF xmlns="http://web.resource.org/cc/" xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
133                <Work rdf:about="">
134                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
135        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
136                </Work>
137                <License rdf:about="http://creativecommons.org/licenses/by-sa/2.5/"><permits rdf:resource="http://web.resource.org/cc/Reproduction"/><permits rdf:resource="http://web.resource.org/cc/Distribution"/><requires rdf:resource="http://web.resource.org/cc/Notice"/><requires rdf:resource="http://web.resource.org/cc/Attribution"/><permits rdf:resource="http://web.resource.org/cc/DerivativeWorks"/><requires rdf:resource="http://web.resource.org/cc/ShareAlike"/></License></rdf:RDF> -->
138
139Last modified Sun Mar 12 14:37:40 2006
140</p>
141</body>
142</html>
Note: See TracBrowser for help on using the repository browser.