gadget::GestureProxy Class Reference

Proxy to Gesture object. More...

#include <gadget/Type/GestureProxy.h>

Inheritance diagram for gadget::GestureProxy:

[legend]Collaboration diagram for gadget::GestureProxy:

[legend]List of all members.

Public Member Functions
	GestureProxy ()
	Constructs the proxy to point to the given gesture device.
virtual	~GestureProxy ()
int	getGesture ()
	Gets the current gesture.
int	getGestureIndex (std::string name)
	Returns the identifier of the string gesture.
std::string	getGestureString (int gestureId=-1)
	Gets a gesture name.
vpr::Interval	getTimeStamp () const
	Returns time of last update.
Gesture *	getGesturePtr ()
	Returns a pointer to the device held by this proxy.
bool	config (jccl::ConfigElementPtr element)
	Configures the proxy.
virtual Input *	getProxiedInputDevice ()
	Returns a pointer to the base class of the devices being proxied.
Static Public Member Functions
static std::string	getElementType ()
	Returns the string rep of the element type used to config this device.

---

Detailed Description

Proxy to Gesture object.

A proxy is used by the user to actually acces the gesture data. The proxy allows the user to query the current gesture information. Clients call the get* routines to get the current gesture (id or string) Once the client has the current gesture, they should test it against the gestures they want to respond to.

See also:

gadget::Gesture

Definition at line 64 of file GestureProxy.h.

---

Constructor & Destructor Documentation

gadget::GestureProxy::GestureProxy

(

)

[inline]

Constructs the proxy to point to the given gesture device.

Definition at line 68 of file GestureProxy.h.

   { ;}

virtual gadget::GestureProxy::~GestureProxy

(

)

[inline, virtual]

Definition at line 71 of file GestureProxy.h.

   {}

---

Member Function Documentation

int gadget::GestureProxy::getGesture

(

)

[inline]

Gets the current gesture.

Returns:

id of current gesture.

Definition at line 78 of file GestureProxy.h.

   {
      const int defaultGesture(-1);

      if(isStupefied())
         return defaultGesture;
      else
         return mTypedDevice->getGesture();
   }

int gadget::GestureProxy::getGestureIndex

(

std::string

name

)

[inline]

Returns the identifier of the string gesture.

Parameters:

name

The string name of a gesture.

Returns:

-1 if not found

Definition at line 93 of file GestureProxy.h.

   {
      const int defaultGestureIndex(-1);
      if(isStupefied())
         return defaultGestureIndex;
      else
         return mTypedDevice->getGestureIndex(name);
   }

std::string gadget::GestureProxy::getGestureString

(

int

gestureId = -1

)

[inline]

Gets a gesture name.

Returns:

Name of gesture with the given id (gestureId).

Note:

if gestureId = -1, returns name of current gesture.

Definition at line 107 of file GestureProxy.h.

   {
      if(isStupefied())
         return std::string("");
      else
         return mTypedDevice->getGestureString(gestureId);
   }

vpr::Interval gadget::GestureProxy::getTimeStamp

(

)

const [inline, virtual]

Returns time of last update.

Implements gadget::Proxy.

Definition at line 116 of file GestureProxy.h.

   {
      // XXX: Broken for now, this is a case similar to the KeyboardMouse type in that
      //      it does not point to one data element like digital, analog, and position.
      return vpr::Interval();
   }

Gesture* gadget::GestureProxy::getGesturePtr

(

)

[inline]

Returns a pointer to the device held by this proxy.

Definition at line 124 of file GestureProxy.h.

   {
      if(isStupefied())
         return NULL;
      else
         return mTypedDevice;
   }

std::string gadget::GestureProxy::getElementType

(

)

[static]

Returns the string rep of the element type used to config this device.

Used by the Input Manager to find elements that construct devices.

Reimplemented from gadget::Proxy.

Definition at line 42 of file GestureProxy.cpp.

Referenced by gadget::ProxyDepChecker::canHandle(), and config().

{
   return "gesture_proxy";
}

bool gadget::GestureProxy::config

(

jccl::ConfigElementPtr

element

)

[virtual]

Configures the proxy.

Postcondition:

Proxy is configured (it is not registered yet though).

Returns:

success.

Reimplemented from gadget::Proxy.

Definition at line 47 of file GestureProxy.cpp.

References gadget::Proxy::config(), gadgetDBG_INPUT_MGR(), getElementType(), gadget::TypedProxy< DEV_TYPE >::mDeviceName, and gadget::TypedProxy< DEV_TYPE >::refresh().

{
vpr::DebugOutputGuard dbg_output(gadgetDBG_INPUT_MGR, vprDBG_STATE_LVL,
      std::string("------------------ GESTURE PROXY config() -----------------\n"),
      std::string("\n"));

   vprASSERT(element->getID() == getElementType());

   if ( ! Proxy::config(element) )
   {
      return false;
   }

   mDeviceName = element->getProperty<std::string>("device");

   refresh();

   return true;
}

virtual Input* gadget::GestureProxy::getProxiedInputDevice

(

)

[inline, virtual]

Returns a pointer to the base class of the devices being proxied.

Returns:

NULL if no device is proxied.

Implements gadget::Proxy.

Definition at line 136 of file GestureProxy.h.

   {
      if((NULL == mTypedDevice) || (isStupefied)())
         return NULL;

      Input* ret_val = dynamic_cast<Input*>(mTypedDevice);
      vprASSERT((ret_val != NULL) && "Cross-cast in GestureProxy failed");
      return ret_val;
   }

---

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

• GestureProxy.h
• GestureProxy.cpp

---