#include <Avatar.h>

Inheritance diagram for base::Avatar:

Public Member Functions
	Avatar ()

	~Avatar ()

void	preInitialize (void)

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

void	update (void)
	This method is called periodically in case this instance is registered in Scheduler. More...

bool	loadXMLParameters (XERCES_CPP_NAMESPACE_QUALIFIER DOMNode *pParametersNode)
	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...

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 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...

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 Member Functions
void	setOrientationKeepUp (osg::Quat *newOrientation)
	Sets the new orientation and updates it to point up ("naturally"). More...

void	updatePosRot (bool bUpdatePos, bool bUpdateRot, osg::Vec3 position, osg::Quat orientation)

	DECLARE_INPUT (FreeMovement, MessageBool)

	DECLARE_INPUT (Move, MessageVec3)

	DECLARE_INPUT (MoveLocal, MessageVec3)

	DECLARE_INPUT (Rotation, MessageQuat)
	This means a relative rotation. More...

	DECLARE_INPUT (RotationKeepUp, MessageQuat)

	DECLARE_INPUT (Position, MessageVec3)

	DECLARE_INPUT (Orientation, MessageQuat)
	This means an absolute orientation. More...

	DECLARE_INPUT (OrientationKeepUp, MessageQuat)

	DECLARE_INPUT (DebugOutputViewPosition, MessageVoid)

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
World::AvatarView	avatar_view

osg::Quat	orientation

EnvironmentObject *	head

EnvironmentObject *	left_hand

EnvironmentObject *	right_hand

EnvironmentObject *	left_leg

EnvironmentObject *	right_leg

EnvironmentObject *	free_move_EO

long int	headEO_ID

long int	leftHandEO_ID

long int	rightHandEO_ID

long int	freeMoveEO_ID

osg::Vec3	cursor_shift

EnvironmentObject *	owner

bool	gravity_mode

osg::Vec3	reference_point

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...

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

Avatar::Avatar ( )

Avatar::~Avatar ( )

Member Function Documentation

base::Avatar::DECLARE_INPUT	(	FreeMovement	,
		MessageBool
	)

protected

base::Avatar::DECLARE_INPUT	(	Move	,
		MessageVec3
	)

protected

base::Avatar::DECLARE_INPUT	(	MoveLocal	,
		MessageVec3
	)

protected

base::Avatar::DECLARE_INPUT	(	Rotation	,
		MessageQuat
	)

protected

This means a relative rotation.

base::Avatar::DECLARE_INPUT	(	RotationKeepUp	,
		MessageQuat
	)

protected

base::Avatar::DECLARE_INPUT	(	Position	,
		MessageVec3
	)

protected

base::Avatar::DECLARE_INPUT	(	Orientation	,
		MessageQuat
	)

protected

This means an absolute orientation.

base::Avatar::DECLARE_INPUT	(	OrientationKeepUp	,
		MessageQuat
	)

protected

base::Avatar::DECLARE_INPUT	(	DebugOutputViewPosition	,
		MessageVoid
	)

protected

bool Avatar::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 Avatar::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 Avatar::preInitialize ( void )

virtual

Process the Events.

Reimplemented from vrecko::BaseClass.

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * Avatar::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 Avatar::setOrientationKeepUp ( osg::Quat * newOrientation )

protected

Sets the new orientation and updates it to point up ("naturally").

void Avatar::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.

void Avatar::updatePosRot	(	bool	bUpdatePos,
		bool	bUpdateRot,
		osg::Vec3 *	position,
		osg::Quat *	orientation
	)

protected

Member Data Documentation

World::AvatarView base::Avatar::avatar_view

protected

osg::Vec3 base::Avatar::cursor_shift

protected

EnvironmentObject* base::Avatar::free_move_EO

protected

long int base::Avatar::freeMoveEO_ID

protected

bool base::Avatar::gravity_mode

protected

EnvironmentObject* base::Avatar::head

protected

long int base::Avatar::headEO_ID

protected

EnvironmentObject* base::Avatar::left_hand

protected

EnvironmentObject* base::Avatar::left_leg

protected

long int base::Avatar::leftHandEO_ID

protected

osg::Quat base::Avatar::orientation

protected

EnvironmentObject* base::Avatar::owner

protected

osg::Vec3 base::Avatar::reference_point

protected

EnvironmentObject * base::Avatar::right_hand

protected

EnvironmentObject * base::Avatar::right_leg

protected

long int base::Avatar::rightHandEO_ID

protected

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

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

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation