Ogre::SDLInput Class Reference

#include <OgreSDLInput.h>

Inheritance diagram for Ogre::SDLInput:

List of all members.


Public Member Functions
	SDLInput ()
virtual	~SDLInput ()
void	initialise (RenderWindow *pWindow, bool useKeyboard=true, bool useMouse=true, bool useGameController=false)
	Initialise the input system.
void	capture ()
	Captures the state of all the input devices.
void	setGrabMode (GrabMode mode)
	Sets how to grab the mouse.
virtual long	getMouseRelX () const
	Retrieves the relative (compared to the last input poll) mouse movement on the X (horizontal) axis.
virtual long	getMouseRelY () const
	Retrieves the relative (compared to the last input poll) mouse movement on the Y (vertical) axis.
virtual long	getMouseRelZ () const
	Retrieves the relative (compared to the last input poll) mouse movement on the Z (mouse wheel) axis.
virtual long	getMouseAbsX () const
	Retrieves the absolute mouse position on the X (horizontal) axis.
virtual long	getMouseAbsY () const
	Retrieves the absolute mouse position on the Y (vertical) axis.
virtual long	getMouseAbsZ () const
	Retrieves the absolute mouse position on the Z (mouse wheel) axis.
virtual void	getMouseState (MouseState &state) const
	Retrieves the current state of the mouse.
virtual bool	getMouseButton (uchar button) const
	Retrieves the state of a mouse button.
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 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.
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.
virtual void	setMouseScale (Real scale)
	Set mouse scale factor.
virtual Real	getMouseScale (void) const
	Get mouse scale factor.
Static Public Member Functions
char	getKeyChar (int keyCode, long modifiers=0)
Protected Types
typedef std::set< KeyCode >	BufferedKeysDownSet
	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)
Protected Attributes
long	mModifiers
	The modifiers are a binary flags that represent what buttons are pressed, and what key modifiers are down (e.g.
Real	mMouseScale
	Speed of mouse.
Cursor *	mCursor
	Internal Cursor object.
EventQueue *	mEventQueue
	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
Private Types
typedef std::map< SDLKey, KeyCode >	InputKeyMap
Private Member Functions
void	processBufferedKeyboard ()
void	processBufferedMouse ()
void	_grabMouse ()
void	_releaseMouse ()
bool	isKeyDownImmediate (KeyCode kc) const
	Return whether a key is down in immediate mode.
Private Attributes
Uint8 *	mKeyboardBuffer
int	mMaxKey
int	mMouseX
int	mMouseY
int	mMouseRelativeX
int	mMouseRelativeY
int	mMouseRelativeZ
Uint8	mMouseKeys
bool	_visible
bool	mMouseGrabbed
bool	mUseMouse
bool	mGrabMouse
bool	mMouseLeft
int	mGrabMode
InputKeyMap	_key_map
bool	warpMouse
Static Private Attributes
const unsigned int	mWheelStep = 60

Member Typedef Documentation

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

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

Definition at line 350 of file OgreInput.h.

typedef std::map<SDLKey, KeyCode> Ogre::SDLInput::InputKeyMap [private]

Definition at line 97 of file OgreSDLInput.h.

Constructor & Destructor Documentation

Ogre::SDLInput::SDLInput ( )

virtual Ogre::SDLInput::~SDLInput ( ) [virtual]

Member Function Documentation

void Ogre::SDLInput::_grabMouse ( ) [private]

void Ogre::SDLInput::_releaseMouse ( ) [private]

void Ogre::InputReader::addCursorMoveListener ( MouseMotionListener * c ) [inherited]

Adds a mouse motion listener to the cursor object.
This keeps the Cursor object hidden.

void Ogre::SDLInput::capture ( ) [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.

Implements Ogre::InputReader.

void Ogre::InputReader::createKeyEvent ( int id,

int key

) [protected, inherited]

void Ogre::InputReader::createMouseEvent ( int id,

int button

) [protected, inherited]

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, inherited]

virtual long Ogre::SDLInput::getMouseAbsX ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual long Ogre::SDLInput::getMouseAbsY ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual long Ogre::SDLInput::getMouseAbsZ ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual bool Ogre::SDLInput::getMouseButton ( uchar button ) const [virtual]

Retrieves the state of a mouse button.

Implements Ogre::InputReader.

virtual long Ogre::InputReader::getMouseRelativeX ( ) const [virtual, inherited]

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, inherited]

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, inherited]

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::SDLInput::getMouseRelX ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual long Ogre::SDLInput::getMouseRelY ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual long Ogre::SDLInput::getMouseRelZ ( ) const [virtual]

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

Implements Ogre::InputReader.

virtual Real Ogre::InputReader::getMouseScale ( void ) const [virtual, inherited]

Get mouse scale factor.

Definition at line 317 of file OgreInput.h.
References Ogre::Real.

virtual void Ogre::SDLInput::getMouseState ( MouseState & state ) const [virtual]

Retrieves the current state of the mouse.

Implements Ogre::InputReader.

