Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

Ogre::InputEvent Class Reference

The root event class for all GuiElement-level input events. More...

#include <OgreInputEvent.h>

Inheritance diagram for Ogre::InputEvent:

Ogre::KeyEvent Ogre::MouseEvent List of all members.

Public Types

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 = 0xF << 4
}

Public Member Functions

 InputEvent (EventTarget *source, int id, long when, int modifiers)
 Constructs an InputEvent object with the specified source GuiElement, modifiers, and type.

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

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

Detailed Description

The root event class for all GuiElement-level input events.

Remarks:
Input events are delivered to listeners before they are processed normally by the source where they originated. This allows listeners and GuiElement subclasses to "consume" the event so that the source will not process them in their default manner. For example, consuming mousePressed events on a Button GuiElement will prevent the Button from being activated.

Definition at line 60 of file OgreInputEvent.h.

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
SHIFT_MASK  This flag indicates that the Shift key was down when the event occurred.

CTRL_MASK  This flag indicates that the Control key was down when the event occurred.

META_MASK  This flag indicates that the Meta key was down when the event occurred.

For mouse events, this flag indicates that the right button was pressed or released.

ALT_MASK  This flag indicates that the Alt key was down when the event occurred.

For mouse events, this flag indicates that the middle mouse button was pressed or released.

BUTTON0_MASK 
BUTTON1_MASK 
BUTTON2_MASK 
BUTTON3_MASK 
BUTTON_ANY_MASK 

Definition at line 93 of file OgreInputEvent.h.

Constructor & Destructor Documentation

Ogre::InputEvent::InputEvent (  EventTarget *  source,
int  id,
long  when,
int  modifiers
) 
 

Constructs an InputEvent object with the specified source GuiElement, modifiers, and type.

Parameters:
source the object where the event originated the event type the time the event occurred the modifier keys down while event occurred

Member Function Documentation

void Ogre::InputEvent::consume (   ) 
 

Consumes this event so that it will not be processed in the default manner by the source which originated it.

int Ogre::InputEvent::getID (   )  const
 

int Ogre::InputEvent::getModifiers (   )  const
 

Returns the modifiers flag for this event.

EventTarget* Ogre::InputEvent::getSource (   )  const
 

Real Ogre::InputEvent::getWhen (   )  const
 

Returns the timestamp of when this event occurred.

Not implemented yet

bool Ogre::InputEvent::isAltDown (   )  const
 

Returns whether or not the Alt modifier is down on this event.

bool Ogre::InputEvent::isConsumed (   )  const
 

Returns whether or not this event has been consumed.

See also:
consume

bool Ogre::InputEvent::isControlDown (   )  const
 

Returns whether or not the Control modifier is down on this event.

bool Ogre::InputEvent::isEventBetween (  int  start,
int  end
)  const
 

bool Ogre::InputEvent::isMetaDown (   )  const
 

Returns whether or not the Meta modifier is down on this event.

bool Ogre::InputEvent::isShiftDown (   )  const
 

Returns whether or not the Shift modifier is down on this event.

Member Data Documentation

bool Ogre::InputEvent::mConsumed [protected]
 

whether the event has been consumed

Definition at line 88 of file OgreInputEvent.h.

int Ogre::InputEvent::mId [protected]
 

The ID of the event.

Definition at line 83 of file OgreInputEvent.h.

int Ogre::InputEvent::mModifiers [protected]
 

The state of the modifier keys at the time the input event was fired.

Definition at line 72 of file OgreInputEvent.h.

EventTarget* Ogre::InputEvent::mSource [protected]
 

The target to process the event.

This is ususally found by the dispatcher

Definition at line 78 of file OgreInputEvent.h.

Real Ogre::InputEvent::mWhen [protected]
 

Not implemented yet.

Definition at line 67 of file OgreInputEvent.h.

The documentation for this class was generated from the following file:

Copyright © 2000-2005 by The OGRE Team
Creative Commons License
This work is licensed under a Creative Commons Attribution-ShareAlike 2.5 License.
Last modified Sun Mar 12 14:39:26 2006