OSDLClassicalJoystick.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_CLASSICAL_JOYSTICK_H_
#define OSDL_CLASSICAL_JOYSTICK_H_


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

#include <string>
#include <list>



namespace OSDL
{



    namespace Events
    {
    
        
            
        
        class OSDL_DLL ClassicalJoystick: public Joystick
        {
        
            
            /*
             * The joystick handler has to trigger the joystick event callbacks
             * for this classical joystick.
             *
             */
            friend class OSDL::Events::JoystickHandler ;
            
            
            
            public:



                explicit ClassicalJoystick( JoystickNumber index, 
                    AxisPosition deadZoneExtent = DefaultDeadZoneExtent ) ;
                
                
                
                virtual ~ClassicalJoystick() throw() ;
                


                virtual void getDeadZoneValues( AxisPosition & firstAxisExtent, 
                    AxisPosition & secondAxisExtent ) const ;
                    
                
                
                virtual void setDeadZoneValues( 
                    AxisPosition firstAxisExtent  = DefaultDeadZoneExtent,
                    AxisPosition secondAxisExtent = DefaultDeadZoneExtent ) ;
                    
                    
                                
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const ;
                
                
                
                static const AxisPosition DefaultDeadZoneExtent ;
                
            
            
            
            
        protected:
        
        

                /*
                 * Event-driven callbacks for input propagation, from
                 * the joystick handler to this classical joystick.
                 *
                 */

                
                
                virtual void axisChanged( 
                    const JoystickAxisEvent & joystickEvent ) ;
        
        
        
                virtual void buttonPressed( 
                    const JoystickButtonEvent & joystickEvent ) ;
    
    
    
                virtual void buttonReleased( 
                    const JoystickButtonEvent & joystickEvent ) ;
                


                AxisPosition _deadZoneExtentFirstAxis ;



                AxisPosition _deadZoneExtentSecondAxis ;




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



#endif // OSDL_CLASSICAL_JOYSTICK_H_

---