void Ogre::SDLInput::initialise ( RenderWindow * pWindow,

bool useKeyboard = true,

bool useMouse = true,

bool useGameController = false

) [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.

Implements Ogre::InputReader.

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

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.

bool Ogre::SDLInput::isKeyDownImmediate ( KeyCode kc ) const [private, virtual]

Return whether a key is down in immediate mode.

Implements Ogre::InputReader.

void Ogre::InputReader::keyChanged ( int key,

bool down

) [protected, inherited]

void Ogre::InputReader::mouseMoved ( ) [protected, inherited]

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

void Ogre::SDLInput::processBufferedKeyboard ( ) [private]

void Ogre::SDLInput::processBufferedMouse ( ) [private]

void Ogre::InputReader::removeCursorMoveListener ( MouseMotionListener * c ) [inherited]

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, inherited]

Reimplemented in Ogre::Win32Input8.

void Ogre::SDLInput::setGrabMode ( GrabMode mode )

Sets how to grab the mouse.
Possible values for mode are GRAB_MOUSE_OVER or GRAB_MOUSE_BUTTON. The first will grab the mouse if the pointer is over the application window and the latter will wait for a mouse button click to aquire the mouse. Default is GRAB_MOUSE_CLICK.
Definition at line 64 of file OgreSDLInput.h.
References mGrabMode.

virtual void Ogre::InputReader::setMouseScale ( Real scale ) [virtual, inherited]

Set mouse scale factor.

Parameters:

scale The new mouse scale (The default on is around 0.001/0.002).

Definition at line 313 of file OgreInput.h.
References Ogre::Real.

void Ogre::InputReader::triggerMouseButton ( int nMouseCode,

bool mousePressed

) [protected, inherited]

Creates mouse pressed, released, and clicked events.

void Ogre::InputReader::useBufferedInput ( EventQueue * pEventQueue,

bool keys = true,

bool mouse = true

) [inherited]

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

InputKeyMap Ogre::SDLInput::_key_map [private]

Definition at line 98 of file OgreSDLInput.h.

bool Ogre::SDLInput::_visible [private]

Definition at line 88 of file OgreSDLInput.h.

BufferedKeysDownSet Ogre::InputReader::mBufferedKeysDown [protected, inherited]

Definition at line 351 of file OgreInput.h.

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

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 336 of file OgreInput.h.

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

EventQueue is used for buffered input support.

Definition at line 339 of file OgreInput.h.

int Ogre::SDLInput::mGrabMode [private]

Definition at line 95 of file OgreSDLInput.h.
Referenced by setGrabMode().

bool Ogre::SDLInput::mGrabMouse [private]

Definition at line 92 of file OgreSDLInput.h.

Uint8* Ogre::SDLInput::mKeyboardBuffer [private]

Definition at line 83 of file OgreSDLInput.h.

int Ogre::SDLInput::mMaxKey [private]

Definition at line 84 of file OgreSDLInput.h.

long Ogre::InputReader::mModifiers [protected, inherited]

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 325 of file OgreInput.h.

bool Ogre::SDLInput::mMouseGrabbed [private]

Definition at line 90 of file OgreSDLInput.h.

Uint8 Ogre::SDLInput::mMouseKeys [private]

Definition at line 87 of file OgreSDLInput.h.

bool Ogre::SDLInput::mMouseLeft [private]

Definition at line 93 of file OgreSDLInput.h.

int Ogre::SDLInput::mMouseRelativeX [private]

Definition at line 86 of file OgreSDLInput.h.

int Ogre::SDLInput::mMouseRelativeY [private]

Definition at line 86 of file OgreSDLInput.h.

int Ogre::SDLInput::mMouseRelativeZ [private]

Definition at line 86 of file OgreSDLInput.h.

Real Ogre::InputReader::mMouseScale [protected, inherited]

Speed of mouse.

Definition at line 328 of file OgreInput.h.

MouseState Ogre::InputReader::mMouseState [protected, inherited]

The mouse state in immediate mode.

Definition at line 347 of file OgreInput.h.

int Ogre::SDLInput::mMouseX [private]

Definition at line 85 of file OgreSDLInput.h.

int Ogre::SDLInput::mMouseY [private]

Definition at line 85 of file OgreSDLInput.h.

bool Ogre::InputReader::mUseBufferedKeys [protected, inherited]

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

See also:
class EventQueue

Definition at line 344 of file OgreInput.h.

bool Ogre::InputReader::mUseBufferedMouse [protected, inherited]

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

See also:
class EventQueue

Definition at line 344 of file OgreInput.h.

bool Ogre::SDLInput::mUseMouse [private]

Definition at line 91 of file OgreSDLInput.h.

const unsigned int Ogre::SDLInput::mWheelStep = 60 [static, private]

Definition at line 106 of file OgreSDLInput.h.

bool Ogre::SDLInput::warpMouse [private]

Definition at line 99 of file OgreSDLInput.h.

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

OgreSDLInput.h

Ogre::SDLInput Class Reference

Public Member Functions

Static Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation