OSDLJoystickHandler.h

Go to the documentation of this file.

/* 
 * Copyright (C) 2003-2009 Olivier Boudeville
 *
 * This file is part of the OSDL library.
 *
 * The OSDL library is free software: you can redistribute it and/or modify
 * it under the terms of either the GNU Lesser General Public License or
 * the GNU General Public License, as they are published by the Free Software
 * Foundation, either version 3 of these Licenses, or (at your option) 
 * any later version.
 *
 * The OSDL 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 and the GNU General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License and of the GNU General Public License along with the OSDL library.
 * If not, see <http://www.gnu.org/licenses/>.
 *
 * Author: Olivier Boudeville (olivier.boudeville@esperide.com)
 *
 */


#ifndef OSDL_JOYSTICK_HANDLER_H_
#define OSDL_JOYSTICK_HANDLER_H_



#include "OSDLInputDeviceHandler.h"   // for inheritance
#include "OSDLJoystickCommon.h"       // for JoystickNumber, etc.


#include <string>
#include <list>




namespace OSDL
{



    namespace MVC
    {

        /*
         * The joystick handler can propagate joystick events to the relevant
         * controllers.
         *
         */
        class Controller ;
    
    }

        
        
    namespace Events
    {
    
    
    
        // Manages joysticks.
        class Joystick ;
        

        
        
        class OSDL_DLL JoystickHandler: public InputDeviceHandler
        {
        
        
            /*
             * The events module has to trigger the joystick event callbacks
             * of this joystick handler.
             *
             */
            friend class OSDL::Events::EventsModule ;


            
            public:



                explicit JoystickHandler( bool useClassicalJoysticks = true ) ;
                
                
                
                virtual ~JoystickHandler() throw() ;



                virtual void update() ;



                virtual void openJoystick( JoystickNumber index ) ;
    
    
    
                virtual void linkToController( JoystickNumber index, 
                    OSDL::MVC::Controller & controller ) ;
                 
            
            
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                
                
                
                // Static section.
                
                 
                 
                static JoystickNumber GetAvailableJoystickCount() ;
                
                
                
                
        protected:
                            
                
                
                /*
                 * Event-driven callbacks for input propagation, from
                 * the Events module to this handler.
                 *
                 */
                 
                 
                 
                virtual void axisChanged( 
                    const JoystickAxisEvent & joystickEvent ) const ;
                            
                            
                            
                virtual void trackballChanged( 
                    const JoystickTrackballEvent & joystickEvent ) const ;
                    
                            
                            
                virtual void hatChanged( 
                    const JoystickHatEvent & joystickEvent ) const ;
                
                
                            
                virtual void buttonPressed( 
                    const JoystickButtonEvent & joystickEvent ) const ;
                        
                        
                            
                virtual void buttonReleased( 
                    const JoystickButtonEvent & joystickEvent ) const ;
                        


                virtual void blank() ;
                            
                            
                
                virtual void checkJoystickAt( JoystickNumber index ) const ;
                
                
                
                                
                JoystickNumber _joystickCount ;
                
                 
                 
                Joystick ** _joysticks ;
                
                
                
                bool _useClassicalJoysticks ;




            private:
        
        
        
                explicit JoystickHandler( const JoystickHandler & source ) ;
            
            
            
                JoystickHandler & operator = ( 
                    const JoystickHandler & source ) ;
                                        
                
                
        } ;
        
    
    }   
    
}



#endif // OSDL_JOYSTICK_HANDLER_H_

---