lib/gamepad/gamepad.h

Go to the documentation of this file.

/*
 * gamepad.h
 *
 * Copyright (C) 2008-2010  Thomas A. Vaughan
 * All rights reserved.
 *
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above copyright
 *       notice, this list of conditions and the following disclaimer in the
 *       documentation and/or other materials provided with the distribution.
 *     * Neither the name of the <organization> nor the
 *       names of its contributors may be used to endorse or promote products
 *       derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THOMAS A. VAUGHAN ''AS IS'' AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL THOMAS A. VAUGHAN BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 *
 * Gamepad object.  This is a completely data-driven concept.
 */

#ifndef GAMEPAD_GAMEPAD_H__
#define GAMEPAD_GAMEPAD_H__

// includes --------------------------------------------------------------------
#include "gamepad-map.h"

#include "i18n/i18n.h"


namespace gamepad {


/// \ingroup gamepad_api
/// \defgroup gamepadlib Gamepad Library
/*@{*/



/// an instance of a physical gamepad.
class Gamepad {
public:
        // virtual destructor --------------------------------------------------
        virtual ~Gamepad(void) throw();

        // gamepad::Gamepad class interface methods ----------------------------

        /// what type of gamepad is this?  This object (gamepad::Type) will tell
        ///     you how many buttons, how many joysticks, etc.
        virtual Type * getType(void) const throw() = 0;

        /// get the ID (right now this is "source device:mapping" IDs)
        virtual const char * getId(void) throw() = 0;

        /// which source device is this?
        virtual const char * getSourceDeviceId(void) throw() = 0;

        /// which mapping is this gamepad using?
        virtual const char * getMappingId(void) throw() = 0;

        /// is the gamepad currently connected (sending events)?
        virtual eDeviceState getState(void) throw() = 0;

        /// if button with index X is pressed then bit X will be set
        virtual buttons_t getButtons(void) throw() = 0;

        /// retrieve the value of a particular button
        virtual eButton getButton(IN int idx) throw() = 0;

        /// retrieve the value of a particular joystick
        virtual void getJoystick(IN int idx,
                                OUT joystick_t& joy) throw() = 0;

        /// retrieve the value of a particular potentiometer
        virtual void getPot(IN int idx,
                                OUT pot_value_t& pv) throw() = 0;

        /// retrieve the value of a particular dpad
        virtual eDpad getDpad(IN int idx) throw() = 0;
};



////////////////////////////////////////////////////////////////////////////////
//
//      Gamepad API
//
////////////////////////////////////////////////////////////////////////////////



/// given previous + current button state, say what was pressed and released
static inline void getButtonsChanged(IN buttons_t prev_buttons,
                        IN buttons_t curr_buttons,
                        OUT buttons_t& pressed,
                        OUT buttons_t& released) throw()
        {
                buttons_t common = prev_buttons | curr_buttons;
                pressed = common - prev_buttons;
                released = common - curr_buttons;
        }


// localization helpers

/// return the localization manager for gamepad configuration
smart_ptr<i18n::Manager> getConfigLocaleMgr(IN const char * primaryLocale,
                        IN const char * defaultLocale,
                        IN nstream::Folder * dataDirectory);


/// return the localization manager for the specified gamepad::Type
smart_ptr<i18n::Manager> getTypeLocaleMgr(IN const Type * type,
                        IN const char * primaryLocale,
                        IN const char * defaultLocale,
                        IN nstream::Folder * dataDirectory);


};      // gamepad namespace

#endif  // GAMEPAD_GAMEPAD_H__