vrecko
virtual reality framework
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
navigation::AvatarInHand Class Reference

#include <AvatarInHand.h>

Inheritance diagram for navigation::AvatarInHand:
vrecko::Ability vrecko::BaseClass

Public Member Functions

 AvatarInHand ()
 
 ~AvatarInHand ()
 
void postInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
void processEvent (const std::string &input_name, VreckoMessage *message)
 
void initialize (void)
 
void update (void)
 This method is called periodically in case this instance is registered in Scheduler. 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...
 
std::string getAcceptableMessages (void)
 
- 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...
 
BaseClassgetOwner (void)
 Returns the ability owner. More...
 
virtual ParameterVectorgetParameterVector (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 VreckoMessageprocessRequest (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 void preInitialize (void)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
virtual bool loadXMLParameters (const char *xmlString)
 OBSOLETE METHOD, kept for backwards compatibility. More...
 
InputPinBasegetInputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 
OutputPinBasegetOutputPin (const char *strName)
 Returns pointer to an output pin with specified name. More...
 
RequestInputPinBasegetRequestInputPin (const char *strName)
 Returns pointer to an request input pin with specified name. More...
 
RequestOutputPinBasegetRequestOutputPin (const char *strName)
 Returns pointer to an input pin with specified name. More...
 

Protected Member Functions

 DECLARE_OUTPUT (Position, MessageVec3)
 
 DECLARE_OUTPUT (Orientation, MessageQuat)
 
- 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...
 
IOPinBasefindPinInList (const char *strName, PinList *pinList)
 Internal method to find a given pin in a given list. More...
 

Protected Attributes

EnvironmentObjecteo
 
osg::Vec3 _actual_position
 
osg::Vec3 _last_position
 
World::AvatarViewav
 
osg::Vec3 avatar_position
 
osg::Vec3 avatar_look_at
 
osg::Vec3 avatar_up_vector
 
osg::Vec3 _actual_left_hand_position
 
osg::Vec3 _actual_right_hand_position
 
osg::Vec3 _actual_head_position
 
osg::Quat _actual_left_hand_orientation
 
osg::Quat _actual_right_hand_orientation
 
osg::Quat _actual_head_orientation
 
osg::Vec3 grab_position
 
osg::Quat * qc
 
osg::Quat * qc_old
 
osg::Quat * qd_old2
 
osg::Quat * qd
 
osg::Quat * qd_old
 
osg::Quat * qd_init
 
osg::Quat q
 
double angle
 
bool absolut
 
bool pom
 
bool fly
 
bool start
 
osg::Vec3 av_pos
 
string mesg
 
bool immersive
 
float const_d
 
- Protected Attributes inherited from vrecko::Ability
BaseClasspOwner
 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

AvatarInHand::AvatarInHand ( )
navigation::AvatarInHand::~AvatarInHand ( )
inline

Member Function Documentation

navigation::AvatarInHand::DECLARE_OUTPUT ( Position  ,
MessageVec3   
)
protected
navigation::AvatarInHand::DECLARE_OUTPUT ( Orientation  ,
MessageQuat   
)
protected
std::string navigation::AvatarInHand::getAcceptableMessages ( void  )
inline
void AvatarInHand::initialize ( void  )
bool AvatarInHand::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 AvatarInHand::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 AvatarInHand::processEvent ( const std::string &  input_name,
VreckoMessage message 
)
virtual

Receives an Event.

Reimplemented from vrecko::BaseClass.

XERCES_CPP_NAMESPACE_QUALIFIER DOMNode * AvatarInHand::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 AvatarInHand::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::Quat navigation::AvatarInHand::_actual_head_orientation
protected
osg::Vec3 navigation::AvatarInHand::_actual_head_position
protected
osg::Quat navigation::AvatarInHand::_actual_left_hand_orientation
protected
osg::Vec3 navigation::AvatarInHand::_actual_left_hand_position
protected
osg::Vec3 navigation::AvatarInHand::_actual_position
protected
osg::Quat navigation::AvatarInHand::_actual_right_hand_orientation
protected
osg::Vec3 navigation::AvatarInHand::_actual_right_hand_position
protected
osg::Vec3 navigation::AvatarInHand::_last_position
protected
bool navigation::AvatarInHand::absolut
protected
double navigation::AvatarInHand::angle
protected
World::AvatarView* navigation::AvatarInHand::av
protected
osg::Vec3 navigation::AvatarInHand::av_pos
protected
osg::Vec3 navigation::AvatarInHand::avatar_look_at
protected
osg::Vec3 navigation::AvatarInHand::avatar_position
protected
osg::Vec3 navigation::AvatarInHand::avatar_up_vector
protected
float navigation::AvatarInHand::const_d
protected
EnvironmentObject* navigation::AvatarInHand::eo
protected
bool navigation::AvatarInHand::fly
protected
osg::Vec3 navigation::AvatarInHand::grab_position
protected
bool navigation::AvatarInHand::immersive
protected
string navigation::AvatarInHand::mesg
protected
bool navigation::AvatarInHand::pom
protected
osg::Quat navigation::AvatarInHand::q
protected
osg::Quat* navigation::AvatarInHand::qc
protected
osg::Quat* navigation::AvatarInHand::qc_old
protected
osg::Quat* navigation::AvatarInHand::qd
protected
osg::Quat* navigation::AvatarInHand::qd_init
protected
osg::Quat* navigation::AvatarInHand::qd_old
protected
osg::Quat* navigation::AvatarInHand::qd_old2
protected
bool navigation::AvatarInHand::start
protected

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