Main Page | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages

# Modules/BehaviorControl/CommonXabsl2Symbols/JoystickSymbols.h

Go to the documentation of this file.

    00001 /**
    00002 * @file JoystickSymbols.h
    00003 *
    00004 * Declaration of class JoystickSymbols.
    00005 *
    00006 * @author Matthias Jüngel
    00007 */
    00008
    00009 #ifndef __JoystickSymbols_h_
    00010 #define __JoystickSymbols_h_
    00011
    00012 #include "../BehaviorControl.h"
    00013 #include "Tools/Xabsl2/Xabsl2Engine/Xabsl2Engine.h"
    00014
    00015 /**
    00016 * The Xabsl2 symbols that are defined in "joystick-symbols.xml"
    00017 *
    00018 * @author Matthias Jüngel
    00019 */
    00020 class JoystickSymbols : public Xabsl2FunctionProvider, public BehaviorControlInterfaces
    00021 {
    00022 public:
    00023 /*
    00024 * Constructor.
    00025 * @param interfaces The paramters of the BehaviorControl module.
    00026   */
    00027   JoystickSymbols(const BehaviorControlInterfaces& interfaces);
    00028
    00029   /** registers the symbols at an engine */
    00030   void registerSymbols(Xabsl2Engine& engine);
    00031
    00032     /** updates the symbols */
    00033   void update();
    00034
    00035   //!@name Input symbols
    00036   //!@{
    00037   int getJoystickButton(); /*!< A function for the symbol "joystick-data.button" */
    00038   double getJoystickTimeSinceLastMessage(); /*!< A function for the symbol "joystick-data.time-since-last-message" */
    00039   double getSpecialActionId(); /*!< A function for the symbol "joystick-data.special-action-id" */
    00040   //!@}
    00041 };
    00042
    00043
    00044 #endif // __JoystickSymbols_h_
    00045