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

Ogre::InputReader Class Reference

Abstract class which allows input to be read from various controllers. More...

#include <OgreInput.h>

Inheritance diagram for Ogre::InputReader:

Ogre::GLXInput Ogre::SDLInput Ogre::Win32Input8 List of all members.

Public Member Functions

 InputReader ()
virtual ~InputReader ()
void useBufferedInput (EventQueue *pEventQueue, bool keys=true, bool mouse=true)
 Tells the reader to use buffered input and update the passed in queue.

virtual void setBufferedInput (bool keys, bool mouse)
virtual void initialise (RenderWindow *pWindow, bool useKeyboard=true, bool useMouse=true, bool useGameController=false)=0
 Initialise the input system.

virtual void capture ()=0
 Captures the state of all the input devices.

virtual bool isKeyDown (KeyCode kc) const
 Determines if the specified key is currently depressed.

virtual long getMouseRelativeX () const
 Retrieves the relative position of the mouse when capture was called relative to the last time.

virtual long getMouseRelativeY () const
 Retrieves the relative position of the mouse when capture was called relative to the last time.

virtual long getMouseRelativeZ () const
 Retrieves the relative position of the mouse when capture was called relative to the last time.

virtual long getMouseRelX () const=0
 Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis.

virtual long getMouseRelY () const=0
 Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis.

virtual long getMouseRelZ () const=0
 Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis.

virtual long getMouseAbsX () const=0
 Retrieves the absolute mouse position on the X (horizontal) axis.

virtual long getMouseAbsY () const=0
 Retrieves the absolute mouse position on the Y (vertical) axis.

virtual long getMouseAbsZ () const=0
 Retrieves the absolute mouse position on the Z (mouse wheel) axis.

virtual void getMouseState (MouseState &state) const=0
 Retrieves the current state of the mouse.

virtual bool getMouseButton (uchar button) const=0
 Retrieves the state of a mouse button.

void addCursorMoveListener (MouseMotionListener *c)
 Adds a mouse motion listener to the cursor object.

void removeCursorMoveListener (MouseMotionListener *c)
 Remove a mouse motion listener to the cursor object.


Static Public Member Functions

char getKeyChar (int keyCode, long modifiers=0)

Protected Types

typedef std::set< KeyCodeBufferedKeysDownSet
 Set of all the keys currently depressed based on buffered input events.


Protected Member Functions

void mouseMoved ()
 Creates mouse moved or dragged events depending if any button is pressed.

void createMouseEvent (int id, int button)
 Creates a MouseEvent that first gets processed by the cursor, then gets pushed on the queue.

void triggerMouseButton (int nMouseCode, bool mousePressed)
 Creates mouse pressed, released, and clicked events.

void createKeyEvent (int id, int key)
void keyChanged (int key, bool down)
virtual bool isKeyDownImmediate (KeyCode kc) const=0
 Return whether a key is down in immediate mode.


Protected Attributes

long mModifiers
 The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g.

CursormCursor
 Internal Cursor object.

EventQueuemEventQueue
 EventQueue is used for buffered input support.

bool mUseBufferedKeys
 Wether to use buffering input support - buffering support relies on using an EventQueue.

bool mUseBufferedMouse
 Wether to use buffering input support - buffering support relies on using an EventQueue.

MouseState mMouseState
 The mouse state in immediate mode.

BufferedKeysDownSet mBufferedKeysDown

Detailed Description

Abstract class which allows input to be read from various controllers.

Remarks:
You can access an appropriate concrete subclass of this interface by calling PlatformManager::createInputReader.
Warning:
Temporary implementation only. This class is likely to be refactored into a better design when I get time to look at it properly. For now it's a quick-and-dirty way to get what I need.
See also:
PlatformManager::createInputReader

Definition at line 212 of file OgreInput.h.


Member Typedef Documentation

typedef std::set<KeyCode> Ogre::InputReader::BufferedKeysDownSet [protected]
 

Set of all the keys currently depressed based on buffered input events.

Definition at line 337 of file OgreInput.h.


Constructor & Destructor Documentation

Ogre::InputReader::InputReader  ) 
 

virtual Ogre::InputReader::~InputReader  )  [virtual]
 


Member Function Documentation

void Ogre::InputReader::addCursorMoveListener MouseMotionListener c  ) 
 

Adds a mouse motion listener to the cursor object.

This keeps the Cursor object hidden.

virtual void Ogre::InputReader::capture  )  [pure virtual]
 

Captures the state of all the input devices.

Remarks:
This method captures the state of all input devices and stores it internally for use when the enquiry methods are next called. This is done to ensure that all input is captured at once and therefore combinations of input are not subject to time differences when methods are called.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

void Ogre::InputReader::createKeyEvent int  id,
int  key
[protected]
 

void Ogre::InputReader::createMouseEvent int  id,
int  button
[protected]
 

Creates a MouseEvent that first gets processed by the cursor, then gets pushed on the queue.

char Ogre::InputReader::getKeyChar int  keyCode,
long  modifiers = 0
[static]
 

