BaseController.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 :: Modules                               *
*                                                                             *
* Authors: The SOFA Team and external contributors (see Authors.txt)          *
*                                                                             *
* Contact information: contact@sofa-framework.org                             *
******************************************************************************/
//
// C++ Interface: Controller
//
// Description: 
//
//
// Author: Pierre-Jean Bensoussan, Digital Trainers (2008)
//
// Copyright: See COPYING file that comes with this distribution
//
//

#ifndef SOFA_COMPONENT_CONTROLLER_BASECONTROLLER_H
#define SOFA_COMPONENT_CONTROLLER_BASECONTROLLER_H

#include <sofa/core/objectmodel/BaseObject.h>

namespace sofa
{
namespace core
{
namespace objectmodel
{

class Event;
class MouseEvent;
class OmniEvent;
class KeypressedEvent;
class KeyreleasedEvent;
class JoystickEvent;

}
}
}

namespace sofa
{

namespace component
{

namespace controller
{

class BaseController : public virtual core::objectmodel::BaseObject
{

public:
    BaseController();

    virtual void onMouseEvent(core::objectmodel::MouseEvent *){};

    virtual void onOmniEvent(core::objectmodel::OmniEvent *){};

    virtual void onKeyPressedEvent(core::objectmodel::KeypressedEvent *){};

    virtual void onKeyReleasedEvent(core::objectmodel::KeyreleasedEvent *){};

    virtual void onJoystickEvent(core::objectmodel::JoystickEvent *){};

    virtual void onBeginAnimationStep(void){};

    virtual void onEndAnimationStep(void){};

protected:

    Data< bool > handleEventTriggersUpdate; 
    
private:

    void handleEvent(core::objectmodel::Event *);
};

} // namespace controller

} // namespace component

} // namespace sofa

#endif // SOFA_COMPONENT_CONTROLLER_BASECONTROLLER_H