navigation::KMTracker Class Reference

#include <KMTracker.h>

Inheritance diagram for navigation::KMTracker:

Public Member Functions
	KMTracker ()
	~KMTracker ()
void	preInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...
void	postInitialize (void)
	OBSOLETE METHOD, kept for backwards compatibility. More...
void	processEvent (const std::string &input_name, VreckoMessage *message)
	Internal method for processing the events. More...
bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *parametersNode)
	OBSOLETE METHOD, kept for backwards compatibility. More...
XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *	saveXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *)
	Save current setting into a XML node. More...
void	update (void)
	This method is called periodically in case this instance is registered in Scheduler. More...
Public Member Functions inherited from vrecko::Ability
virtual	~Ability ()
	copy constructor More...
const std::string &	getName () const
	Returns the ability name. More...
void	setPluginName (const char *pName)
	Sets the plugin name. More...
const std::string &	getPluginName (void) const
	Returns the plugin name. More...
const std::string &	getID (void) const
	Returns ability the identification string. More...
void	setID (const char *pID)
	(Internal usage, most people should not need to use it.) Sets the ability ID. More...
virtual void	clean (void)
void	setOwner (BaseClass *owner)
	(Internal usage, most people should not need to use it.) Sets ability owner. *l This method is called automatically in World::createAbility(), so one would (almost?) never want to use it directly. More...
BaseClass *	getOwner (void)
	Returns the ability owner. More...
virtual ParameterVector *	getParameterVector (void)
	Return vector of the parameter description. More...
bool	isUpdated (void)
	Set update flag. More...
virtual const std::string &	getSenderString (void)
	Returns the identification string of sender. 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...
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 VreckoMessage *	processRequest (const std::string &request_input_name, VreckoMessage *pMessage)
	Internal method for processing the requests. 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 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 Types
enum	Plane_type { plane_xz = 0, plane_xy, plane_yz }

Protected Member Functions
void	KMTracker::sendSensorInfo (bool rightHand)
	DECLARE_OUTPUT (Orientation, MessageQuat)
	DECLARE_OUTPUT (Move, MessageVec3)
	DECLARE_OUTPUT (MoveLocal, MessageVec3)
	DECLARE_OUTPUT (PositionRight, MessageVec3)
	DECLARE_OUTPUT (PositionLeft, MessageVec3)
	DECLARE_OUTPUT (OrientationRight, MessageQuat)
	DECLARE_OUTPUT (OrientationLeft, MessageQuat)
	DECLARE_OUTPUT (ButtonLeft, MessageBool)
	DECLARE_OUTPUT (ButtonRight, MessageBool)
	DECLARE_OUTPUT (LH_ButtonLeft, MessageBool)
	DECLARE_OUTPUT (LH_ButtonRight, MessageBool)
	DECLARE_OUTPUT (Sensor_Transformation, vrecko::MessageSensorTransformation)
Protected Member Functions inherited from vrecko::Ability
	Ability (const char *theAbilityName)
Protected Member Functions inherited from vrecko::BaseClass
bool	sendNotifications (unsigned long notificationType, void *notificationData)
virtual int	processNotification (BaseClass *sender, unsigned long notificationType, void *notificationData)
	Process an incoming notification. More...
IOPinBase *	findPinInList (const char *strName, PinList *pinList)
	Internal method to find a given pin in a given list. More...

Protected Attributes
osg::Vec3	_actual_position
osg::Vec3	_last_position
World::AvatarView *	av
osg::Vec3	avatar_position
osg::Vec3	avatar_look_at
osg::Vec3	avatar_up_vector
osg::Vec3	smer3d
osg::Vec3	move_direction
osg::Vec3	hand_position_left
osg::Vec3	hand_position_right
osg::Quat	hand_orientation_left
osg::Quat	hand_orientation_right
osg::Vec4	direction
osg::Vec2	smer
double	vert
double	horiz
osg::Vec2	mouse_pos
osg::Vec2	old_mouse_pos
int	mouse_scroll
osg::Vec2	mouse_sensitivity_avatar
osg::Vec2	mouse_sensitivity_hands
float	move_step
float	rotation_step
Plane_type	move_plane
bool	moving
bool	stopped
bool	_avatarMovement
bool	right_hand
bool	alwaysSendOrientationWithPosition
int	i
std::string	mesg
World *	owner
Protected Attributes inherited from vrecko::Ability
BaseClass *	pOwner
	Pointer to the owner of this ability. (Almost?) always an EnvironmentObject class. More...
std::vector< std::string >	parameterString
bool	updated
	Update flag. It is used for save. 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::Ability
typedef std::vector < ParameterStruct >	ParameterVector
	Vector of the description of parameters. More...

Member Enumeration Documentation

enum navigation::KMTracker::Plane_type

protected

Enumerator
plane_xz
plane_xy
plane_yz