virtual long Ogre::InputReader::getMouseAbsX  )  const [pure virtual]
 

Retrieves the absolute mouse position on the X (horizontal) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual long Ogre::InputReader::getMouseAbsY  )  const [pure virtual]
 

Retrieves the absolute mouse position on the Y (vertical) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual long Ogre::InputReader::getMouseAbsZ  )  const [pure virtual]
 

Retrieves the absolute mouse position on the Z (mouse wheel) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual bool Ogre::InputReader::getMouseButton uchar  button  )  const [pure virtual]
 

Retrieves the state of a mouse button.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual long Ogre::InputReader::getMouseRelativeX  )  const [virtual]
 

Retrieves the relative position of the mouse when capture was called relative to the last time.

Definition at line 266 of file OgreInput.h.

virtual long Ogre::InputReader::getMouseRelativeY  )  const [virtual]
 

Retrieves the relative position of the mouse when capture was called relative to the last time.

Definition at line 270 of file OgreInput.h.

virtual long Ogre::InputReader::getMouseRelativeZ  )  const [virtual]
 

Retrieves the relative position of the mouse when capture was called relative to the last time.

Definition at line 274 of file OgreInput.h.

virtual long Ogre::InputReader::getMouseRelX  )  const [pure virtual]
 

Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual long Ogre::InputReader::getMouseRelY  )  const [pure virtual]
 

Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual long Ogre::InputReader::getMouseRelZ  )  const [pure virtual]
 

Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual void Ogre::InputReader::getMouseState MouseState state  )  const [pure virtual]
 

Retrieves the current state of the mouse.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual void Ogre::InputReader::initialise RenderWindow pWindow,
bool  useKeyboard = true,
bool  useMouse = true,
bool  useGameController = false
[pure virtual]
 

Initialise the input system.

Note:
Only keyboard and mouse currently implemented.
Parameters:
pWindow The window to capture input for
useKeyboard If true, keyboard input will be supported.
useMouse If true, mouse input will be supported.
useGameController If true, joysticks/gamepads will be supported.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

virtual bool Ogre::InputReader::isKeyDown KeyCode  kc  )  const [virtual]
 

Determines if the specified key is currently depressed.

Note:
In immediate mode, this enquiry method uses the state of the keyboard at the last 'capture' call.

virtual bool Ogre::InputReader::isKeyDownImmediate KeyCode  kc  )  const [protected, pure virtual]
 

Return whether a key is down in immediate mode.

Implemented in Ogre::GLXInput, Ogre::SDLInput, and Ogre::Win32Input8.

void Ogre::InputReader::keyChanged int  key,
bool  down
[protected]
 

void Ogre::InputReader::mouseMoved  )  [protected]
 

Creates mouse moved or dragged events depending if any button is pressed.

void Ogre::InputReader::removeCursorMoveListener MouseMotionListener c  ) 
 

Remove a mouse motion listener to the cursor object.

This keeps the Cursor object hidden.

virtual void Ogre::InputReader::setBufferedInput bool  keys,
bool  mouse
[virtual]
 

Reimplemented in Ogre::Win32Input8.

void Ogre::InputReader::triggerMouseButton int  nMouseCode,
bool  mousePressed
[protected]
 

Creates mouse pressed, released, and clicked events.

void Ogre::InputReader::useBufferedInput EventQueue pEventQueue,
bool  keys = true,
bool  mouse = true
 

Tells the reader to use buffered input and update the passed in queue.

Remarks:
The default behaviour of the input reader is simply to capture the current state of the mouse / keyboard on demand. An alternative is to use buffered input where all events are registered on a queue.


Member Data Documentation

BufferedKeysDownSet Ogre::InputReader::mBufferedKeysDown [protected]
 

Definition at line 338 of file OgreInput.h.

Cursor* Ogre::InputReader::mCursor [protected]
 

Internal Cursor object.

Remarks:
This is a mathematical representation of where the cursor is, it does not draw a cursor.
See also:
CursorGuiElement.

Definition at line 323 of file OgreInput.h.

EventQueue* Ogre::InputReader::mEventQueue [protected]
 

EventQueue is used for buffered input support.

Definition at line 326 of file OgreInput.h.

long Ogre::InputReader::mModifiers [protected]
 

The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g.

shift/alt).

Definition at line 315 of file OgreInput.h.

MouseState Ogre::InputReader::mMouseState [protected]
 

The mouse state in immediate mode.

Definition at line 334 of file OgreInput.h.

bool Ogre::InputReader::mUseBufferedKeys [protected]
 

Wether to use buffering input support - buffering support relies on using an EventQueue.

See also:
class EventQueue

Definition at line 331 of file OgreInput.h.

bool Ogre::InputReader::mUseBufferedMouse [protected]
 

Wether to use buffering input support - buffering support relies on using an EventQueue.

See also:
class EventQueue

Definition at line 331 of file OgreInput.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 Feb 12 13:00:51 2006