source: OGRE/trunk/ogrenew/Docs/api/html/OgreEventProcessor_8h-source.html @ 657

Revision 657, 13.9 KB checked in by mattausch, 18 years ago (diff)

added ogre dependencies and patched ogre sources
Line 
1<html>
2<head>
3<title>OgreEventProcessor.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>OgreEventProcessor.h</h1><a href="OgreEventProcessor_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 <span class="comment">/***************************************************************************</span>
3500026 <span class="comment">OgreEventProcessor.h  -  </span>
3600027 <span class="comment">    The EventProcessor controls getting events, storing them in a queue, and </span>
3700028 <span class="comment">    dispatching events.</span>
3800029 <span class="comment">    It contains an InputDevice which creates InputEvents. The events are then</span>
3900030 <span class="comment">    stored FIFO in the EventQueue. </span>
4000031 <span class="comment"></span>
4100032 <span class="comment">    The EventProcessor is a frame listener, so each frame, it empties the entire</span>
4200033 <span class="comment">    queue to the list of dispatchers.</span>
4300034 <span class="comment"></span>
4400035 <span class="comment">    Each dispatcher corresponds to a registered TargetManager.</span>
4500036 <span class="comment"></span>
4600037 <span class="comment">    The TargetManagers need to be registered with the Processor before initialise is called.</span>
4700038 <span class="comment"></span>
4800039 <span class="comment">    After intialise is called, the Processor will start processing events once startProcessingEvents is called.</span>
4900040 <span class="comment"></span>
5000041 <span class="comment">    The Processor acts like a default EventTarget, so it can process events that no dispatcher consumes.</span>
5100042 <span class="comment">    You can listen default actions to the processor by e.g.</span>
5200043 <span class="comment">        mProcessor-&gt;addMouseListener(defaultMouseMovement);</span>
5300044 <span class="comment"></span>
5400045 <span class="comment">    WARNING: The event objects are created in InputReader when they are submitted to the queue</span>
5500046 <span class="comment">    , yet destroyed in the Event Processor when they are taken off the queue.</span>
5600047 <span class="comment">    Deleting objects in different locations to where they are created is usually undesirable, however,</span>
5700048 <span class="comment">    since the Processor, queue and InputReader are tightly coupled (only the Processor is visible to the outside)</span>
5800049 <span class="comment">    this can be an exception.</span>
5900050 <span class="comment">    The reason for this is for performance... The alternative, is to do 2 more event copies when sending events to the queue,</span>
6000051 <span class="comment">    so the queue manages creating (copying the event from the inputReader) and deleting objects once popped - however</span>
6100052 <span class="comment">    this would require the events to be copied twice.. So I have avoided this by having the same event object passed around</span>
6200053 <span class="comment">    and not copied.</span>
6300054 <span class="comment">-------------------</span>
6400055 <span class="comment">begin                : Nov 19 2002</span>
6500056 <span class="comment">copyright            : (C) 2002 by Kenny Sabir</span>
6600057 <span class="comment">email                : kenny@sparksuit.com</span>
6700058 <span class="comment">***************************************************************************/</span>
6800059
6900060 <span class="preprocessor">#ifndef __EventProcessor_H__</span>
7000061 <span class="preprocessor"></span><span class="preprocessor">#define __EventProcessor_H__</span>
7100062 <span class="preprocessor"></span>
7200063 <span class="preprocessor">#include &lt;list&gt;</span>
7300064 <span class="preprocessor">#include "<a class="code" href="OgrePrerequisites_8h.html">OgrePrerequisites.h</a>"</span>
7400065 <span class="preprocessor">#include "<a class="code" href="OgreSingleton_8h.html">OgreSingleton.h</a>"</span>
7500066 <span class="preprocessor">#include "<a class="code" href="OgreFrameListener_8h.html">OgreFrameListener.h</a>"</span>
7600067 <span class="preprocessor">#include "<a class="code" href="OgreMouseTarget_8h.html">OgreMouseTarget.h</a>"</span>
7700068 <span class="preprocessor">#include "<a class="code" href="OgreKeyTarget_8h.html">OgreKeyTarget.h</a>"</span>
7800069 <span class="preprocessor">#include "<a class="code" href="OgreMouseMotionTarget_8h.html">OgreMouseMotionTarget.h</a>"</span>
7900070
8000071 <span class="keyword">namespace </span>Ogre {
81<a name="l00090"></a><a class="code" href="classOgre_1_1EventProcessor.html">00090</a>     <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> EventProcessor : <span class="keyword">public</span> <a class="code" href="classOgre_1_1FrameListener.html">FrameListener</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1MouseTarget.html">MouseTarget</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1MouseMotionTarget.html">MouseMotionTarget</a>, <span class="keyword">public</span> <a class="code" href="classOgre_1_1Singleton.html">Singleton</a>&lt;EventProcessor&gt;, <span class="keyword">public</span> <a class="code" href="classOgre_1_1KeyTarget.html">KeyTarget</a>
8200091     {
8300092     <span class="keyword">protected</span>:
84<a name="l00093"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorp0">00093</a>         <a class="code" href="classOgre_1_1EventQueue.html">EventQueue</a>* mEventQueue;
8500098         <span class="keywordtype">void</span> cleanup();
86<a name="l00099"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorp1">00099</a>         <a class="code" href="classOgre_1_1InputReader.html">InputReader</a>* mInputDevice;
87<a name="l00100"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx0">00100</a>         <span class="keyword">typedef</span> std::list&lt;EventDispatcher*&gt; <a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx0">DispatcherList</a>;
88<a name="l00101"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx1">00101</a>         <span class="keyword">typedef</span> std::list&lt;EventTarget*&gt; <a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx1">EventTargetList</a>;
89<a name="l00102"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorp2">00102</a>         <a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx0">DispatcherList</a> mDispatcherList;
90<a name="l00103"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorp3">00103</a>         <a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorx1">EventTargetList</a> mEventTargetList;
91<a name="l00104"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessorp4">00104</a>         <span class="keywordtype">bool</span> mRegisteredAsFrameListener;
9200105
9300106     <span class="keyword">public</span>:
9400107         EventProcessor();
9500108         <span class="keyword">virtual</span> ~EventProcessor();
9600109
9700113         <span class="keywordtype">void</span> startProcessingEvents(<span class="keywordtype">bool</span> registerListener=<span class="keyword">true</span>);
9800114
9900119         <span class="keywordtype">void</span> stopProcessingEvents();
10000120
10100126         <span class="keywordtype">void</span> initialise(<a class="code" href="classOgre_1_1RenderWindow.html">RenderWindow</a>* ren);
10200127
10300132         <span class="keywordtype">void</span> processEvent(<a class="code" href="classOgre_1_1InputEvent.html">InputEvent</a>* e);
10400133
10500138         <span class="keywordtype">void</span> addCursorMoveListener(<a class="code" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a>* c);
10600139
10700144         <span class="keywordtype">void</span> removeCursorMoveListener(<a class="code" href="classOgre_1_1MouseMotionListener.html">MouseMotionListener</a>* c);
10800145
10900151         <span class="keywordtype">void</span> addTargetManager(<a class="code" href="classOgre_1_1TargetManager.html">TargetManager</a>* targetManager);
11000152
11100158         <span class="keywordtype">void</span> addEventTarget(<a class="code" href="classOgre_1_1EventTarget.html">EventTarget</a>* eventTarget);
11200159
11300165         <span class="keywordtype">bool</span> frameStarted(<span class="keyword">const</span> <a class="code" href="structOgre_1_1FrameEvent.html">FrameEvent</a>&amp; evt);
11400166
11500167         <span class="comment">// PositionTarget methods</span>
11600171 <span class="comment"></span>        <a class="code" href="namespaceOgre.html#a420">Real</a> getTop() <span class="keyword">const</span>;
11700172
11800176         <a class="code" href="namespaceOgre.html#a420">Real</a> getLeft() <span class="keyword">const</span>;
11900177
12000181         <a class="code" href="classOgre_1_1PositionTarget.html">PositionTarget</a>* getPositionTargetParent() <span class="keyword">const</span>;
12100182
12200183
12300184
124<a name="l00185"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora14">00185</a>         <span class="keywordtype">bool</span> isKeyEnabled()<span class="keyword"> const</span>
12500186 <span class="keyword">        </span>{ <span class="keywordflow">return</span> <span class="keyword">true</span>; }
12600187
127<a name="l00188"></a><a class="code" href="classOgre_1_1EventProcessor.html#Ogre_1_1EventProcessora15">00188</a>         <span class="keyword">inline</span> <a class="code" href="classOgre_1_1InputReader.html">InputReader</a>* getInputReader()
12800189         { <span class="keywordflow">return</span> mInputDevice; }
12900205         <span class="keyword">static</span> EventProcessor&amp; getSingleton(<span class="keywordtype">void</span>);
13000221         <span class="keyword">static</span> EventProcessor* getSingletonPtr(<span class="keywordtype">void</span>);
13100222     };
13200223
13300224
13400225
13500226 }
13600227
13700228
13800229 <span class="preprocessor">#endif //__EventProcessor_H__</span>
139</pre></div><hr>
140<p>
141Copyright &copy; 2000-2005 by The OGRE Team<br />
142<!--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/>
143This 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/>
144                <!--/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#">
145                <Work rdf:about="">
146                        <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" />
147        <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" />
148                </Work>
149                <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> -->
150
151Last modified Sun Feb 12 12:59:44 2006
152</p>
153</body>
154</html>
Note: See TracBrowser for help on using the repository browser.