Constructor & Destructor Documentation

KMTracker::KMTracker

(

)

navigation::KMTracker::~KMTracker ( )

inline

Member Function Documentation

navigation::KMTracker::DECLARE_OUTPUT ( Orientation  , MessageQuat    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( Move  , MessageVec3    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( MoveLocal  , MessageVec3    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( PositionRight  , MessageVec3    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( PositionLeft  , MessageVec3    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( OrientationRight  , MessageQuat    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( OrientationLeft  , MessageQuat    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( ButtonLeft  , MessageBool    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( ButtonRight  , MessageBool    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( LH_ButtonLeft  , MessageBool    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( LH_ButtonRight  , MessageBool    )

protected

navigation::KMTracker::DECLARE_OUTPUT ( Sensor_Transformation  , vrecko::MessageSensorTransformation    )

protected

void navigation::KMTracker::KMTracker::sendSensorInfo ( bool  rightHand )

protected

bool KMTracker::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.

void KMTracker::postInitialize ( void  )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

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

Reimplemented from vrecko::BaseClass.

void KMTracker::preInitialize ( void  )

virtual

OBSOLETE METHOD, kept for backwards compatibility.

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

Reimplemented from vrecko::BaseClass.

void KMTracker::processEvent ( const std::string &  input_name, VreckoMessage *  pMessage  )

virtual

Internal method for processing the events.

After the message reimplementation, this is a method, which redistributes the events into your methods attached to the respective inputs. There is usually now no need to override this method or interact with it in any way. You can usually easily define your inputs via the DECLARE_INPUT and INIT_INPUT macros and declare handling method using the METHOD_INPUT macro.

Internally, this method is used to process all the messages and find the appropriate handling method defined by the METHOD_INPUT.

Parameters

input_name	(const std::string &) Name of the input pin
pMessage	(VreckoMessage *) Pointer to the message. This will be automatically cast to the correct message type, if you are using the DECLARE_INPUT (etc.) macros.

Returns

(void)

Reimplemented from vrecko::BaseClass.

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * KMTracker::saveXMLParameters ( XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument *  )

virtual

Save current setting into a XML node.

Warning

Currently not supported. It is safe to leave it without overriding.

Parameters

*	(XERCES_CPP_NAMESPACE_QUALIFIER DOMDocument)

Returns

(XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *)

Reimplemented from vrecko::BaseClass.

void KMTracker::update ( void  )

virtual

This method is called periodically in case this instance is registered in Scheduler.

The method is called periodically at specified frequency or every frame. Use the Scheduler::addEntity() method to register your class and set the frequency.

Reimplemented from vrecko::BaseClass.

Member Data Documentation

osg::Vec3 navigation::KMTracker::_actual_position

protected

bool navigation::KMTracker::_avatarMovement

protected

osg::Vec3 navigation::KMTracker::_last_position

protected

bool navigation::KMTracker::alwaysSendOrientationWithPosition

protected

World::AvatarView* navigation::KMTracker::av

protected

osg::Vec3 navigation::KMTracker::avatar_look_at

protected

osg::Vec3 navigation::KMTracker::avatar_position

protected

osg::Vec3 navigation::KMTracker::avatar_up_vector

protected

osg::Vec4 navigation::KMTracker::direction

protected

osg::Quat navigation::KMTracker::hand_orientation_left

protected

osg::Quat navigation::KMTracker::hand_orientation_right

protected

osg::Vec3 navigation::KMTracker::hand_position_left

protected

osg::Vec3 navigation::KMTracker::hand_position_right

protected

double navigation::KMTracker::horiz

protected

int navigation::KMTracker::i

protected

std::string navigation::KMTracker::mesg

protected

osg::Vec2 navigation::KMTracker::mouse_pos

protected

int navigation::KMTracker::mouse_scroll

protected

osg::Vec2 navigation::KMTracker::mouse_sensitivity_avatar

protected

osg::Vec2 navigation::KMTracker::mouse_sensitivity_hands

protected

osg::Vec3 navigation::KMTracker::move_direction

protected

Plane_type navigation::KMTracker::move_plane

protected

float navigation::KMTracker::move_step

protected

bool navigation::KMTracker::moving

protected

osg::Vec2 navigation::KMTracker::old_mouse_pos

protected

World* navigation::KMTracker::owner

protected

bool navigation::KMTracker::right_hand

protected

float navigation::KMTracker::rotation_step

protected

osg::Vec2 navigation::KMTracker::smer

protected

osg::Vec3 navigation::KMTracker::smer3d

protected

bool navigation::KMTracker::stopped

protected

double navigation::KMTracker::vert

protected

---

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

• C:/Documents/School/OSG/VRECKO/include/vreckoAP/navigation/KMTracker.h
• C:/Documents/School/OSG/VRECKO/src/vreckoAP/navigation/KMTracker.cpp