#include <KeyboardMouse.h>

Inheritance diagram for vreckoDP_base::KeyboardMouse:

Public Member Functions
	KeyboardMouse ()

	~KeyboardMouse ()

virtual int	openDevice (void)
	Opens device and performs the initialization routines. More...

int	closeDevice (void)
	Closes device. More...

int	calibrateDevice (void)
	Device calibration. More...

bool	isKeyDown (int keyCode)

void	update (void)
	Updates the device - scan device and send required outputs. More...

virtual bool	handle (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &)

virtual void	accept (osgGA::GUIEventHandlerVisitor &v)

void	mouseScroll (osgGA::GUIEventAdapter::ScrollingMotion)

void	mouseMotion (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa)

void	passiveMouseMotion (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, float mx, float my)

void	buttonPress (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, float mx, float my, unsigned int mb)

void	doubleButtonPress (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, float mx, float my, unsigned int mb)

void	buttonRelease (const osgGA::GUIEventAdapter &ea, osgGA::GUIActionAdapter &aa, float mx, float my, unsigned int mb)

void	keyPress (int)

void	keyRelease (int)

void	specialKeyPress (int)

void	specialKeyRelease (int)

void	shutdown ()

bool	idle ()

Public Member Functions inherited from vrecko::Device
	Device (const char startingDeviceName, const char pname="")

virtual	~Device ()

int	getID (void)
	Returns the ID of the device. More...

void	setID (int new_id)
	Sets ID of the device. More...

const std::string &	getDeviceType (void)
	Returns the type of the device. More...

void	setPortName (const char *pname)
	Sets the port name for the device. More...

const char *	getPortName (void)
	Returns port name of the device. More...

virtual const std::string	getCalibrationString (void)
	Returns the description of the calibration process. More...

Public Member Functions inherited from vrecko::BaseClass
	BaseClass (const char *startingSenderString)
	The main constructor. More...

	BaseClass (BaseClass &bc)
	Copy constructor. Probably not really used. More...

virtual	~BaseClass ()
	Destructor. More...

virtual bool	initialize (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parameters=NULL)
	Core initialization. More...

virtual bool	initializeFromString (const char *xmlString)
	Helper method that allows to initialize ability from a XML-formatted string. More...

virtual XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...

bool	inputPresent (const std::string &name)
	Returns true if input pin (not request inputpin ) with given name is present. More...

bool	outputPresent (const std::string &name)
	Returns true if output pin (not request output pin) with given name is present. More...

void	addInputPin (InputPinBase *pin)
	Adds an input pin. More...

void	removeInputPin (InputPinBase *pin)
	Removes an input pin. More...

void	addOutputPin (OutputPinBase *pin)
	Adds an output pin. More...

void	removeOutputPin (OutputPinBase *pin)
	Removes and output pin. More...

void	addRequestInputPin (RequestInputPinBase *pin)
	Adds a request input pin. More...

void	removeRequestInputPin (RequestInputPinBase *pin)
	Removes a request input pin. More...

void	addRequestOutputPin (RequestOutputPinBase *pin)
	Adds a request output pin. More...

void	removeRequestOutputPin (RequestOutputPinBase *pin)
	Removes a request output pin. More...

bool	addNotification (BaseClass *receiver, unsigned long notificationTypes)
	Registers an observer that will be notified if a specific change occurs. More...

bool	removeNotification (BaseClass *receiver, unsigned long notificationTypes=NOTIFICATION_ALL)
	Unregisters a previously registered observer. More...

virtual void	processEvent (const std::string &input_name, VreckoMessage *pMessage)
	Internal method for processing the events. More...

virtual VreckoMessage *	processRequest (const std::string &request_input_name, VreckoMessage *pMessage)
	Internal method for processing the requests. More...

virtual const std::string &	getSenderString (void)
	Returns the sender (or receiver) identification string. More...

void	reportError (const std::string &error)
	Print error message. More...

void	setPriority (long int pr)
	Sets the priority. (Possible problems - read the full description for more info) More...

long int	getPriority (void) const
	Returns current object priority. More...

void	setAttribute (const std::string &attr_name, int attr_value)
	Sets an attribute value. More...

int	getAttribute (const std::string &attr_name)
	Returns attribute value. More...

int	getAttribute (const char *attr_name)
	Returns attribute value. More...

void	deleteAttribute (const std::string &attr_name)
	Delete an attribute. More...

void	setSceneFile (const std::string &sceneFileName)
	Set the name of the file this component was in (and possibly will be saved to). More...

const std::string &	getSceneFile () const
	Get the name of the file this component was in. More...

virtual void	preInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual void	postInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)
	OBSOLETE METHOD, kept for backwards compatibility. More...

virtual bool	loadXMLParameters (const char *xmlString)
	OBSOLETE METHOD, kept for backwards compatibility. More...

InputPinBase *	getInputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

OutputPinBase *	getOutputPin (const char *strName)
	Returns pointer to an output pin with specified name. More...

RequestInputPinBase *	getRequestInputPin (const char *strName)
	Returns pointer to an request input pin with specified name. More...

RequestOutputPinBase *	getRequestOutputPin (const char *strName)
	Returns pointer to an input pin with specified name. More...

Protected Member Functions
bool	sendMousePosIfReady ()

bool	keyToString (int key, std::string *str)

	DECLARE_OUTPUT (Key, MessageString)

	DECLARE_OUTPUT (MousePosition, MessageVec2)

	DECLARE_OUTPUT (MouseButton, MessageString)

	DECLARE_OUTPUT (MouseDoubleButton, MessageString)

	DECLARE_OUTPUT (MouseScroll, MessageString)

