gadget::SimInput Class Reference

Base class for all simulated input devices. More...

#include <gadget/Devices/Sim/SimInput.h>

Inheritance diagram for gadget::SimInput:

[legend]Collaboration diagram for gadget::SimInput:

[legend]List of all members.

Public Member Functions
	SimInput ()
virtual	~SimInput ()
virtual bool	config (jccl::ConfigElementPtr element)
	Configures the keyboard interface.
virtual std::string	getInputTypeName ()
virtual vpr::ReturnStatus	writeObject (vpr::ObjectWriter *writer)
virtual vpr::ReturnStatus	readObject (vpr::ObjectReader *reader)
Protected Member Functions
virtual int	checkKeyPair (KeyModPair &pair)
	Checks the given keypair.
std::vector< KeyModPair >	readKeyList (std::vector< jccl::ConfigElementPtr > &keyList)
	Constructs the mod pair from a mod pair element.
Protected Attributes
KeyboardMouseInterface	mKeyboardMouse
	The keyboard/mouse device from which we receive events.
Classes
class	KeyModPair

---

Detailed Description

Base class for all simulated input devices.

Has the common routines for accessing and seting up keyboard interface.

Definition at line 55 of file SimInput.h.

---

Constructor & Destructor Documentation

gadget::SimInput::SimInput

(

)

[inline]

Definition at line 91 of file SimInput.h.

   {
      //vprDEBUG(vprDBG_ALL, vprDBG_VERB_LVL)<<"*** SimInput::SimInput()\n"<< vprDEBUG_FLUSH;
   }

virtual gadget::SimInput::~SimInput

(

)

[inline, virtual]

Definition at line 95 of file SimInput.h.

{}

---

Member Function Documentation

bool gadget::SimInput::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Configures the keyboard interface.

Postcondition:

Event window proxy is configured.

Reimplemented in gadget::SimGloveGesture.

Definition at line 70 of file SimInput.cpp.

References gadget::BaseDeviceInterface::init(), and mKeyboardMouse.

Referenced by gadget::SimPosition::config(), gadget::SimGloveGesture::config(), gadget::SimDigitalGlove::config(), gadget::SimDigital::config(), and gadget::SimAnalog::config().

{
   // Get the event source.
   mKeyboardMouse.init(element->getProperty<std::string>("keyboard_mouse_proxy"));

   return true;
}

virtual std::string gadget::SimInput::getInputTypeName

(

)

[inline, virtual]

Definition at line 103 of file SimInput.h.

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

virtual vpr::ReturnStatus gadget::SimInput::writeObject

(

vpr::ObjectWriter *

writer

)

[inline, virtual]

Definition at line 108 of file SimInput.h.

   {
      boost::ignore_unused_variable_warning(writer);
      return vpr::ReturnStatus::Succeed;
   }

virtual vpr::ReturnStatus gadget::SimInput::readObject

(

vpr::ObjectReader *

reader

)

[inline, virtual]

Definition at line 114 of file SimInput.h.

   {
      boost::ignore_unused_variable_warning(reader);
      return vpr::ReturnStatus::Succeed;
   }

int gadget::SimInput::checkKeyPair

(

KeyModPair &

pair

)

[protected, virtual]

Checks the given keypair.

Returns:

Number of times the key was pressed with the modifier alone held down.

Definition at line 78 of file SimInput.cpp.

References gadget::SimInput::KeyModPair::mKey, mKeyboardMouse, and gadget::SimInput::KeyModPair::mModifier.

{
   // If the modifier is any
   //   - Then check to see if the key is pressed.
   // Else
   //   - The modifier and the key must be pressed.
   
   // NOTE: If the modifier is NONE, then if any modifier
   //       is pressed we will return 0;

   if (pair.mModifier == -1)
   {
      return mKeyboardMouse->keyPressed(pair.mKey);
   }
   if (mKeyboardMouse->modifierOnly(pair.mModifier))
   {
      return mKeyboardMouse->keyPressed(pair.mKey);
   }
   else
   {
      return 0;
   }
}

std::vector< SimInput::KeyModPair > gadget::SimInput::readKeyList

(

std::vector< jccl::ConfigElementPtr > &

keyList

)

[protected]

Constructs the mod pair from a mod pair element.

Takes as input a element that has a list of KeyModPair child elements.

Precondition:

keyList must be full of var values containing elements of the type "key_modifier_pair". The KeyModPair element type must have fields named key and modifier_key.

Returns:

vector of KeyModPair objects.

Definition at line 42 of file SimInput.cpp.

Referenced by gadget::SimGloveGesture::config().

{
   std::vector<KeyModPair> key_vec;

   if ( ! keyList.empty() )
   {
#ifdef GADGET_DEBUG
      jccl::ConfigElementPtr first_element = keyList[0];
      std::string element_type(first_element->getID());
      vprASSERT(element_type == std::string("key_modifier_pair"));
#endif

      for ( std::vector<jccl::ConfigElementPtr>::iterator i = keyList.begin();
            i != keyList.end();
            ++i )
      {
         key_vec.push_back(KeyModPair((gadget::Keys) (*i)->getProperty<int>("key"),
                                      (gadget::Keys) (*i)->getProperty<int>("modifier_key")));
      }
   }

   return key_vec;
}

---

Member Data Documentation

KeyboardMouseInterface gadget::SimInput::mKeyboardMouse [protected]

The keyboard/mouse device from which we receive events.

Definition at line 143 of file SimInput.h.

Referenced by checkKeyPair(), and config().

---

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

• SimInput.h
• SimInput.cpp

---