#include <OgreKeyEvent.h>
Inheritance diagram for Ogre::KeyEvent:
Public Types | |
enum | { KE_FIRST_EVENT = 2500, KE_LAST_EVENT = 2504 } |
enum | { KE_KEY_CLICKED = KE_FIRST_EVENT, KE_KEY_PRESSED, KE_KEY_RELEASED, KE_KEY_FOCUSIN, KE_KEY_FOCUSOUT } |
enum | { SHIFT_MASK = 1 << 0, CTRL_MASK = 1 << 1, META_MASK = 1 << 2, ALT_MASK = 1 << 3, BUTTON0_MASK = 1 << 4, BUTTON1_MASK = 1 << 5, BUTTON2_MASK = 1 << 6, BUTTON3_MASK = 1 << 7, BUTTON_ANY_MASK = 0x1111 << 4 } |
Public Methods | |
KeyEvent (PositionTarget *source, int id, int key, Real when, int modifiers) | |
Constructs a KeyEvent object with the specified source KeyTarget, type, modifiers, coordinates, and click count. | |
String | paramString () const |
Returns a parameter string identifying this event. | |
int | getKey () |
return the ID of the button | |
char | getKeyChar () |
return the char of the button | |
void | consume () |
Consumes this event so that it will not be processed in the default manner by the source which originated it. | |
int | getModifiers () const |
Returns the modifiers flag for this event. | |
Real | getWhen () const |
Returns the timestamp of when this event occurred. | |
bool | isAltDown () const |
Returns whether or not the Alt modifier is down on this event. | |
bool | isConsumed () const |
Returns whether or not this event has been consumed. | |
bool | isControlDown () const |
Returns whether or not the Control modifier is down on this event. | |
bool | isMetaDown () const |
Returns whether or not the Meta modifier is down on this event. | |
bool | isShiftDown () const |
Returns whether or not the Shift modifier is down on this event. | |
bool | isEventBetween (int start, int end) const |
int | getID () const |
EventTarget * | getSource () const |
Protected Attributes | |
int | mKey |
Which key was pressed. | |
Real | mWhen |
Not implemented yet. | |
int | mModifiers |
The state of the modifier keys at the time the input event was fired. | |
EventTarget * | mSource |
The target to process the event. | |
int | mId |
The ID of the event. | |
bool | mConsumed |
whether the event has been consumed |
Definition at line 45 of file OgreKeyEvent.h.
|
Definition at line 93 of file OgreInputEvent.h. |
|
Definition at line 57 of file OgreKeyEvent.h. |
|
Definition at line 63 of file OgreKeyEvent.h. |
|
Constructs a KeyEvent object with the specified source KeyTarget, type, modifiers, coordinates, and click count.
Definition at line 35 of file OgreKeyEvent.cpp. References Ogre::Real. |
|
Consumes this event so that it will not be processed in the default manner by the source which originated it.
Definition at line 43 of file OgreInputEvent.cpp. References Ogre::InputEvent::mConsumed. Referenced by Ogre::EventDispatcher::retargetMouseEvent(). |
|
|
return the ID of the button
Definition at line 41 of file OgreKeyEvent.cpp. References mKey. Referenced by Ogre::TextBoxGuiElement::processEvent(). |
|
return the char of the button
Definition at line 48 of file OgreKeyEvent.cpp. References mKey, and Ogre::InputEvent::mModifiers. Referenced by Ogre::TextBoxGuiElement::processEvent(). |
|
Returns the modifiers flag for this event.
Definition at line 48 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. Referenced by Ogre::MouseEvent::paramString(), Ogre::EventDispatcher::retargetKeyEvent(), and Ogre::EventDispatcher::retargetMouseEvent(). |
|
Definition at line 95 of file OgreInputEvent.cpp. References Ogre::InputEvent::mSource. Referenced by Ogre::ScrollBarGuiElement::mousePressed(), and Ogre::ListGuiElement::mousePressed(). |
|
Returns the timestamp of when this event occurred. Not implemented yet Definition at line 53 of file OgreInputEvent.cpp. References Ogre::InputEvent::mWhen, and Ogre::Real. Referenced by Ogre::EventDispatcher::retargetKeyEvent(), and Ogre::EventDispatcher::retargetMouseEvent(). |
|
Returns whether or not the Alt modifier is down on this event.
Definition at line 58 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns whether or not this event has been consumed.
Definition at line 63 of file OgreInputEvent.cpp. References Ogre::InputEvent::mConsumed. Referenced by Ogre::TextBoxGuiElement::processEvent(), Ogre::ScrollBarGuiElement::processEvent(), Ogre::GuiElement::processEvent(), Ogre::GuiControl::processEvent(), Ogre::EventProcessor::processEvent(), Ogre::EventDispatcher::processKeyEvent(), and Ogre::EventDispatcher::processMouseEvent(). |
|
Returns whether or not the Control modifier is down on this event.
Definition at line 68 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Definition at line 83 of file OgreInputEvent.cpp. References Ogre::InputEvent::mId. Referenced by Ogre::EventDispatcher::dispatchEvent(). |
|
Returns whether or not the Meta modifier is down on this event.
Definition at line 73 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns whether or not the Shift modifier is down on this event.
Definition at line 78 of file OgreInputEvent.cpp. References Ogre::InputEvent::mModifiers. |
|
Returns a parameter string identifying this event. This method is useful for event-logging and for debugging.
Definition at line 59 of file OgreKeyEvent.cpp. References KE_KEY_CLICKED, KE_KEY_FOCUSIN, KE_KEY_FOCUSOUT, KE_KEY_PRESSED, KE_KEY_RELEASED, and mKey. |
|
whether the event has been consumed
Definition at line 88 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::consume(), Ogre::InputEvent::InputEvent(), and Ogre::InputEvent::isConsumed(). |
|
The ID of the event.
Definition at line 83 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getID(), and Ogre::InputEvent::isEventBetween(). |
|
Which key was pressed.
Definition at line 53 of file OgreKeyEvent.h. Referenced by getKey(), getKeyChar(), and paramString(). |
|
The state of the modifier keys at the time the input event was fired.
Definition at line 72 of file OgreInputEvent.h. Referenced by getKeyChar(), Ogre::InputEvent::getModifiers(), Ogre::InputEvent::isAltDown(), Ogre::InputEvent::isControlDown(), Ogre::InputEvent::isMetaDown(), and Ogre::InputEvent::isShiftDown(). |
|
The target to process the event. This is ususally found by the dispatcher Definition at line 78 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getSource(). |
|
Not implemented yet.
Definition at line 67 of file OgreInputEvent.h. Referenced by Ogre::InputEvent::getWhen(). |
Copyright © 2002-2003 by The OGRE Team
Last modified Wed Jan 21 00:17:58 2004