[692] | 1 | <html> |
---|
| 2 | <head> |
---|
| 3 | <title>OgreInputEvent.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>OgreInputEvent.h</h1><a href="OgreInputEvent_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 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 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 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">OgreInputEvent.h - </span> |
---|
| 37 | 00028 <span class="comment"> * The root event class for all GuiElement-level input events.</span> |
---|
| 38 | 00029 <span class="comment"> *</span> |
---|
| 39 | 00030 <span class="comment"> * Input events are delivered to listeners before they are</span> |
---|
| 40 | 00031 <span class="comment"> * processed normally by the source where they originated.</span> |
---|
| 41 | 00032 <span class="comment"> * This allows listeners and GuiElement subclasses to "consume"</span> |
---|
| 42 | 00033 <span class="comment"> * the event so that the source will not process them in their</span> |
---|
| 43 | 00034 <span class="comment"> * default manner. For example, consuming mousePressed events</span> |
---|
| 44 | 00035 <span class="comment"> * on a Button GuiElement will prevent the Button from being</span> |
---|
| 45 | 00036 <span class="comment"> * activated.</span> |
---|
| 46 | 00037 <span class="comment">-------------------</span> |
---|
| 47 | 00038 <span class="comment">begin : Nov 19 2002</span> |
---|
| 48 | 00039 <span class="comment">copyright : (C) 2002 by Kenny Sabir</span> |
---|
| 49 | 00040 <span class="comment">email : kenny@sparksuit.com</span> |
---|
| 50 | 00041 <span class="comment">***************************************************************************/</span> |
---|
| 51 | 00042 |
---|
| 52 | 00043 <span class="preprocessor">#ifndef __InputEvent_H__</span> |
---|
| 53 | 00044 <span class="preprocessor"></span><span class="preprocessor">#define __InputEvent_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="l00060"></a><a class="code" href="classOgre_1_1InputEvent.html">00060</a> <span class="keyword">class </span><a class="code" href="OgrePlatform_8h.html#a16">_OgreExport</a> InputEvent |
---|
| 60 | 00061 { |
---|
| 61 | 00062 <span class="keyword">protected</span>: |
---|
| 62 | 00063 |
---|
| 63 | <a name="l00067"></a><a class="code" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">00067</a> <a class="code" href="namespaceOgre.html#a465">Real</a> mWhen; |
---|
| 64 | <a name="l00072"></a><a class="code" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">00072</a> <span class="keywordtype">int</span> mModifiers; |
---|
| 65 | 00073 |
---|
| 66 | <a name="l00078"></a><a class="code" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp10">00078</a> <a class="code" href="classOgre_1_1EventTarget.html">EventTarget</a>* mSource; |
---|
| 67 | 00079 |
---|
| 68 | <a name="l00083"></a><a class="code" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">00083</a> <span class="keywordtype">int</span> mId; |
---|
| 69 | 00084 |
---|
| 70 | <a name="l00088"></a><a class="code" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">00088</a> <span class="keywordtype">bool</span> mConsumed; |
---|
| 71 | 00089 |
---|
| 72 | 00090 <span class="keyword">public</span>: |
---|
| 73 | 00091 |
---|
| 74 | 00092 |
---|
| 75 | 00093 <span class="keyword">enum</span> <span class="comment">// using the enum hack cause VC6 doesn't support static const in classes</span> |
---|
| 76 | 00094 { |
---|
| 77 | 00099 SHIFT_MASK = 1 << 0, |
---|
| 78 | 00100 |
---|
| 79 | 00105 CTRL_MASK = 1 << 1, |
---|
| 80 | 00106 |
---|
| 81 | 00113 META_MASK = 1 << 2, |
---|
| 82 | 00119 ALT_MASK = 1 << 3, |
---|
| 83 | 00120 BUTTON0_MASK = 1 << 4, |
---|
| 84 | 00121 BUTTON1_MASK = 1 << 5, |
---|
| 85 | 00122 BUTTON2_MASK = 1 << 6, |
---|
| 86 | 00123 BUTTON3_MASK = 1 << 7, |
---|
| 87 | 00124 BUTTON_ANY_MASK = 0xF << 4 |
---|
| 88 | 00125 }; |
---|
| 89 | 00126 |
---|
| 90 | 00127 |
---|
| 91 | 00128 |
---|
| 92 | 00137 InputEvent(<a class="code" href="classOgre_1_1EventTarget.html">EventTarget</a>* source, <span class="keywordtype">int</span> <span class="keywordtype">id</span>, <span class="keywordtype">long</span> when, <span class="keywordtype">int</span> modifiers); |
---|
| 93 | 00138 |
---|
| 94 | 00143 <span class="keywordtype">void</span> consume(); |
---|
| 95 | 00144 |
---|
| 96 | 00148 <span class="keywordtype">int</span> getModifiers() <span class="keyword">const</span>; |
---|
| 97 | 00149 |
---|
| 98 | 00153 <a class="code" href="namespaceOgre.html#a465">Real</a> getWhen() <span class="keyword">const</span>; |
---|
| 99 | 00154 |
---|
| 100 | 00158 <span class="keywordtype">bool</span> isAltDown() <span class="keyword">const</span>; |
---|
| 101 | 00159 |
---|
| 102 | 00164 <span class="keywordtype">bool</span> isConsumed() <span class="keyword">const</span>; |
---|
| 103 | 00165 |
---|
| 104 | 00169 <span class="keywordtype">bool</span> isControlDown() <span class="keyword">const</span>; |
---|
| 105 | 00170 |
---|
| 106 | 00174 <span class="keywordtype">bool</span> isMetaDown() <span class="keyword">const</span>; |
---|
| 107 | 00175 |
---|
| 108 | 00179 <span class="keywordtype">bool</span> isShiftDown() <span class="keyword">const</span>; |
---|
| 109 | 00180 |
---|
| 110 | 00181 <span class="keywordtype">bool</span> isEventBetween(<span class="keywordtype">int</span> start, <span class="keywordtype">int</span> end) <span class="keyword">const</span>; |
---|
| 111 | 00182 <span class="keywordtype">int</span> getID() <span class="keyword">const</span>; |
---|
| 112 | 00183 |
---|
| 113 | 00184 <a class="code" href="classOgre_1_1EventTarget.html">EventTarget</a>* getSource() <span class="keyword">const</span>; |
---|
| 114 | 00185 }; |
---|
| 115 | 00186 } |
---|
| 116 | 00187 |
---|
| 117 | 00188 |
---|
| 118 | 00189 <span class="preprocessor">#endif // __InputEvent_H__</span> |
---|
| 119 | 00190 <span class="preprocessor"></span> |
---|
| 120 | </pre></div><hr> |
---|
| 121 | <p> |
---|
| 122 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
| 123 | <!--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/> |
---|
| 124 | 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/> |
---|
| 125 | <!--/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#"> |
---|
| 126 | <Work rdf:about=""> |
---|
| 127 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
| 128 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
| 129 | </Work> |
---|
| 130 | <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> --> |
---|
| 131 | |
---|
| 132 | Last modified Sun Mar 12 14:37:43 2006 |
---|
| 133 | </p> |
---|
| 134 | </body> |
---|
| 135 | </html> |
---|