Protected Attributes
unsigned int	mouse_button

osg::Vec2	mouse_position

std::map< int, osg::Timer_t >	autorepeat_map

std::map< int, bool >	keydown_map

osg::Timer	timer

bool	new_mouse_pos_ready

int	mouseUpdateCounter

EventDispatcher *	pEventDispatcher

Protected Attributes inherited from vrecko::Device
int	id
	device ID More...

std::string	device_type
	device type More...

std::string	port_name
	name of the port More...

Protected Attributes inherited from vrecko::BaseClass
AttributeMap	attribute

MTReadWriteLock	attributeLock

std::string	senderString

MTLock	notificationsLock

std::vector < NOTIFICATION_DESCRIPTION >	notifications

long int	priority

const std::string *	sceneFile

PinList	inputPinsList

PinList	outputPinsList

PinList	requestInputPinsList

PinList	requestOutputPinsList

Additional Inherited Members
Public Types inherited from vrecko::BaseClass
enum	NotificationTypes { NOTIFICATION_DELETE_CLASS = 1, NOTIFICATION_EO_REGISTERING = 2, NOTIFICATION_EO_UNREGISTERING = 4, NOTIFICATION_PROGRAM_TERMINATION = 8, NOTIFICATION_ALL = 0xFFFFFFFF }

Protected Types inherited from vrecko::BaseClass
typedef std::map< std::string, int >	AttributeMap
	Attributes. More...

typedef std::vector < osg::ref_ptr< IOPinBase > >	PinList

Detailed Description

Class KeyboardMouse serves for processing the keyboard and mouse actions.

Constructor & Destructor Documentation

KeyboardMouse::KeyboardMouse ( )

KeyboardMouse::~KeyboardMouse ( )

Member Function Documentation

virtual void vreckoDP_base::KeyboardMouse::accept ( osgGA::GUIEventHandlerVisitor & v )

inlinevirtual

void KeyboardMouse::buttonPress	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa,
		float	mx,
		float	my,
		unsigned int	mb
	)

void KeyboardMouse::buttonRelease	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa,
		float	mx,
		float	my,
		unsigned int	mb
	)

int vreckoDP_base::KeyboardMouse::calibrateDevice ( void )

inlinevirtual

Device calibration.

Reimplemented from vrecko::Device.

int KeyboardMouse::closeDevice ( void )

virtual

Closes device.

Implements vrecko::Device.

vreckoDP_base::KeyboardMouse::DECLARE_OUTPUT	(	Key	,
		MessageString
	)

protected

vreckoDP_base::KeyboardMouse::DECLARE_OUTPUT	(	MousePosition	,
		MessageVec2
	)

protected

vreckoDP_base::KeyboardMouse::DECLARE_OUTPUT	(	MouseButton	,
		MessageString
	)

protected

vreckoDP_base::KeyboardMouse::DECLARE_OUTPUT	(	MouseDoubleButton	,
		MessageString
	)

protected

vreckoDP_base::KeyboardMouse::DECLARE_OUTPUT	(	MouseScroll	,
		MessageString
	)

protected

void KeyboardMouse::doubleButtonPress	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa,
		float	mx,
		float	my,
		unsigned int	mb
	)

bool KeyboardMouse::handle	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa
	)

virtual

bool vreckoDP_base::KeyboardMouse::idle ( )

inline

bool vreckoDP_base::KeyboardMouse::isKeyDown ( int keyCode )

inline

void KeyboardMouse::keyPress ( int key )

void KeyboardMouse::keyRelease ( int key )

bool KeyboardMouse::keyToString	(	int	key,
		std::string *	str
	)

protected

void KeyboardMouse::mouseMotion	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa
	)

void KeyboardMouse::mouseScroll ( osgGA::GUIEventAdapter::ScrollingMotion )

int KeyboardMouse::openDevice ( void )

virtual

Opens device and performs the initialization routines.

Implements vrecko::Device.

void vreckoDP_base::KeyboardMouse::passiveMouseMotion	(	const osgGA::GUIEventAdapter &	ea,
		osgGA::GUIActionAdapter &	aa,
		float	mx,
		float	my
	)

bool KeyboardMouse::sendMousePosIfReady ( )

protected

void vreckoDP_base::KeyboardMouse::shutdown ( )

inline

void KeyboardMouse::specialKeyPress ( int key )

void KeyboardMouse::specialKeyRelease ( int key )

void KeyboardMouse::update ( void )

virtual

Updates the device - scan device and send required outputs.

Implements vrecko::Device.

Member Data Documentation

std::map<int, osg::Timer_t> vreckoDP_base::KeyboardMouse::autorepeat_map

protected

std::map<int, bool> vreckoDP_base::KeyboardMouse::keydown_map

protected

unsigned int vreckoDP_base::KeyboardMouse::mouse_button

protected

osg::Vec2 vreckoDP_base::KeyboardMouse::mouse_position

protected

int vreckoDP_base::KeyboardMouse::mouseUpdateCounter

protected

bool vreckoDP_base::KeyboardMouse::new_mouse_pos_ready

protected

EventDispatcher* vreckoDP_base::KeyboardMouse::pEventDispatcher

protected

osg::Timer vreckoDP_base::KeyboardMouse::timer

protected

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

C:/Documents/School/OSG/VRECKO/include/vreckoDP/base/KeyboardMouse.h
C:/Documents/School/OSG/VRECKO/src/vreckoDP/base/KeyboardMouse.cpp

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation