[692] | 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 Page</a> | <a class="qindex" href="namespaces.html">Namespace List</a> | <a class="qindex" href="hierarchy.html">Class Hierarchy</a> | <a class="qindex" href="classes.html">Alphabetical List</a> | <a class="qindex" href="annotated.html">Class List</a> | <a class="qindex" href="files.html">File List</a> | <a class="qindex" href="namespacemembers.html">Namespace Members</a> | <a class="qindex" href="functions.html">Class Members</a> | <a class="qindex" href="globals.html">File Members</a> | <a class="qindex" href="pages.html">Related 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> |
---|
| 11 | 00002 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
| 12 | 00003 <span class="comment">This source file is part of OGRE</span> |
---|
| 13 | 00004 <span class="comment"> (Object-oriented Graphics Rendering Engine)</span> |
---|
| 14 | 00005 <span class="comment">For the latest info, see http://www.ogre3d.org/</span> |
---|
| 15 | 00006 <span class="comment"></span> |
---|
| 16 | 00007 <span class="comment">Copyright (c) 2000-2005 The OGRE Team</span> |
---|
| 17 | 00008 <span class="comment">Also see acknowledgements in Readme.html</span> |
---|
| 18 | 00009 <span class="comment"></span> |
---|
| 19 | 00010 <span class="comment">This program is free software; you can redistribute it and/or modify it under</span> |
---|
| 20 | 00011 <span class="comment">the terms of the GNU Lesser General Public License as published by the Free Software</span> |
---|
| 21 | 00012 <span class="comment">Foundation; either version 2 of the License, or (at your option) any later</span> |
---|
| 22 | 00013 <span class="comment">version.</span> |
---|
| 23 | 00014 <span class="comment"></span> |
---|
| 24 | 00015 <span class="comment">This program is distributed in the hope that it will be useful, but WITHOUT</span> |
---|
| 25 | 00016 <span class="comment">ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS</span> |
---|
| 26 | 00017 <span class="comment">FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.</span> |
---|
| 27 | 00018 <span class="comment"></span> |
---|
| 28 | 00019 <span class="comment">You should have received a copy of the GNU Lesser General Public License along with</span> |
---|
| 29 | 00020 <span class="comment">this program; if not, write to the Free Software Foundation, Inc., 59 Temple</span> |
---|
| 30 | 00021 <span class="comment">Place - Suite 330, Boston, MA 02111-1307, USA, or go to</span> |
---|
| 31 | 00022 <span class="comment">http://www.gnu.org/copyleft/lesser.txt.</span> |
---|
| 32 | 00023 <span class="comment">-----------------------------------------------------------------------------</span> |
---|
| 33 | 00024 <span class="comment">*/</span> |
---|
| 34 | 00025 |
---|
| 35 | 00026 <span class="comment">/***************************************************************************</span> |
---|
| 36 | 00027 <span class="comment">OgreEventDispatcher.h - </span> |
---|
| 37 | 00028 <span class="comment"> Handles the Dispatching of events to a EventTarget (mainly a PositionTarget for </span> |
---|
| 38 | 00029 <span class="comment"> mouse moving). The EventTargets are managed by a target manager.</span> |
---|
| 39 | 00030 <span class="comment"></span> |
---|
| 40 | 00031 <span class="comment"> A EventDispatcher is needed for each TargetManager. ie 1 dispatcher for the OverlayManager,</span> |
---|
| 41 | 00032 <span class="comment"> for managing the 2D GUI components, and another EventDispatcher for a SceneManager </span> |
---|
| 42 | 00033 <span class="comment"> managing the 3D objects.(NOTE currently the SceneManager isn't a TargetManager.. this is a TODO).</span> |
---|
| 43 | 00034 <span class="comment"></span> |
---|
| 44 | 00035 <span class="comment">-------------------</span> |
---|
| 45 | 00036 <span class="comment">begin : Nov 19 2002</span> |
---|
| 46 | 00037 <span class="comment">copyright : (C) 2002 by Kenny Sabir</span> |
---|
| 47 | 00038 <span class="comment">email : kenny@sparksuit.com</span> |
---|
| 48 | 00039 <span class="comment">***************************************************************************/</span> |
---|
| 49 | 00040 |
---|
| 50 | 00041 |
---|
| 51 | 00042 |
---|
| 52 | 00043 <span class="preprocessor">#ifndef __EventDispatcher_H__</span> |
---|
| 53 | 00044 <span class="preprocessor"></span><span class="preprocessor">#define __EventDispatcher_H__</span> |
---|
| 54 | 00045 <span class="preprocessor"></span> |
---|
| 55 | 00046 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span> |
---|
| 56 | 00047 |
---|
| 57 | 00048 <span class="keyword">namespace </span>Ogre { |
---|
| 58 | 00049 |
---|
| 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 |
---|
| 60 | 00059 { |
---|
| 61 | 00060 <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; |
---|
| 63 | 00062 |
---|
| 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> |
---|
| 65 | 00070 |
---|
| 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; |
---|
| 67 | 00076 |
---|
| 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; |
---|
| 69 | 00081 |
---|
| 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; |
---|
| 71 | 00086 |
---|
| 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; |
---|
| 74 | 00093 |
---|
| 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> |
---|
| 76 | 00100 |
---|
| 77 | <a name="l00107"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp8">00107</a> <span class="keywordtype">bool</span> mDragDropOn; |
---|
| 78 | 00108 |
---|
| 79 | <a name="l00112"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp9">00112</a> <span class="keywordtype">bool</span> mDragDropActive; |
---|
| 80 | 00113 |
---|
| 81 | <a name="l00114"></a><a class="code" href="classOgre_1_1EventDispatcher.html#Ogre_1_1EventDispatcherp10">00114</a> <span class="keywordtype">int</span> mEventMask; |
---|
| 82 | 00115 |
---|
| 83 | 00116 <span class="comment">//-------------------</span> |
---|
| 84 | 00117 <span class="comment">// protected methods </span> |
---|
| 85 | 00118 |
---|
| 86 | 00119 <span class="keywordtype">bool</span> processKeyEvent(<a class="code" href="classOgre_1_1KeyEvent.html">KeyEvent</a>* e) ; |
---|
| 87 | 00120 |
---|
| 88 | 00129 <span class="keywordtype">bool</span> processMouseEvent(<a class="code" href="classOgre_1_1MouseEvent.html">MouseEvent</a>* e) ; |
---|
| 89 | 00130 |
---|
| 90 | 00140 <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) ; |
---|
| 91 | 00141 |
---|
| 92 | 00151 <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>) ; |
---|
| 93 | 00152 |
---|
| 94 | 00158 <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) ; |
---|
| 95 | 00159 |
---|
| 96 | 00160 <span class="comment">/*</span> |
---|
| 97 | 00161 <span class="comment"> * Generates enter/exit events as mouse moves over lw PositionTargets</span> |
---|
| 98 | 00162 <span class="comment"> * @param targetOver Target mouse is over (including native container)</span> |
---|
| 99 | 00163 <span class="comment"> * @param e Mouse event in native container</span> |
---|
| 100 | 00164 <span class="comment"> */</span> |
---|
| 101 | 00165 |
---|
| 102 | 00166 <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) ; |
---|
| 103 | 00167 |
---|
| 104 | 00168 <span class="comment">/*</span> |
---|
| 105 | 00169 <span class="comment"> * Generates FocusIn/FocusOut events as the keyboard focus changes.</span> |
---|
| 106 | 00170 <span class="comment"> * @param targetOver Target mouse is over (including native container)</span> |
---|
| 107 | 00171 <span class="comment"> * @param e Mouse event in native container</span> |
---|
| 108 | 00172 <span class="comment"> */</span> |
---|
| 109 | 00173 <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); |
---|
| 110 | 00174 |
---|
| 111 | 00175 <span class="keyword">public</span>: |
---|
| 112 | 00176 EventDispatcher(<a class="code" href="classOgre_1_1TargetManager.html">TargetManager</a>* pTargetManager); |
---|
| 113 | 00177 <span class="keyword">virtual</span> ~EventDispatcher(); |
---|
| 114 | 00178 |
---|
| 115 | 00186 <span class="keywordtype">bool</span> dispatchEvent(<a class="code" href="classOgre_1_1InputEvent.html">InputEvent</a>* e); |
---|
| 116 | 00187 |
---|
| 117 | 00197 <span class="keywordtype">void</span> setDragDrop(<span class="keywordtype">bool</span> dragDropOn); |
---|
| 118 | 00198 |
---|
| 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; } |
---|
| 121 | 00207 }; |
---|
| 122 | 00208 |
---|
| 123 | 00209 } |
---|
| 124 | 00210 |
---|
| 125 | 00211 |
---|
| 126 | 00212 <span class="preprocessor">#endif </span> |
---|
| 127 | </pre></div><hr> |
---|
| 128 | <p> |
---|
| 129 | Copyright © 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/> |
---|
| 131 | This 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 | |
---|
| 139 | Last modified Sun Mar 12 14:37:40 2006 |
---|
| 140 | </p> |
---|
| 141 | </body> |
---|
| 142 | </html> |
---|