The SystemPointingDevice class is used to represent Pointing Devices connected to the computer. More...

Inheritance diagram for pointing::SystemPointingDevice:

Public Member Functions
	SystemPointingDevice (URI uri)

bool	isActive (void) const
	Indicates whether the current device is active. More...

int	getVendorID (void) const
	Vendor identifier number. More...

std::string	getVendor (void) const
	Readable vendor name. More...

int	getProductID (void) const
	Product identifier number. More...

std::string	getProduct (void) const
	Readable product name. More...

double	getResolution (double *defval=0) const
	Resolution of the mouse in CPI (counts per inch). More...

double	getUpdateFrequency (double *defval=0) const
	Update frequency of the mouse in Hz. More...

URI	getURI (bool expanded=false, bool crossplatform=false) const
	Constructs the URI according to the parameters of the device. More...

void	setPointingCallback (PointingCallback callback, void *context=0)
	Sets the callback function which is called when device events occur. More...

void	setDebugLevel (int level)
	Sets the level of information for debugging purposes (default = 0).

Public Member Functions inherited from pointing::PointingDevice
virtual void	debug (std::ostream &) const
	Outputs the debug information to the given output stream.

virtual void	getAbsolutePosition (double x, double y) const
	getAbsolutePosition Returns absolute position of the device if available otherwise -1, -1 More...

int	mm2counts (double millimeters) const

double	counts2mm (int counts) const

int	in2counts (double inches) const

double	counts2in (int counts) const

Protected Attributes
URI	uri

URI	anyURI

double	forced_cpi = -1.

double	forced_hz = -1.

int	vendorID = 0

int	productID = 0

int	debugLevel = 0

PointingCallback	callback = NULL

void *	callback_context = NULL

std::string	vendor

std::string	product

bool	active = false

Protected Attributes inherited from pointing::PointingDevice
FrequencyEstimator	freqEstim

Additional Inherited Members
Public Types inherited from pointing::PointingDevice
enum	{ BUTTON_1 =1, BUTTON_2 =2, BUTTON_3 =4 }

typedef void(*	PointingCallback )(void *context, TimeStamp::inttime timestamp, int dx, int dy, int buttons)

Static Public Member Functions inherited from pointing::PointingDevice
static void	idle (int milliseconds)
	The function is used to sleep the current thread. More...

static PointingDevice *	create (const char *device_uri=0)
	This static function is used to instantiate a platform-specific object of the class. More...

static PointingDevice *	create (std::string device_uri)

Protected Member Functions inherited from pointing::PointingDevice
void	registerTimestamp (TimeStamp::inttime timestamp, int dx, int dy)
	registerTimestamp Registers the current timestamp to calculate frequency of the device

double	estimatedUpdateFrequency () const
	estimatedUpdateFrequency Estimates the frequency depending on the input timestamps More...

Detailed Description

The SystemPointingDevice class is used to represent Pointing Devices connected to the computer.

It defines general behavior for all three platforms.

Member Function Documentation

std::string pointing::SystemPointingDevice::getProduct ( void ) const

virtual

Readable product name.

int pointing::SystemPointingDevice::getProductID ( void ) const

virtual

Product identifier number.

double pointing::SystemPointingDevice::getResolution ( double * defval = 0 ) const

virtual

Resolution of the mouse in CPI (counts per inch).

Parameters

defval is input variable to define explicitly the resolution.

double pointing::SystemPointingDevice::getUpdateFrequency ( double * defval = 0 ) const

virtual

Update frequency of the mouse in Hz.

Parameters

defval is input variable to define explicitly the update frequency.

URI pointing::SystemPointingDevice::getURI	(	bool	expanded = `false`,
		bool	crossplatform = `false`
	)		const

virtual

Constructs the URI according to the parameters of the device.

Parameters

expanded	specifies if additional parameters must be displayed.
crossplatform	defines whether the URI should be crossplatform. if True vendorId and productId are included in the URI