JoystickEvent.h

Go to the documentation of this file.

/******************************************************************************
*       SOFA, Simulation Open-Framework Architecture, version 1.0 beta 3      *
*                (c) 2006-2008 MGH, INRIA, USTL, UJF, CNRS                    *
*                                                                             *
* This library is free software; you can redistribute it and/or modify it     *
* under the terms of the GNU Lesser General Public License as published by    *
* the Free Software Foundation; either version 2.1 of the License, or (at     *
* your option) any later version.                                             *
*                                                                             *
* This library is distributed in the hope that it will be useful, but WITHOUT *
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or       *
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License *
* for more details.                                                           *
*                                                                             *
* You should have received a copy of the GNU Lesser General Public License    *
* along with this library; if not, write to the Free Software Foundation,     *
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA.          *
*******************************************************************************
*                              SOFA :: Framework                              *
*                                                                             *
* Authors: M. Adam, J. Allard, B. Andre, P-J. Bensoussan, S. Cotin, C. Duriez,*
* H. Delingette, F. Falipou, F. Faure, S. Fonteneau, L. Heigeas, C. Mendoza,  *
* M. Nesme, P. Neumann, J-P. de la Plata Alcade, F. Poyer and F. Roy          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
//
// C++ Interface: JoystickEvent
//
// Description: 
//
//
// Author: Pierre-Jean Bensoussan, Digital Trainers (2008)
//
// Copyright: See COPYING file that comes with this distribution
//
//
// This file is a work based on the open source release of VGSDK.
//
// VGSDK - Copyright (C) 2008, Nicolas Papier.
// Distributed under the terms of the GNU Library General Public License (LGPL)
// as published by the Free Software Foundation.
// Author Nicolas Papier
// Author Guillaume Brocker
//

#ifndef SOFA_CORE_OBJECTMODEL_JOYSTICKEVENT_H
#define SOFA_CORE_OBJECTMODEL_JOYSTICKEVENT_H

#include <sofa/core/objectmodel/Event.h>
#include <vector>

namespace sofa
{

namespace core
{

namespace objectmodel
{

class JoystickEvent : public sofa::core::objectmodel::Event
{
public:

    class AxisEvent
    {
    public:
        AxisEvent( const int /*index*/, const float /*value*/ );

        virtual ~AxisEvent(){};

        int getIndex() const;

        float getValue() const;

    private:
        const int   m_index;    
        const float m_value;    
    };



    class ButtonEvent
    {
    public:
        ButtonEvent( const int  buttonStates = 0 );

        virtual ~ButtonEvent(){};

        void setButtons(const int);

        bool getButton(const int) const;


    private:
        bool m_buttons[32]; 
    };



    class HatEvent
    {
    public: 
        typedef enum
        {
            CENTERED    = 0,
            UP          = 1 << 0,
            RIGHT       = 1 << 1,
            DOWN        = 1 << 2,
            LEFT        = 1 << 3,
            UP_RIGHT    = UP|RIGHT,
            DOWN_RIGHT  = DOWN|RIGHT,
            DOWN_LEFT   = DOWN|LEFT,
            UP_LEFT     = UP|LEFT
        } State;


        HatEvent( const int /*index*/, const State /*state*/ );

        virtual ~HatEvent(){};

        int getIndex() const;

        State getState() const;

    private:

        const int   m_index;    
        const State m_state;    
    };



    const AxisEvent *getAxisEvent(const int /*index*/) const;

    const std::vector<AxisEvent*> &getAxisEvents(void) const;

    unsigned int getAxisEventsSize(void) const;

    void addAxisEvent( AxisEvent * );



    ButtonEvent *getButtonEvent(void) const;

    bool getButton(unsigned int /*index*/) const;

    void setButtonEvent( ButtonEvent * );



    const HatEvent *getHatEvent(const int /*index*/) const;

    const std::vector<HatEvent*> &getHatEvents(void) const;

    unsigned int getHatEventsSize(void) const;

    void addHatEvent( HatEvent * );



    JoystickEvent();

    virtual ~JoystickEvent();

protected:
    
    std::vector< AxisEvent* > axisEvents; 
    ButtonEvent *buttonEvent; 
    std::vector< HatEvent* > hatEvents; 

private:

};

} // namespace objectmodel

} // namespace core

} // namespace sofa

#endif // SOFA_CORE_OBJECTMODEL_JOYSTICKEVENT_H