OIS::MultiTouch Class Reference

MultiTouch base class. More...

#include </home/jenkins/workspace/orxonox_doxygen_trunk/src/external/ois/OISMultiTouch.h>

Inheritance diagram for OIS::MultiTouch:

Public Member Functions
virtual	~MultiTouch ()
void	clearStates (void)
MultiTouchListener *	getEventCallback ()
const std::vector< MultiTouchState >	getFirstNTouchStates (int n)
std::vector< MultiTouchState >	getMultiTouchStates () const
const std::vector< MultiTouchState >	getMultiTouchStatesOfType (MultiTypeEventTypeID type)
virtual void	setEventCallback (MultiTouchListener *touchListener)
Public Member Functions inherited from OIS::Object
virtual	~Object ()
virtual void	_initialize ()=0
virtual bool	buffered () const
virtual void	capture ()=0
InputManager *	getCreator () const
virtual int	getID () const
virtual Interface *	queryInterface (Interface::IType type)=0
virtual void	setBuffered (bool buffered)=0
Type	type () const
const std::string &	vendor () const

Protected Member Functions
	MultiTouch (const std::string &vendor, bool buffered, int devID, InputManager *creator)
Protected Member Functions inherited from OIS::Object
	Object (const std::string &vendor, Type iType, bool buffered, int devID, InputManager *creator)

Protected Attributes
MultiTouchListener *	mListener
	Used for buffered/actionmapping callback. More...
std::vector< MultiTouchState >	mStates
	The state of the touch device, implemented in a vector to store the state from each finger touch. More...
Protected Attributes inherited from OIS::Object
bool	mBuffered
	Buffered flag. More...
InputManager *	mCreator
	The creator who created this object. More...
int	mDevID
	Not fully implemented yet. More...
Type	mType
	Type of controller object. More...
std::string	mVendor
	Vendor name if applicable/known. More...

Detailed Description

MultiTouch base class.

To be implemented by specific system (ie. iPhone UITouch) This class is useful as you remain OS independent using this common interface.

Constructor & Destructor Documentation

virtual OIS::MultiTouch::~MultiTouch ( )

inlinevirtual

OIS::MultiTouch::MultiTouch ( const std::string &  vendor, bool  buffered, int  devID, InputManager *  creator  )

inlineprotected

Member Function Documentation

void OIS::MultiTouch::clearStates ( void  )

inline

Remarks

Clear out the set of input states. Should be called after input has been processed by the application

MultiTouchListener* OIS::MultiTouch::getEventCallback ( )

inline

Remarks

Returns currently set callback.. or 0

const std::vector<MultiTouchState> OIS::MultiTouch::getFirstNTouchStates ( int  n )

inline

Remarks

Returns the first n touch states. Useful if you know your app only needs to process n touches. The return value is a vector to allow random access

std::vector<MultiTouchState> OIS::MultiTouch::getMultiTouchStates ( ) const

inline

Remarks

Returns the state of the touch - is valid for both buffered and non buffered mode

const std::vector<MultiTouchState> OIS::MultiTouch::getMultiTouchStatesOfType ( MultiTypeEventTypeID  type )

inline

Remarks

Returns the first n touch states. Useful if you know your app only needs to process n touches. The return value is a vector to allow random access

virtual void OIS::MultiTouch::setEventCallback ( MultiTouchListener *  touchListener )

inlinevirtual

Remarks

Register/unregister a MultiTouch Listener - Only one allowed for simplicity. If broadcasting is necessary, just broadcast from the callback you registered.

Parameters

touchListener

Send a pointer to a class derived from MultiTouchListener or 0 to clear the callback

Member Data Documentation

MultiTouchListener* OIS::MultiTouch::mListener

protected

Used for buffered/actionmapping callback.

std::vector<MultiTouchState> OIS::MultiTouch::mStates

protected

The state of the touch device, implemented in a vector to store the state from each finger touch.

---

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

• external/ois/OISMultiTouch.h