Modules/BehaviorControl/CommonXabsl2Symbols/JoystickSymbols.h

Go to the documentation of this file.

/** 
* @file JoystickSymbols.h
*
* Declaration of class JoystickSymbols.
*
* @author Matthias Jüngel
*/

#ifndef __JoystickSymbols_h_
#define __JoystickSymbols_h_

#include "../BehaviorControl.h"
#include "Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h"

/**
* The Xabsl2 symbols that are defined in "joystick-symbols.xml"
*
* @author Matthias Jüngel
*/ 
class JoystickSymbols : public Xabsl2FunctionProvider, public BehaviorControlInterfaces
{
public:
/*
* Constructor.
* @param interfaces The paramters of the BehaviorControl module.
  */
  JoystickSymbols(const BehaviorControlInterfaces& interfaces);
  
  /** registers the symbols at an engine */
  void registerSymbols(Xabsl2Engine& engine);
  
    /** updates the symbols */
  void update();

  //!@name Input symbols
  //!@{
  int getJoystickButton(); /*!< A function for the symbol "joystick-data.button" */
  double getJoystickTimeSinceLastMessage(); /*!< A function for the symbol "joystick-data.time-since-last-message" */
  double getSpecialActionId(); /*!< A function for the symbol "joystick-data.special-action-id" */
  //!@}
};


#endif // __JoystickSymbols_h_

---