gadget::KeyboardMouseDevice Class Reference

Base class for keyboard/mouse input devices. More...

#include <gadget/Devices/KeyboardMouseDevice/KeyboardMouseDevice.h>

Inheritance diagram for gadget::KeyboardMouseDevice:

[legend]Collaboration diagram for gadget::KeyboardMouseDevice:

[legend]List of all members.

Public Member Functions
	KeyboardMouseDevice ()
	~KeyboardMouseDevice ()
virtual bool	config (jccl::ConfigElementPtr e)
virtual bool	startSampling ()
	Start the windows sampling.
virtual bool	stopSampling ()
	Stop window sampling.
virtual bool	sample ()
	Dop nothing.
virtual void	updateData ()
	Update the keys and event queue data structures with current data.
void	operator delete (void *p)
	Invokes the global scope delete operator.
Static Public Member Functions
static std::string	getElementType ()
	Return the element type associated with this device type.
Public Attributes
vpr::Mutex	mKeysLock
	Must hold this lock when accessing m_keys.
Event window state holders
int	mKeys [gadget::LAST_KEY]
	(0,*): The num key presses during an UpdateData (ie.
int	mRealkeys [gadget::LAST_KEY]
	(0,1): The real keyboard state, all events processed (ie.
Protected Member Functions
void	destroy ()
	Deletes this object.
Classes
class	KeyboardMouseDeviceRegistry
	Holds list of registered windows that may be used for keyboard/moues Input. More...

---

Detailed Description

Base class for keyboard/mouse input devices.

Definition at line 57 of file KeyboardMouseDevice.h.

---

Constructor & Destructor Documentation

gadget::KeyboardMouseDevice::KeyboardMouseDevice

(

)

[inline]

Definition at line 103 of file KeyboardMouseDevice.h.

   {;}

gadget::KeyboardMouseDevice::~KeyboardMouseDevice

(

)

[inline]

Definition at line 106 of file KeyboardMouseDevice.h.

References stopSampling().

   {
      stopSampling();
   }

---

Member Function Documentation

bool gadget::KeyboardMouseDevice::config

(

jccl::ConfigElementPtr

e

)

[virtual]

Definition at line 46 of file KeyboardMouseDevice.cpp.

References gadget::KeyboardMouse::config(), gadget::Input::config(), gadgetDBG_INPUT_MGR(), gadget::LAST_KEY, gadget::KeyboardMouseDevice::KeyboardMouseDeviceRegistry::KeyboardMouseDeviceInfo::mKeyboardMouseDevice, mKeys, mRealkeys, and gadget::KeyboardMouseDevice::KeyboardMouseDeviceRegistry::KeyboardMouseDeviceInfo::mSourceName.

{
   unsigned required_definition_ver(1);

   if(e->getVersion() < required_definition_ver)
   {
      vprDEBUG(gadgetDBG_INPUT_MGR, vprDBG_CRITICAL_LVL)
         << clrOutBOLD(clrRED, "ERROR")
         << ": [gadget::KeyboardMouseDevice::config()] Element named '"
         << e->getName() << "'" << std::endl << vprDEBUG_FLUSH;
      vprDEBUG_NEXT(gadgetDBG_INPUT_MGR, vprDBG_CRITICAL_LVL)
         << "is version " << e->getVersion()
         << ", but we require at least version " << required_definition_ver
         << ". Ignoring.\n" << vprDEBUG_FLUSH;
      return false;
   }

   if ( ! (Input::config(e) && KeyboardMouse::config(e) ) )
   {
      return false;
   }

   mMouseSensitivity = e->getProperty<float>("mouse_sensitivity");
   if (0.0f == mMouseSensitivity)
   {
      mMouseSensitivity = 0.5;
   }

   for ( int i = 0; i < gadget::LAST_KEY; ++i )
   {
      mRealkeys[i] = mKeys[i] = mCurKeys[i];
   }

   KeyboardMouseDeviceRegistry::KeyboardMouseDeviceInfo event_source_info;
   event_source_info.mSourceName = e->getName();
   event_source_info.mKeyboardMouseDevice = this;

   KeyboardMouseDeviceRegistry::instance()->addKeyboardMouseDevice(e->getName(), event_source_info);

   return true;
}

virtual bool gadget::KeyboardMouseDevice::startSampling

(

)

[inline, virtual]

Start the windows sampling.

Definition at line 114 of file KeyboardMouseDevice.h.

   {
      return true;
   }

virtual bool gadget::KeyboardMouseDevice::stopSampling

(

)

[inline, virtual]

Stop window sampling.

Definition at line 120 of file KeyboardMouseDevice.h.

Referenced by ~KeyboardMouseDevice().

   {
      return true;
   }

virtual bool gadget::KeyboardMouseDevice::sample

(

)

[inline, virtual]

Dop nothing.

Definition at line 126 of file KeyboardMouseDevice.h.

   {
      // Do nothing
      return true;
   }

void gadget::KeyboardMouseDevice::updateData

(

)

[virtual]

Update the keys and event queue data structures with current data.

Definition at line 88 of file KeyboardMouseDevice.cpp.

References gadget::LAST_KEY, mKeys, mKeysLock, gadget::MOUSE_NEGX, gadget::MOUSE_NEGY, gadget::MOUSE_POSX, gadget::MOUSE_POSY, and mRealkeys.

{
vpr::Guard<vpr::Mutex> guard(mKeysLock);      // Lock access to the mKeys array

// Scale mouse values based on sensitivity
   mKeys[gadget::MOUSE_POSX] = int(float(mKeys[gadget::MOUSE_POSX]) * mMouseSensitivity);
   mKeys[gadget::MOUSE_NEGX] = int(float(mKeys[gadget::MOUSE_NEGX]) * mMouseSensitivity);
   mKeys[gadget::MOUSE_POSY] = int(float(mKeys[gadget::MOUSE_POSY]) * mMouseSensitivity);
   mKeys[gadget::MOUSE_NEGY] = int(float(mKeys[gadget::MOUSE_NEGY]) * mMouseSensitivity);

   /*
   vprDEBUG(vprDBG_ALL, vprDBG_CRITICAL_LVL)
      << "gadget::KeyboardMouseDevice::updateData:" << mInstName << " -- "
      << "mouse_keys: px:" << mKeys[gadget::MOUSE_POSX]
      << " nx:" << mKeys[gadget::MOUSE_NEGX]
      << " py:" << mKeys[gadget::MOUSE_POSY]
      << " ny:" << mKeys[gadget::MOUSE_NEGY]
      << std::endl << vprDEBUG_FLUSH;
   */

   // Copy over values
   for ( unsigned int i = 0; i < gadget::LAST_KEY; ++i )
   {
      mCurKeys[i] = mKeys[i];
   }

   // Re-initialize the mKeys based on current key state in realKeys
   // Set the initial state of the mKey key counts based on the current state
   // of the system this is to ensure that if a key is still down, we get at
   // least one event for it.
   for ( unsigned int j = 0; j < gadget::LAST_KEY; ++j )
   {
      mKeys[j] = mRealkeys[j];
   }

   updateEventQueue();
}

std::string gadget::KeyboardMouseDevice::getElementType

(

)

[static]

Return the element type associated with this device type.

Definition at line 41 of file KeyboardMouseDevice.cpp.

{
   return std::string("keyboard_mouse_device");
}

void gadget::KeyboardMouseDevice::operator delete

(

void *

p

)

[inline]

Invokes the global scope delete operator.

This is required for proper releasing of memory in DLLs on Win32.

Definition at line 142 of file KeyboardMouseDevice.h.

   {
      ::operator delete(p);
   }

void gadget::KeyboardMouseDevice::destroy

(

)

[inline, protected]

Deletes this object.

This is an implementation of the pure virtual gadget::Input::destroy() method.

Definition at line 152 of file KeyboardMouseDevice.h.

   {
      delete this;
   }

---

Member Data Documentation

vpr::Mutex gadget::KeyboardMouseDevice::mKeysLock

Must hold this lock when accessing m_keys.

Definition at line 161 of file KeyboardMouseDevice.h.

Referenced by gadget::InputAreaXWin::handleEvents(), and updateData().

int gadget::KeyboardMouseDevice::mKeys[gadget::LAST_KEY]

(0,*): The num key presses during an UpdateData (ie.

How many keypress events).

Definition at line 172 of file KeyboardMouseDevice.h.

Referenced by config(), gadget::InputAreaXWin::handleEvent(), updateData(), and gadget::InputAreaWin32::updKeys().

int gadget::KeyboardMouseDevice::mRealkeys[gadget::LAST_KEY]

(0,1): The real keyboard state, all events processed (ie.

what is the key now).

Definition at line 178 of file KeyboardMouseDevice.h.

Referenced by gadget::InputAreaWin32::addKeyEvent(), config(), gadget::InputAreaWin32::getButtonMask(), gadget::InputAreaWin32::getModifierMask(), gadget::InputAreaXWin::handleEvent(), updateData(), and gadget::InputAreaWin32::updKeys().

---

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

• KeyboardMouseDevice.h
• KeyboardMouseDevice.cpp

---