#include <VRPN3DMouse.h>

Inheritance diagram for vreckoDP_base::VRPN3DMouse:

Public Member Functions
	VRPN3DMouse ()

virtual int	openDevice (void)

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

void	processEvent (const std::string &input_name, void *value)

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

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

void	VRPN3DMouse::sendAnalogEvent (osg::Vec3 p, osg::Vec3 o)

void	VRPN3DMouse::sendButtonEvent (u_int key, u_int state)

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 int	calibrateDevice (void)
	Device calibration. 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 (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
	DECLARE_OUTPUT (Button, vrecko::MessageString)

	DECLARE_OUTPUT (Position, vrecko::MessageVec3)

	DECLARE_OUTPUT (Move, vrecko::MessageVec3)

	DECLARE_OUTPUT (Rotation, vrecko::MessageQuat)

	DECLARE_OUTPUT (Orientation, vrecko::MessageQuat)

Static Protected Member Functions
static void VRPN_CALLBACK	handle_analog (void *userdata, vrpn_ANALOGCB b)

static void VRPN_CALLBACK	handle_button (void *userdata, vrpn_BUTTONCB b)

Protected Attributes
vrecko::EventDispatcher *	pEventDispatcher

vrpn_Analog_Remote *	ana

vrpn_Button_Remote *	but

HANDLE	vrpnServerHandle

osg::Vec3	_originPos

osg::Vec3	_curMove

osg::Quat	_originRot

osg::Quat	_curRotate

float	_speedFactor

float	_rotateRatio

bool	_speedControl

bool	_axisControl

bool	_rotateControl

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

Constructor & Destructor Documentation

VRPN3DMouse::VRPN3DMouse ( )

Member Function Documentation

int VRPN3DMouse::closeDevice ( void )

virtual

Closes device.

Implements vrecko::Device.

vreckoDP_base::VRPN3DMouse::DECLARE_OUTPUT	(	Button	,
		vrecko::MessageString
	)

protected

vreckoDP_base::VRPN3DMouse::DECLARE_OUTPUT	(	Position	,
		vrecko::MessageVec3
	)

protected

vreckoDP_base::VRPN3DMouse::DECLARE_OUTPUT	(	Move	,
		vrecko::MessageVec3
	)

protected

vreckoDP_base::VRPN3DMouse::DECLARE_OUTPUT	(	Rotation	,
		vrecko::MessageQuat
	)

protected

vreckoDP_base::VRPN3DMouse::DECLARE_OUTPUT	(	Orientation	,
		vrecko::MessageQuat
	)

protected

void VRPN_CALLBACK VRPN3DMouse::handle_analog	(	void *	userdata,
		vrpn_ANALOGCB	b
	)

staticprotected

Handlers for analog input and buttons

void VRPN_CALLBACK VRPN3DMouse::handle_button	(	void *	userdata,
		vrpn_BUTTONCB	b
	)

staticprotected

bool VRPN3DMouse::loadXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

The preInitialize(), loadXMLParameters() and postInitialize() methods were replaced in 2011 by a single method initialize().

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode)

Returns: (bool)

Reimplemented from vrecko::BaseClass.

int VRPN3DMouse::openDevice ( void )

virtual

Inherited functions from Device class

Implements vrecko::Device.

void VRPN3DMouse::processEvent	(	const std::string &	input_name,
		void *	value
	)

void VRPN3DMouse::update ( void )

virtual

Updates the device - scan device and send required outputs.

Implements vrecko::Device.

void vreckoDP_base::VRPN3DMouse::VRPN3DMouse::sendAnalogEvent	(	osg::Vec3 *	p,
		osg::Vec3 *	o
	)

Processing of analog and button events

void vreckoDP_base::VRPN3DMouse::VRPN3DMouse::sendButtonEvent	(	u_int	key,
		u_int	state
	)

Member Data Documentation

bool vreckoDP_base::VRPN3DMouse::_axisControl

protected

osg::Vec3 vreckoDP_base::VRPN3DMouse::_curMove

protected

osg::Quat vreckoDP_base::VRPN3DMouse::_curRotate

protected

osg::Vec3 vreckoDP_base::VRPN3DMouse::_originPos

protected

osg::Quat vreckoDP_base::VRPN3DMouse::_originRot

protected

bool vreckoDP_base::VRPN3DMouse::_rotateControl

protected

float vreckoDP_base::VRPN3DMouse::_rotateRatio

protected

bool vreckoDP_base::VRPN3DMouse::_speedControl

protected

float vreckoDP_base::VRPN3DMouse::_speedFactor

protected

vrpn_Analog_Remote* vreckoDP_base::VRPN3DMouse::ana

protected

vrpn_Button_Remote* vreckoDP_base::VRPN3DMouse::but

protected

vrecko::EventDispatcher* vreckoDP_base::VRPN3DMouse::pEventDispatcher

protected

HANDLE vreckoDP_base::VRPN3DMouse::vrpnServerHandle

protected

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

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

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation