Sirikata::Input::InputDevice Class Reference

#include <InputDevice.hpp>

Inheritance diagram for Sirikata::Input::InputDevice:

Collaboration diagram for Sirikata::Input::InputDevice:

List of all members.

Classes
struct	ButtonState
Public Member Functions
const std::string &	getName () const
void	setName (const std::string &newName)
InputManager *	getInputManager ()
void	setInputManager (InputManager *man)
	InputDevice ()
virtual	~InputDevice ()
virtual std::string	getButtonName (unsigned int button) const =0
virtual int	getNumButtons () const =0
virtual std::string	getAxisName (unsigned int axis) const =0
virtual unsigned int	getNumAxes () const =0
virtual bool	isKeyboard ()
bool	fireButton (const InputDevicePtr &thisptr, unsigned int button, bool newState, Modifier mod=0)
bool	fireAxis (const InputDevicePtr &thisptr, unsigned int axis, AxisValue newState)
AxisValue	getAxis (unsigned int axis) const
bool	getButton (unsigned int button, Modifier mod) const
const Modifier *	getButton (unsigned int button) const
Protected Types
typedef std::tr1::unordered_map < unsigned int, ButtonState >	ButtonSet
typedef std::vector< AxisValue >	AxisVector
Protected Member Functions
bool	changeButton (unsigned int button, bool newState, Modifier &mod)
bool	changeAxis (unsigned int axis, AxisValue newValue)
Protected Attributes
std::string	mName
InputManager *	mManager
ButtonSet	buttonState
AxisVector	axisState

---

Member Typedef Documentation

typedef std::vector<AxisValue> Sirikata::Input::InputDevice::AxisVector [protected]

typedef std::tr1::unordered_map<unsigned int, ButtonState> Sirikata::Input::InputDevice::ButtonSet [protected]

---

Constructor & Destructor Documentation

Sirikata::Input::InputDevice::InputDevice

(

)

[inline]

virtual Sirikata::Input::InputDevice::~InputDevice

(

)

[inline, virtual]

---

Member Function Documentation

bool Sirikata::Input::InputDevice::changeAxis	(	unsigned int	axis,
		AxisValue	newValue
	)		[protected]

References axisState, Sirikata::Input::AxisValue::clip(), and Sirikata::Input::AxisValue::null().

Referenced by fireAxis().

bool Sirikata::Input::InputDevice::changeButton	(	unsigned int	button,
		bool	newState,
		Modifier &	mod
	)		[protected]

References buttonState, Sirikata::Input::InputDevice::ButtonState::initialTime, Sirikata::Input::InputDevice::ButtonState::lastTime, Sirikata::Input::InputDevice::ButtonState::mod, and Sirikata::Timer::now().

Referenced by fireButton().

bool Sirikata::Input::InputDevice::fireAxis	(	const InputDevicePtr &	thisptr,
		unsigned int	axis,
		AxisValue	newState
	)

References changeAxis(), Sirikata::Input::AxisValue::clip(), Sirikata::Input::InputManager::fire(), mManager, and Sirikata::Input::AxisValue::null().

Referenced by Sirikata::Input::SDLJoystick::fireBall(), Sirikata::Input::SDLMouse::fireMotion(), and Sirikata::Input::SDLMouse::fireWheel().

bool Sirikata::Input::InputDevice::fireButton	(	const InputDevicePtr &	thisptr,
		unsigned int	button,
		bool	newState,
		Modifier	mod = 0
	)

References buttonState, changeButton(), Sirikata::Input::InputManager::fire(), mManager, and Sirikata::Timer::now().

Referenced by Sirikata::Input::SDLJoystick::fireHat().

AxisValue Sirikata::Input::InputDevice::getAxis

(

unsigned int

axis

)

const [inline]

References Sirikata::Input::AxisValue::null().

Referenced by Sirikata::Input::SDLMouse::fireMotion().

virtual std::string Sirikata::Input::InputDevice::getAxisName

(

unsigned int

axis

)

const [pure virtual]

Implemented in Sirikata::Input::SDLMouse, Sirikata::Input::SDLJoystick, and Sirikata::Input::SDLKeyboard.

const Modifier* Sirikata::Input::InputDevice::getButton

(

unsigned int

button

)

const [inline]

bool Sirikata::Input::InputDevice::getButton	(	unsigned int	button,
		Modifier	mod
	)		const [inline]

virtual std::string Sirikata::Input::InputDevice::getButtonName

(

unsigned int

button

)

const [pure virtual]

Implemented in Sirikata::Input::SDLMouse, Sirikata::Input::SDLJoystick, and Sirikata::Input::SDLKeyboard.

InputManager* Sirikata::Input::InputDevice::getInputManager

(

)

[inline]

const std::string& Sirikata::Input::InputDevice::getName

(

)

const [inline]

virtual unsigned int Sirikata::Input::InputDevice::getNumAxes

(

)

const [pure virtual]

Implemented in Sirikata::Input::SDLMouse, Sirikata::Input::SDLJoystick, and Sirikata::Input::SDLKeyboard.

virtual int Sirikata::Input::InputDevice::getNumButtons

(

)

const [pure virtual]

Implemented in Sirikata::Input::SDLMouse, Sirikata::Input::SDLJoystick, and Sirikata::Input::SDLKeyboard.

virtual bool Sirikata::Input::InputDevice::isKeyboard

(

)

[inline, virtual]

Reimplemented in Sirikata::Input::SDLKeyboard.

void Sirikata::Input::InputDevice::setInputManager

(

InputManager *

man

)

[inline]

void Sirikata::Input::InputDevice::setName

(

const std::string &

newName

)

[inline]

Referenced by Sirikata::Input::SDLKeyboard::SDLKeyboard(), and Sirikata::Input::SDLMouse::SDLMouse().

---

Member Data Documentation

AxisVector Sirikata::Input::InputDevice::axisState [protected]

Referenced by changeAxis().

ButtonSet Sirikata::Input::InputDevice::buttonState [protected]

Referenced by changeButton(), and fireButton().

InputManager* Sirikata::Input::InputDevice::mManager [protected]

Referenced by fireAxis(), fireButton(), Sirikata::Input::PointerDevice::firePointerClick(), Sirikata::Input::PointerDevice::firePointerMotion(), Sirikata::Input::SDLKeyboard::inputManager(), Sirikata::Input::SDLJoystick::inputManager(), and Sirikata::Input::SDLMouse::inputManager().

std::string Sirikata::Input::InputDevice::mName [protected]

Reimplemented in Sirikata::Input::SDLJoystick.

---

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

• libogre/include/sirikata/ogre/input/InputDevice.hpp
• libogre/src/input/InputDevice.cpp