OSDLJoystick.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_H_
#define OSDL_JOYSTICK_H_


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


#include <string>
#include <list>



// 'struct SDL_Joystick ;' already forward-declared.




namespace OSDL
{



    namespace Events
    {

        
        
        #if ! defined(OSDL_USES_SDL) || OSDL_USES_SDL 
    
        /*
         * No way of forward declaring LowLevelJoystick apparently:
         * we would have liked to specify 'struct LowLevelThing ;' here and
         * in the implementation file (.cc): 'typedef BackendThing
         * LowLevelThing' but then the compiler finds they are conflicting
         * declarations.
         *
         */
        typedef ::SDL_Joystick LowLevelJoystick ;

        #else // OSDL_USES_SDL

        struct LowLevelJoystick {} ;

        #endif // OSDL_USES_SDL
        
        
        
        class OSDL_DLL Joystick: public OSDL::Events::InputDevice
        {
        
        

            /*
             * The joystick handler has to trigger the joystick event callbacks
             * for this joystick.
             *
             */
            friend class OSDL::Events::JoystickHandler ;

            
            
            public:



                explicit Joystick( JoystickNumber index ) ;
                
                
                
                virtual ~Joystick() throw() ;
                
                
                
                virtual const std::string & getName() const ;
                             
                             
                 
                virtual bool isOpen() const ;
                
                
                
                virtual void open() ; 
                 
                 
                 
                virtual void close() ;


                                            
                virtual JoystickAxesCount getNumberOfAxes() const ;
                
                
                
                virtual JoystickTrackballsCount getNumberOfTrackballs() const ;
                
                
                
                virtual JoystickHatsCount getNumberOfHats() const ;
                
                
                
                virtual JoystickButtonsCount getNumberOfButtons() const ;
                 
                
                
                virtual AxisPosition getAbscissaPosition() const ;
                 
                 
                 
                virtual AxisPosition getOrdinatePosition() const ;
                 
                 
                 
                virtual AxisPosition getPositionOfAxis( 
                    JoystickAxesCount index ) const ;                
                    
                    
                            
                virtual HatPosition getPositionOfHat( 
                    JoystickHatsCount index ) const ;                
                
                
                            
                virtual bool isButtonPressed( 
                    JoystickButtonsCount buttonNumber ) const  ;
            
            
            
                virtual bool getPositionOfTrackball( 
                    JoystickTrackballsCount ball,
                    BallMotion & deltaX, BallMotion & deltaY ) const ;  
                    
                            
                                                    
                virtual void update() ;
                
                
                                
                virtual const std::string toString( 
                    Ceylan::VerbosityLevels level = Ceylan::high ) const  ;
                
                
                
                
            
        protected:
        
                
                
                virtual JoystickNumber getIndex() const ;
    
    
    
                /*
                 * Event-driven callbacks for input propagation, from
                 * the joystick handler to this joystick.
                 *
                 */
                
    
    
                virtual void axisChanged( 
                    const JoystickAxisEvent & joystickEvent ) ;
    
    
                            
                virtual void trackballChanged( 
                    const JoystickTrackballEvent & joystickEvent ) ;
    
    
                            
                virtual void hatChanged( 
                    const JoystickHatEvent & joystickEvent ) ;
    
    
    
                virtual void buttonPressed( 
                    const JoystickButtonEvent & joystickEvent ) ;
    
    
    
                virtual void buttonReleased( 
                    const JoystickButtonEvent & joystickEvent ) ;
    

                
                std::string _name ;
                
                
                
                JoystickNumber _index ;
                
                        
                                
                LowLevelJoystick * _internalJoystick ;
    
    
                
                JoystickAxesCount _axisCount ;



                JoystickTrackballsCount _trackballCount ;



                JoystickHatsCount _hatCount ;



                JoystickButtonsCount _buttonCount ;




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



#endif // OSDL_JOYSTICK_H_

---