1 | <html> |
---|
2 | <head> |
---|
3 | <title>Ogre::KeyEvent class Reference - 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>Ogre::KeyEvent Class Reference</h1><code>#include <<a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a>></code> |
---|
11 | <p> |
---|
12 | <p>Inheritance diagram for Ogre::KeyEvent: |
---|
13 | <p><center><img src="classOgre_1_1KeyEvent.png" usemap="#Ogre::KeyEvent_map" border="0" alt=""></center> |
---|
14 | <map name="Ogre::KeyEvent_map"> |
---|
15 | <area href="classOgre_1_1InputEvent.html" alt="Ogre::InputEvent" shape="rect" coords="0,0,106,24"> |
---|
16 | </map> |
---|
17 | <a href="classOgre_1_1KeyEvent-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0> |
---|
18 | <tr><td></td></tr> |
---|
19 | <tr><td colspan=2><br><h2>Public Types</h2></td></tr> |
---|
20 | <tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw7Ogre_1_1KeyEventw0">KE_FIRST_EVENT</a> = 2500, |
---|
21 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw7Ogre_1_1KeyEventw1">KE_LAST_EVENT</a> = 2504 |
---|
22 | }</td></tr> |
---|
23 | |
---|
24 | <tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <br> |
---|
25 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw8Ogre_1_1KeyEventw2">KE_KEY_CLICKED</a> = KE_FIRST_EVENT, |
---|
26 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw8Ogre_1_1KeyEventw3">KE_KEY_PRESSED</a>, |
---|
27 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw8Ogre_1_1KeyEventw4">KE_KEY_RELEASED</a>, |
---|
28 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw8Ogre_1_1KeyEventw5">KE_KEY_FOCUSIN</a>, |
---|
29 | <br> |
---|
30 | <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventw8Ogre_1_1KeyEventw6">KE_KEY_FOCUSOUT</a> |
---|
31 | <br> |
---|
32 | }</td></tr> |
---|
33 | |
---|
34 | <tr><td class="memItemLeft" nowrap align=right valign=top>enum </td><td class="memItemRight" valign=bottom>{ <br> |
---|
35 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15">SHIFT_MASK</a> = 1 << 0, |
---|
36 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16">CTRL_MASK</a> = 1 << 1, |
---|
37 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17">META_MASK</a> = 1 << 2, |
---|
38 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18">ALT_MASK</a> = 1 << 3, |
---|
39 | <br> |
---|
40 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19">BUTTON0_MASK</a> = 1 << 4, |
---|
41 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20">BUTTON1_MASK</a> = 1 << 5, |
---|
42 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21">BUTTON2_MASK</a> = 1 << 6, |
---|
43 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22">BUTTON3_MASK</a> = 1 << 7, |
---|
44 | <br> |
---|
45 | <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventw24Ogre_1_1MouseEventw23">BUTTON_ANY_MASK</a> = 0xF << 4 |
---|
46 | <br> |
---|
47 | }</td></tr> |
---|
48 | |
---|
49 | <tr><td colspan=2><br><h2>Public Member Functions</h2></td></tr> |
---|
50 | <tr><td class="memItemLeft" nowrap align=right valign=top> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventa0">KeyEvent</a> (<a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> *source, int id, int key, <a class="el" href="namespaceOgre.html#a465">Real</a> when, int modifiers)</td></tr> |
---|
51 | |
---|
52 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Constructs a <a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> object with the specified source <a class="el" href="classOgre_1_1KeyTarget.html">KeyTarget</a>, type, modifiers, coordinates, and click count. <a href="#Ogre_1_1KeyEventa0"></a><br><br></td></tr> |
---|
53 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a471">String</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventa1">paramString</a> () const </td></tr> |
---|
54 | |
---|
55 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns a parameter string identifying this event. <a href="#Ogre_1_1KeyEventa1"></a><br><br></td></tr> |
---|
56 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventa2">getKey</a> ()</td></tr> |
---|
57 | |
---|
58 | <tr><td class="mdescLeft"> </td><td class="mdescRight">return the ID of the button <a href="#Ogre_1_1KeyEventa2"></a><br><br></td></tr> |
---|
59 | <tr><td class="memItemLeft" nowrap align=right valign=top>char </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventa3">getKeyChar</a> ()</td></tr> |
---|
60 | |
---|
61 | <tr><td class="mdescLeft"> </td><td class="mdescRight">return the char of the button <a href="#Ogre_1_1KeyEventa3"></a><br><br></td></tr> |
---|
62 | <tr><td class="memItemLeft" nowrap align=right valign=top>void </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa12">consume</a> ()</td></tr> |
---|
63 | |
---|
64 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Consumes this event so that it will not be processed in the default manner by the source which originated it. <a href="#Ogre_1_1MouseEventa12"></a><br><br></td></tr> |
---|
65 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa13">getModifiers</a> () const </td></tr> |
---|
66 | |
---|
67 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the modifiers flag for this event. <a href="#Ogre_1_1MouseEventa13"></a><br><br></td></tr> |
---|
68 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa14">getWhen</a> () const </td></tr> |
---|
69 | |
---|
70 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns the timestamp of when this event occurred. <a href="#Ogre_1_1MouseEventa14"></a><br><br></td></tr> |
---|
71 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa15">isAltDown</a> () const </td></tr> |
---|
72 | |
---|
73 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the Alt modifier is down on this event. <a href="#Ogre_1_1MouseEventa15"></a><br><br></td></tr> |
---|
74 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa16">isConsumed</a> () const </td></tr> |
---|
75 | |
---|
76 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not this event has been consumed. <a href="#Ogre_1_1MouseEventa16"></a><br><br></td></tr> |
---|
77 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa17">isControlDown</a> () const </td></tr> |
---|
78 | |
---|
79 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the Control modifier is down on this event. <a href="#Ogre_1_1MouseEventa17"></a><br><br></td></tr> |
---|
80 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa18">isMetaDown</a> () const </td></tr> |
---|
81 | |
---|
82 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the Meta modifier is down on this event. <a href="#Ogre_1_1MouseEventa18"></a><br><br></td></tr> |
---|
83 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa19">isShiftDown</a> () const </td></tr> |
---|
84 | |
---|
85 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Returns whether or not the Shift modifier is down on this event. <a href="#Ogre_1_1MouseEventa19"></a><br><br></td></tr> |
---|
86 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa20">isEventBetween</a> (int start, int end) const </td></tr> |
---|
87 | |
---|
88 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa21">getID</a> () const </td></tr> |
---|
89 | |
---|
90 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa22">getSource</a> () const </td></tr> |
---|
91 | |
---|
92 | <tr><td colspan=2><br><h2>Protected Attributes</h2></td></tr> |
---|
93 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventp0">mKey</a></td></tr> |
---|
94 | |
---|
95 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Which key was pressed. <a href="#Ogre_1_1KeyEventp0"></a><br><br></td></tr> |
---|
96 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="namespaceOgre.html#a465">Real</a> </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">mWhen</a></td></tr> |
---|
97 | |
---|
98 | <tr><td class="mdescLeft"> </td><td class="mdescRight">Not implemented yet. <a href="#Ogre_1_1MouseEventp8"></a><br><br></td></tr> |
---|
99 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">mModifiers</a></td></tr> |
---|
100 | |
---|
101 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The state of the modifier keys at the time the input event was fired. <a href="#Ogre_1_1MouseEventp9"></a><br><br></td></tr> |
---|
102 | <tr><td class="memItemLeft" nowrap align=right valign=top><a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a> * </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp10">mSource</a></td></tr> |
---|
103 | |
---|
104 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The target to process the event. <a href="#Ogre_1_1MouseEventp10"></a><br><br></td></tr> |
---|
105 | <tr><td class="memItemLeft" nowrap align=right valign=top>int </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">mId</a></td></tr> |
---|
106 | |
---|
107 | <tr><td class="mdescLeft"> </td><td class="mdescRight">The ID of the event. <a href="#Ogre_1_1MouseEventp11"></a><br><br></td></tr> |
---|
108 | <tr><td class="memItemLeft" nowrap align=right valign=top>bool </td><td class="memItemRight" valign=bottom><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">mConsumed</a></td></tr> |
---|
109 | |
---|
110 | <tr><td class="mdescLeft"> </td><td class="mdescRight">whether the event has been consumed <a href="#Ogre_1_1MouseEventp12"></a><br><br></td></tr> |
---|
111 | </table> |
---|
112 | <hr><a name="_details"></a><h2>Detailed Description</h2> |
---|
113 | <dl compact><dt><b>Version:</b></dt><dd>1.22 04/22/99 </dd></dl> |
---|
114 | <dl compact><dt><b>Author:</b></dt><dd>Carl Quinn </dd></dl> |
---|
115 | |
---|
116 | <p> |
---|
117 | |
---|
118 | <p> |
---|
119 | Definition at line <a class="el" href="OgreKeyEvent_8h-source.html#l00045">45</a> of file <a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a>.<hr><h2>Member Enumeration Documentation</h2> |
---|
120 | <a class="anchor" name="Ogre_1_1MouseEventw24" doxytag="Ogre::KeyEvent::@7" ></a><p> |
---|
121 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
122 | <tr> |
---|
123 | <td class="mdRow"> |
---|
124 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
125 | <tr> |
---|
126 | <td class="md" nowrap valign="top"> anonymous enum<code> [inherited]</code> |
---|
127 | </table> |
---|
128 | </td> |
---|
129 | </tr> |
---|
130 | </table> |
---|
131 | <table cellspacing=5 cellpadding=0 border=0> |
---|
132 | <tr> |
---|
133 | <td> |
---|
134 | |
---|
135 | </td> |
---|
136 | <td> |
---|
137 | |
---|
138 | <p> |
---|
139 | <dl compact><dt><b>Enumeration values: </b></dt><dd> |
---|
140 | <table border=0 cellspacing=2 cellpadding=0> |
---|
141 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw15" doxytag="SHIFT_MASK" ></a>SHIFT_MASK</em> </td><td> |
---|
142 | This flag indicates that the Shift key was down when the event occurred. |
---|
143 | <p> |
---|
144 | </td></tr> |
---|
145 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw16" doxytag="CTRL_MASK" ></a>CTRL_MASK</em> </td><td> |
---|
146 | This flag indicates that the Control key was down when the event occurred. |
---|
147 | <p> |
---|
148 | </td></tr> |
---|
149 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw17" doxytag="META_MASK" ></a>META_MASK</em> </td><td> |
---|
150 | This flag indicates that the Meta key was down when the event occurred. |
---|
151 | <p> |
---|
152 | For mouse events, this flag indicates that the right button was pressed or released.</td></tr> |
---|
153 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw18" doxytag="ALT_MASK" ></a>ALT_MASK</em> </td><td> |
---|
154 | This flag indicates that the Alt key was down when the event occurred. |
---|
155 | <p> |
---|
156 | For mouse events, this flag indicates that the middle mouse button was pressed or released.</td></tr> |
---|
157 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw19" doxytag="BUTTON0_MASK" ></a>BUTTON0_MASK</em> </td><td> |
---|
158 | </td></tr> |
---|
159 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw20" doxytag="BUTTON1_MASK" ></a>BUTTON1_MASK</em> </td><td> |
---|
160 | </td></tr> |
---|
161 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw21" doxytag="BUTTON2_MASK" ></a>BUTTON2_MASK</em> </td><td> |
---|
162 | </td></tr> |
---|
163 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw22" doxytag="BUTTON3_MASK" ></a>BUTTON3_MASK</em> </td><td> |
---|
164 | </td></tr> |
---|
165 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1MouseEventw24Ogre_1_1MouseEventw23" doxytag="BUTTON_ANY_MASK" ></a>BUTTON_ANY_MASK</em> </td><td> |
---|
166 | </td></tr> |
---|
167 | </table> |
---|
168 | </dl> |
---|
169 | |
---|
170 | <p> |
---|
171 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00093">93</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
172 | </tr> |
---|
173 | </table> |
---|
174 | <a class="anchor" name="Ogre_1_1KeyEventw7" doxytag="Ogre::KeyEvent::@8" ></a><p> |
---|
175 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
176 | <tr> |
---|
177 | <td class="mdRow"> |
---|
178 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
179 | <tr> |
---|
180 | <td class="md" nowrap valign="top"> anonymous enum |
---|
181 | </table> |
---|
182 | </td> |
---|
183 | </tr> |
---|
184 | </table> |
---|
185 | <table cellspacing=5 cellpadding=0 border=0> |
---|
186 | <tr> |
---|
187 | <td> |
---|
188 | |
---|
189 | </td> |
---|
190 | <td> |
---|
191 | |
---|
192 | <p> |
---|
193 | <dl compact><dt><b>Enumeration values: </b></dt><dd> |
---|
194 | <table border=0 cellspacing=2 cellpadding=0> |
---|
195 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw7Ogre_1_1KeyEventw0" doxytag="KE_FIRST_EVENT" ></a>KE_FIRST_EVENT</em> </td><td> |
---|
196 | </td></tr> |
---|
197 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw7Ogre_1_1KeyEventw1" doxytag="KE_LAST_EVENT" ></a>KE_LAST_EVENT</em> </td><td> |
---|
198 | </td></tr> |
---|
199 | </table> |
---|
200 | </dl> |
---|
201 | |
---|
202 | <p> |
---|
203 | Definition at line <a class="el" href="OgreKeyEvent_8h-source.html#l00057">57</a> of file <a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a>. </td> |
---|
204 | </tr> |
---|
205 | </table> |
---|
206 | <a class="anchor" name="Ogre_1_1KeyEventw8" doxytag="Ogre::KeyEvent::@9" ></a><p> |
---|
207 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
208 | <tr> |
---|
209 | <td class="mdRow"> |
---|
210 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
211 | <tr> |
---|
212 | <td class="md" nowrap valign="top"> anonymous enum |
---|
213 | </table> |
---|
214 | </td> |
---|
215 | </tr> |
---|
216 | </table> |
---|
217 | <table cellspacing=5 cellpadding=0 border=0> |
---|
218 | <tr> |
---|
219 | <td> |
---|
220 | |
---|
221 | </td> |
---|
222 | <td> |
---|
223 | |
---|
224 | <p> |
---|
225 | <dl compact><dt><b>Enumeration values: </b></dt><dd> |
---|
226 | <table border=0 cellspacing=2 cellpadding=0> |
---|
227 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw8Ogre_1_1KeyEventw2" doxytag="KE_KEY_CLICKED" ></a>KE_KEY_CLICKED</em> </td><td> |
---|
228 | </td></tr> |
---|
229 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw8Ogre_1_1KeyEventw3" doxytag="KE_KEY_PRESSED" ></a>KE_KEY_PRESSED</em> </td><td> |
---|
230 | </td></tr> |
---|
231 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw8Ogre_1_1KeyEventw4" doxytag="KE_KEY_RELEASED" ></a>KE_KEY_RELEASED</em> </td><td> |
---|
232 | </td></tr> |
---|
233 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw8Ogre_1_1KeyEventw5" doxytag="KE_KEY_FOCUSIN" ></a>KE_KEY_FOCUSIN</em> </td><td> |
---|
234 | </td></tr> |
---|
235 | <tr><td valign=top><em><a class="anchor" name="Ogre_1_1KeyEventw8Ogre_1_1KeyEventw6" doxytag="KE_KEY_FOCUSOUT" ></a>KE_KEY_FOCUSOUT</em> </td><td> |
---|
236 | </td></tr> |
---|
237 | </table> |
---|
238 | </dl> |
---|
239 | |
---|
240 | <p> |
---|
241 | Definition at line <a class="el" href="OgreKeyEvent_8h-source.html#l00063">63</a> of file <a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a>. </td> |
---|
242 | </tr> |
---|
243 | </table> |
---|
244 | <hr><h2>Constructor & Destructor Documentation</h2> |
---|
245 | <a class="anchor" name="Ogre_1_1KeyEventa0" doxytag="Ogre::KeyEvent::KeyEvent" ></a><p> |
---|
246 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
247 | <tr> |
---|
248 | <td class="mdRow"> |
---|
249 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
250 | <tr> |
---|
251 | <td class="md" nowrap valign="top"> Ogre::KeyEvent::KeyEvent </td> |
---|
252 | <td class="md" valign="top">( </td> |
---|
253 | <td class="md" nowrap valign="top"><a class="el" href="classOgre_1_1PositionTarget.html">PositionTarget</a> * </td> |
---|
254 | <td class="mdname" nowrap> <em>source</em>, </td> |
---|
255 | </tr> |
---|
256 | <tr> |
---|
257 | <td class="md" nowrap align="right"></td> |
---|
258 | <td></td> |
---|
259 | <td class="md" nowrap>int </td> |
---|
260 | <td class="mdname" nowrap> <em>id</em>, </td> |
---|
261 | </tr> |
---|
262 | <tr> |
---|
263 | <td class="md" nowrap align="right"></td> |
---|
264 | <td></td> |
---|
265 | <td class="md" nowrap>int </td> |
---|
266 | <td class="mdname" nowrap> <em>key</em>, </td> |
---|
267 | </tr> |
---|
268 | <tr> |
---|
269 | <td class="md" nowrap align="right"></td> |
---|
270 | <td></td> |
---|
271 | <td class="md" nowrap><a class="el" href="namespaceOgre.html#a465">Real</a> </td> |
---|
272 | <td class="mdname" nowrap> <em>when</em>, </td> |
---|
273 | </tr> |
---|
274 | <tr> |
---|
275 | <td class="md" nowrap align="right"></td> |
---|
276 | <td></td> |
---|
277 | <td class="md" nowrap>int </td> |
---|
278 | <td class="mdname" nowrap> <em>modifiers</em></td> |
---|
279 | </tr> |
---|
280 | <tr> |
---|
281 | <td></td> |
---|
282 | <td class="md">) </td> |
---|
283 | <td class="md" colspan="2"></td> |
---|
284 | </tr> |
---|
285 | |
---|
286 | </table> |
---|
287 | </td> |
---|
288 | </tr> |
---|
289 | </table> |
---|
290 | <table cellspacing=5 cellpadding=0 border=0> |
---|
291 | <tr> |
---|
292 | <td> |
---|
293 | |
---|
294 | </td> |
---|
295 | <td> |
---|
296 | |
---|
297 | <p> |
---|
298 | Constructs a <a class="el" href="classOgre_1_1KeyEvent.html">KeyEvent</a> object with the specified source <a class="el" href="classOgre_1_1KeyTarget.html">KeyTarget</a>, type, modifiers, coordinates, and click count. |
---|
299 | <p> |
---|
300 | <dl compact><dt><b>Parameters:</b></dt><dd> |
---|
301 | <table border="0" cellspacing="2" cellpadding="0"> |
---|
302 | <tr><td valign=top><em>source</em> </td><td>the <a class="el" href="classOgre_1_1KeyTarget.html">KeyTarget</a> that originated the event </td></tr> |
---|
303 | <tr><td valign=top><em>id</em> </td><td>the integer that identifies the event </td></tr> |
---|
304 | <tr><td valign=top><em>when</em> </td><td>a long int that gives the time the event occurred </td></tr> |
---|
305 | <tr><td valign=top><em>modifiers</em> </td><td>the modifier keys down during event (shift, ctrl, alt, meta) </td></tr> |
---|
306 | <tr><td valign=top><em>x</em> </td><td>the horizontal x coordinate for the key location </td></tr> |
---|
307 | <tr><td valign=top><em>y</em> </td><td>the vertical y coordinate for the key location </td></tr> |
---|
308 | <tr><td valign=top><em>clickCount</em> </td><td>the number of key clicks associated with event</td></tr> |
---|
309 | </table> |
---|
310 | </dl> |
---|
311 | </td> |
---|
312 | </tr> |
---|
313 | </table> |
---|
314 | <hr><h2>Member Function Documentation</h2> |
---|
315 | <a class="anchor" name="Ogre_1_1MouseEventa12" doxytag="Ogre::KeyEvent::consume" ></a><p> |
---|
316 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
317 | <tr> |
---|
318 | <td class="mdRow"> |
---|
319 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
320 | <tr> |
---|
321 | <td class="md" nowrap valign="top"> void Ogre::InputEvent::consume </td> |
---|
322 | <td class="md" valign="top">( </td> |
---|
323 | <td class="mdname1" valign="top" nowrap> </td> |
---|
324 | <td class="md" valign="top"> ) </td> |
---|
325 | <td class="md" nowrap><code> [inherited]</code></td> |
---|
326 | </tr> |
---|
327 | |
---|
328 | </table> |
---|
329 | </td> |
---|
330 | </tr> |
---|
331 | </table> |
---|
332 | <table cellspacing=5 cellpadding=0 border=0> |
---|
333 | <tr> |
---|
334 | <td> |
---|
335 | |
---|
336 | </td> |
---|
337 | <td> |
---|
338 | |
---|
339 | <p> |
---|
340 | Consumes this event so that it will not be processed in the default manner by the source which originated it. |
---|
341 | <p> |
---|
342 | </td> |
---|
343 | </tr> |
---|
344 | </table> |
---|
345 | <a class="anchor" name="Ogre_1_1MouseEventa21" doxytag="Ogre::KeyEvent::getID" ></a><p> |
---|
346 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
347 | <tr> |
---|
348 | <td class="mdRow"> |
---|
349 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
350 | <tr> |
---|
351 | <td class="md" nowrap valign="top"> int Ogre::InputEvent::getID </td> |
---|
352 | <td class="md" valign="top">( </td> |
---|
353 | <td class="mdname1" valign="top" nowrap> </td> |
---|
354 | <td class="md" valign="top"> ) </td> |
---|
355 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
356 | </tr> |
---|
357 | |
---|
358 | </table> |
---|
359 | </td> |
---|
360 | </tr> |
---|
361 | </table> |
---|
362 | <table cellspacing=5 cellpadding=0 border=0> |
---|
363 | <tr> |
---|
364 | <td> |
---|
365 | |
---|
366 | </td> |
---|
367 | <td> |
---|
368 | |
---|
369 | <p> |
---|
370 | </td> |
---|
371 | </tr> |
---|
372 | </table> |
---|
373 | <a class="anchor" name="Ogre_1_1KeyEventa2" doxytag="Ogre::KeyEvent::getKey" ></a><p> |
---|
374 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
375 | <tr> |
---|
376 | <td class="mdRow"> |
---|
377 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
378 | <tr> |
---|
379 | <td class="md" nowrap valign="top"> int Ogre::KeyEvent::getKey </td> |
---|
380 | <td class="md" valign="top">( </td> |
---|
381 | <td class="mdname1" valign="top" nowrap> </td> |
---|
382 | <td class="md" valign="top"> ) </td> |
---|
383 | <td class="md" nowrap></td> |
---|
384 | </tr> |
---|
385 | |
---|
386 | </table> |
---|
387 | </td> |
---|
388 | </tr> |
---|
389 | </table> |
---|
390 | <table cellspacing=5 cellpadding=0 border=0> |
---|
391 | <tr> |
---|
392 | <td> |
---|
393 | |
---|
394 | </td> |
---|
395 | <td> |
---|
396 | |
---|
397 | <p> |
---|
398 | return the ID of the button |
---|
399 | <p> |
---|
400 | </td> |
---|
401 | </tr> |
---|
402 | </table> |
---|
403 | <a class="anchor" name="Ogre_1_1KeyEventa3" doxytag="Ogre::KeyEvent::getKeyChar" ></a><p> |
---|
404 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
405 | <tr> |
---|
406 | <td class="mdRow"> |
---|
407 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
408 | <tr> |
---|
409 | <td class="md" nowrap valign="top"> char Ogre::KeyEvent::getKeyChar </td> |
---|
410 | <td class="md" valign="top">( </td> |
---|
411 | <td class="mdname1" valign="top" nowrap> </td> |
---|
412 | <td class="md" valign="top"> ) </td> |
---|
413 | <td class="md" nowrap></td> |
---|
414 | </tr> |
---|
415 | |
---|
416 | </table> |
---|
417 | </td> |
---|
418 | </tr> |
---|
419 | </table> |
---|
420 | <table cellspacing=5 cellpadding=0 border=0> |
---|
421 | <tr> |
---|
422 | <td> |
---|
423 | |
---|
424 | </td> |
---|
425 | <td> |
---|
426 | |
---|
427 | <p> |
---|
428 | return the char of the button |
---|
429 | <p> |
---|
430 | </td> |
---|
431 | </tr> |
---|
432 | </table> |
---|
433 | <a class="anchor" name="Ogre_1_1MouseEventa13" doxytag="Ogre::KeyEvent::getModifiers" ></a><p> |
---|
434 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
435 | <tr> |
---|
436 | <td class="mdRow"> |
---|
437 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
438 | <tr> |
---|
439 | <td class="md" nowrap valign="top"> int Ogre::InputEvent::getModifiers </td> |
---|
440 | <td class="md" valign="top">( </td> |
---|
441 | <td class="mdname1" valign="top" nowrap> </td> |
---|
442 | <td class="md" valign="top"> ) </td> |
---|
443 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
444 | </tr> |
---|
445 | |
---|
446 | </table> |
---|
447 | </td> |
---|
448 | </tr> |
---|
449 | </table> |
---|
450 | <table cellspacing=5 cellpadding=0 border=0> |
---|
451 | <tr> |
---|
452 | <td> |
---|
453 | |
---|
454 | </td> |
---|
455 | <td> |
---|
456 | |
---|
457 | <p> |
---|
458 | Returns the modifiers flag for this event. |
---|
459 | <p> |
---|
460 | </td> |
---|
461 | </tr> |
---|
462 | </table> |
---|
463 | <a class="anchor" name="Ogre_1_1MouseEventa22" doxytag="Ogre::KeyEvent::getSource" ></a><p> |
---|
464 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
465 | <tr> |
---|
466 | <td class="mdRow"> |
---|
467 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
468 | <tr> |
---|
469 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* Ogre::InputEvent::getSource </td> |
---|
470 | <td class="md" valign="top">( </td> |
---|
471 | <td class="mdname1" valign="top" nowrap> </td> |
---|
472 | <td class="md" valign="top"> ) </td> |
---|
473 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
474 | </tr> |
---|
475 | |
---|
476 | </table> |
---|
477 | </td> |
---|
478 | </tr> |
---|
479 | </table> |
---|
480 | <table cellspacing=5 cellpadding=0 border=0> |
---|
481 | <tr> |
---|
482 | <td> |
---|
483 | |
---|
484 | </td> |
---|
485 | <td> |
---|
486 | |
---|
487 | <p> |
---|
488 | </td> |
---|
489 | </tr> |
---|
490 | </table> |
---|
491 | <a class="anchor" name="Ogre_1_1MouseEventa14" doxytag="Ogre::KeyEvent::getWhen" ></a><p> |
---|
492 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
493 | <tr> |
---|
494 | <td class="mdRow"> |
---|
495 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
496 | <tr> |
---|
497 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> Ogre::InputEvent::getWhen </td> |
---|
498 | <td class="md" valign="top">( </td> |
---|
499 | <td class="mdname1" valign="top" nowrap> </td> |
---|
500 | <td class="md" valign="top"> ) </td> |
---|
501 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
502 | </tr> |
---|
503 | |
---|
504 | </table> |
---|
505 | </td> |
---|
506 | </tr> |
---|
507 | </table> |
---|
508 | <table cellspacing=5 cellpadding=0 border=0> |
---|
509 | <tr> |
---|
510 | <td> |
---|
511 | |
---|
512 | </td> |
---|
513 | <td> |
---|
514 | |
---|
515 | <p> |
---|
516 | Returns the timestamp of when this event occurred. |
---|
517 | <p> |
---|
518 | Not implemented yet </td> |
---|
519 | </tr> |
---|
520 | </table> |
---|
521 | <a class="anchor" name="Ogre_1_1MouseEventa15" doxytag="Ogre::KeyEvent::isAltDown" ></a><p> |
---|
522 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
523 | <tr> |
---|
524 | <td class="mdRow"> |
---|
525 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
526 | <tr> |
---|
527 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isAltDown </td> |
---|
528 | <td class="md" valign="top">( </td> |
---|
529 | <td class="mdname1" valign="top" nowrap> </td> |
---|
530 | <td class="md" valign="top"> ) </td> |
---|
531 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
532 | </tr> |
---|
533 | |
---|
534 | </table> |
---|
535 | </td> |
---|
536 | </tr> |
---|
537 | </table> |
---|
538 | <table cellspacing=5 cellpadding=0 border=0> |
---|
539 | <tr> |
---|
540 | <td> |
---|
541 | |
---|
542 | </td> |
---|
543 | <td> |
---|
544 | |
---|
545 | <p> |
---|
546 | Returns whether or not the Alt modifier is down on this event. |
---|
547 | <p> |
---|
548 | </td> |
---|
549 | </tr> |
---|
550 | </table> |
---|
551 | <a class="anchor" name="Ogre_1_1MouseEventa16" doxytag="Ogre::KeyEvent::isConsumed" ></a><p> |
---|
552 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
553 | <tr> |
---|
554 | <td class="mdRow"> |
---|
555 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
556 | <tr> |
---|
557 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isConsumed </td> |
---|
558 | <td class="md" valign="top">( </td> |
---|
559 | <td class="mdname1" valign="top" nowrap> </td> |
---|
560 | <td class="md" valign="top"> ) </td> |
---|
561 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
562 | </tr> |
---|
563 | |
---|
564 | </table> |
---|
565 | </td> |
---|
566 | </tr> |
---|
567 | </table> |
---|
568 | <table cellspacing=5 cellpadding=0 border=0> |
---|
569 | <tr> |
---|
570 | <td> |
---|
571 | |
---|
572 | </td> |
---|
573 | <td> |
---|
574 | |
---|
575 | <p> |
---|
576 | Returns whether or not this event has been consumed. |
---|
577 | <p> |
---|
578 | <dl compact><dt><b>See also:</b></dt><dd><a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventa12">consume</a></dd></dl> |
---|
579 | </td> |
---|
580 | </tr> |
---|
581 | </table> |
---|
582 | <a class="anchor" name="Ogre_1_1MouseEventa17" doxytag="Ogre::KeyEvent::isControlDown" ></a><p> |
---|
583 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
584 | <tr> |
---|
585 | <td class="mdRow"> |
---|
586 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
587 | <tr> |
---|
588 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isControlDown </td> |
---|
589 | <td class="md" valign="top">( </td> |
---|
590 | <td class="mdname1" valign="top" nowrap> </td> |
---|
591 | <td class="md" valign="top"> ) </td> |
---|
592 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
593 | </tr> |
---|
594 | |
---|
595 | </table> |
---|
596 | </td> |
---|
597 | </tr> |
---|
598 | </table> |
---|
599 | <table cellspacing=5 cellpadding=0 border=0> |
---|
600 | <tr> |
---|
601 | <td> |
---|
602 | |
---|
603 | </td> |
---|
604 | <td> |
---|
605 | |
---|
606 | <p> |
---|
607 | Returns whether or not the Control modifier is down on this event. |
---|
608 | <p> |
---|
609 | </td> |
---|
610 | </tr> |
---|
611 | </table> |
---|
612 | <a class="anchor" name="Ogre_1_1MouseEventa20" doxytag="Ogre::KeyEvent::isEventBetween" ></a><p> |
---|
613 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
614 | <tr> |
---|
615 | <td class="mdRow"> |
---|
616 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
617 | <tr> |
---|
618 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isEventBetween </td> |
---|
619 | <td class="md" valign="top">( </td> |
---|
620 | <td class="md" nowrap valign="top">int </td> |
---|
621 | <td class="mdname" nowrap> <em>start</em>, </td> |
---|
622 | </tr> |
---|
623 | <tr> |
---|
624 | <td class="md" nowrap align="right"></td> |
---|
625 | <td></td> |
---|
626 | <td class="md" nowrap>int </td> |
---|
627 | <td class="mdname" nowrap> <em>end</em></td> |
---|
628 | </tr> |
---|
629 | <tr> |
---|
630 | <td></td> |
---|
631 | <td class="md">) </td> |
---|
632 | <td class="md" colspan="2"> const<code> [inherited]</code></td> |
---|
633 | </tr> |
---|
634 | |
---|
635 | </table> |
---|
636 | </td> |
---|
637 | </tr> |
---|
638 | </table> |
---|
639 | <table cellspacing=5 cellpadding=0 border=0> |
---|
640 | <tr> |
---|
641 | <td> |
---|
642 | |
---|
643 | </td> |
---|
644 | <td> |
---|
645 | |
---|
646 | <p> |
---|
647 | </td> |
---|
648 | </tr> |
---|
649 | </table> |
---|
650 | <a class="anchor" name="Ogre_1_1MouseEventa18" doxytag="Ogre::KeyEvent::isMetaDown" ></a><p> |
---|
651 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
652 | <tr> |
---|
653 | <td class="mdRow"> |
---|
654 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
655 | <tr> |
---|
656 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isMetaDown </td> |
---|
657 | <td class="md" valign="top">( </td> |
---|
658 | <td class="mdname1" valign="top" nowrap> </td> |
---|
659 | <td class="md" valign="top"> ) </td> |
---|
660 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
661 | </tr> |
---|
662 | |
---|
663 | </table> |
---|
664 | </td> |
---|
665 | </tr> |
---|
666 | </table> |
---|
667 | <table cellspacing=5 cellpadding=0 border=0> |
---|
668 | <tr> |
---|
669 | <td> |
---|
670 | |
---|
671 | </td> |
---|
672 | <td> |
---|
673 | |
---|
674 | <p> |
---|
675 | Returns whether or not the Meta modifier is down on this event. |
---|
676 | <p> |
---|
677 | </td> |
---|
678 | </tr> |
---|
679 | </table> |
---|
680 | <a class="anchor" name="Ogre_1_1MouseEventa19" doxytag="Ogre::KeyEvent::isShiftDown" ></a><p> |
---|
681 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
682 | <tr> |
---|
683 | <td class="mdRow"> |
---|
684 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
685 | <tr> |
---|
686 | <td class="md" nowrap valign="top"> bool Ogre::InputEvent::isShiftDown </td> |
---|
687 | <td class="md" valign="top">( </td> |
---|
688 | <td class="mdname1" valign="top" nowrap> </td> |
---|
689 | <td class="md" valign="top"> ) </td> |
---|
690 | <td class="md" nowrap> const<code> [inherited]</code></td> |
---|
691 | </tr> |
---|
692 | |
---|
693 | </table> |
---|
694 | </td> |
---|
695 | </tr> |
---|
696 | </table> |
---|
697 | <table cellspacing=5 cellpadding=0 border=0> |
---|
698 | <tr> |
---|
699 | <td> |
---|
700 | |
---|
701 | </td> |
---|
702 | <td> |
---|
703 | |
---|
704 | <p> |
---|
705 | Returns whether or not the Shift modifier is down on this event. |
---|
706 | <p> |
---|
707 | </td> |
---|
708 | </tr> |
---|
709 | </table> |
---|
710 | <a class="anchor" name="Ogre_1_1KeyEventa1" doxytag="Ogre::KeyEvent::paramString" ></a><p> |
---|
711 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
712 | <tr> |
---|
713 | <td class="mdRow"> |
---|
714 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
715 | <tr> |
---|
716 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a471">String</a> Ogre::KeyEvent::paramString </td> |
---|
717 | <td class="md" valign="top">( </td> |
---|
718 | <td class="mdname1" valign="top" nowrap> </td> |
---|
719 | <td class="md" valign="top"> ) </td> |
---|
720 | <td class="md" nowrap> const</td> |
---|
721 | </tr> |
---|
722 | |
---|
723 | </table> |
---|
724 | </td> |
---|
725 | </tr> |
---|
726 | </table> |
---|
727 | <table cellspacing=5 cellpadding=0 border=0> |
---|
728 | <tr> |
---|
729 | <td> |
---|
730 | |
---|
731 | </td> |
---|
732 | <td> |
---|
733 | |
---|
734 | <p> |
---|
735 | Returns a parameter string identifying this event. |
---|
736 | <p> |
---|
737 | This method is useful for event-logging and for debugging.<p> |
---|
738 | <dl compact><dt><b>Returns:</b></dt><dd>a string identifying the event and its attributes</dd></dl> |
---|
739 | </td> |
---|
740 | </tr> |
---|
741 | </table> |
---|
742 | <hr><h2>Member Data Documentation</h2> |
---|
743 | <a class="anchor" name="Ogre_1_1MouseEventp12" doxytag="Ogre::KeyEvent::mConsumed" ></a><p> |
---|
744 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
745 | <tr> |
---|
746 | <td class="mdRow"> |
---|
747 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
748 | <tr> |
---|
749 | <td class="md" nowrap valign="top"> bool <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp12">Ogre::InputEvent::mConsumed</a><code> [protected, inherited]</code> |
---|
750 | </table> |
---|
751 | </td> |
---|
752 | </tr> |
---|
753 | </table> |
---|
754 | <table cellspacing=5 cellpadding=0 border=0> |
---|
755 | <tr> |
---|
756 | <td> |
---|
757 | |
---|
758 | </td> |
---|
759 | <td> |
---|
760 | |
---|
761 | <p> |
---|
762 | whether the event has been consumed |
---|
763 | <p> |
---|
764 | |
---|
765 | <p> |
---|
766 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00088">88</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
767 | </tr> |
---|
768 | </table> |
---|
769 | <a class="anchor" name="Ogre_1_1MouseEventp11" doxytag="Ogre::KeyEvent::mId" ></a><p> |
---|
770 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
771 | <tr> |
---|
772 | <td class="mdRow"> |
---|
773 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
774 | <tr> |
---|
775 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp11">Ogre::InputEvent::mId</a><code> [protected, inherited]</code> |
---|
776 | </table> |
---|
777 | </td> |
---|
778 | </tr> |
---|
779 | </table> |
---|
780 | <table cellspacing=5 cellpadding=0 border=0> |
---|
781 | <tr> |
---|
782 | <td> |
---|
783 | |
---|
784 | </td> |
---|
785 | <td> |
---|
786 | |
---|
787 | <p> |
---|
788 | The ID of the event. |
---|
789 | <p> |
---|
790 | |
---|
791 | <p> |
---|
792 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00083">83</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
793 | </tr> |
---|
794 | </table> |
---|
795 | <a class="anchor" name="Ogre_1_1KeyEventp0" doxytag="Ogre::KeyEvent::mKey" ></a><p> |
---|
796 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
797 | <tr> |
---|
798 | <td class="mdRow"> |
---|
799 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
800 | <tr> |
---|
801 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1KeyEvent.html#Ogre_1_1KeyEventp0">Ogre::KeyEvent::mKey</a><code> [protected]</code> |
---|
802 | </table> |
---|
803 | </td> |
---|
804 | </tr> |
---|
805 | </table> |
---|
806 | <table cellspacing=5 cellpadding=0 border=0> |
---|
807 | <tr> |
---|
808 | <td> |
---|
809 | |
---|
810 | </td> |
---|
811 | <td> |
---|
812 | |
---|
813 | <p> |
---|
814 | Which key was pressed. |
---|
815 | <p> |
---|
816 | |
---|
817 | <p> |
---|
818 | Definition at line <a class="el" href="OgreKeyEvent_8h-source.html#l00053">53</a> of file <a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a>. </td> |
---|
819 | </tr> |
---|
820 | </table> |
---|
821 | <a class="anchor" name="Ogre_1_1MouseEventp9" doxytag="Ogre::KeyEvent::mModifiers" ></a><p> |
---|
822 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
823 | <tr> |
---|
824 | <td class="mdRow"> |
---|
825 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
826 | <tr> |
---|
827 | <td class="md" nowrap valign="top"> int <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp9">Ogre::InputEvent::mModifiers</a><code> [protected, inherited]</code> |
---|
828 | </table> |
---|
829 | </td> |
---|
830 | </tr> |
---|
831 | </table> |
---|
832 | <table cellspacing=5 cellpadding=0 border=0> |
---|
833 | <tr> |
---|
834 | <td> |
---|
835 | |
---|
836 | </td> |
---|
837 | <td> |
---|
838 | |
---|
839 | <p> |
---|
840 | The state of the modifier keys at the time the input event was fired. |
---|
841 | <p> |
---|
842 | |
---|
843 | <p> |
---|
844 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00072">72</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
845 | </tr> |
---|
846 | </table> |
---|
847 | <a class="anchor" name="Ogre_1_1MouseEventp10" doxytag="Ogre::KeyEvent::mSource" ></a><p> |
---|
848 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
849 | <tr> |
---|
850 | <td class="mdRow"> |
---|
851 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
852 | <tr> |
---|
853 | <td class="md" nowrap valign="top"> <a class="el" href="classOgre_1_1EventTarget.html">EventTarget</a>* <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp10">Ogre::InputEvent::mSource</a><code> [protected, inherited]</code> |
---|
854 | </table> |
---|
855 | </td> |
---|
856 | </tr> |
---|
857 | </table> |
---|
858 | <table cellspacing=5 cellpadding=0 border=0> |
---|
859 | <tr> |
---|
860 | <td> |
---|
861 | |
---|
862 | </td> |
---|
863 | <td> |
---|
864 | |
---|
865 | <p> |
---|
866 | The target to process the event. |
---|
867 | <p> |
---|
868 | This is ususally found by the dispatcher |
---|
869 | <p> |
---|
870 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00078">78</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
871 | </tr> |
---|
872 | </table> |
---|
873 | <a class="anchor" name="Ogre_1_1MouseEventp8" doxytag="Ogre::KeyEvent::mWhen" ></a><p> |
---|
874 | <table class="mdTable" width="100%" cellpadding="2" cellspacing="0"> |
---|
875 | <tr> |
---|
876 | <td class="mdRow"> |
---|
877 | <table cellpadding="0" cellspacing="0" border="0"> |
---|
878 | <tr> |
---|
879 | <td class="md" nowrap valign="top"> <a class="el" href="namespaceOgre.html#a465">Real</a> <a class="el" href="classOgre_1_1InputEvent.html#Ogre_1_1MouseEventp8">Ogre::InputEvent::mWhen</a><code> [protected, inherited]</code> |
---|
880 | </table> |
---|
881 | </td> |
---|
882 | </tr> |
---|
883 | </table> |
---|
884 | <table cellspacing=5 cellpadding=0 border=0> |
---|
885 | <tr> |
---|
886 | <td> |
---|
887 | |
---|
888 | </td> |
---|
889 | <td> |
---|
890 | |
---|
891 | <p> |
---|
892 | Not implemented yet. |
---|
893 | <p> |
---|
894 | |
---|
895 | <p> |
---|
896 | Definition at line <a class="el" href="OgreInputEvent_8h-source.html#l00067">67</a> of file <a class="el" href="OgreInputEvent_8h-source.html">OgreInputEvent.h</a>. </td> |
---|
897 | </tr> |
---|
898 | </table> |
---|
899 | <hr>The documentation for this class was generated from the following file:<ul> |
---|
900 | <li><a class="el" href="OgreKeyEvent_8h-source.html">OgreKeyEvent.h</a></ul> |
---|
901 | <hr> |
---|
902 | <p> |
---|
903 | Copyright © 2000-2005 by The OGRE Team<br /> |
---|
904 | <!--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/> |
---|
905 | 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/> |
---|
906 | <!--/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#"> |
---|
907 | <Work rdf:about=""> |
---|
908 | <license rdf:resource="http://creativecommons.org/licenses/by-sa/2.5/" /> |
---|
909 | <dc:type rdf:resource="http://purl.org/dc/dcmitype/Text" /> |
---|
910 | </Work> |
---|
911 | <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> --> |
---|
912 | |
---|
913 | Last modified Sun Mar 12 14:39:28 2006 |
---|
914 | </p> |
---|
915 | </body> |
---|
916 | </html> |
---|