ceJoystick.h

Go to the documentation of this file.

/* --- Source License
 * Author  : FX Programmer.
 * Contact : CorEngine@gmail.com
 *
 * Copyright (c) 2010 by FX Programmer.
 *
 * This source code 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 source code 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.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *    1. The origin of this software must not be misrepresented; you must not
 *       claim that you wrote the original software. If you use this software
 *       in a product, an acknowledgement in the product documentation would be
 *       appreciated but is not required.
 *    2. Altered source versions must be clearly marked as such, and must not
 *       be misrepresented as being the original software.
 *    3. Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this source code; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301, USA.
 */

 #ifndef _CE_JOYSTICK_H_
 #define _CE_JOYSTICK_H_ 0x1 
 #ifndef CE_WITHOUT_JOYSTICK

 #ifndef __cplusplus
 #error ceJoystick.h requires C++ compilation (use a .cpp suffix)
 #endif

 #if __GNUC__ >= 0x3
 #pragma GCC system_header
 #endif

 #if _MSC_VER > 1000
 #pragma once
 #pragma warning(disable: 4100)
 #endif

 #include "ceInputDevice.h"
 #include "begin_code.h"

 #ifndef _MMSYSTEM_H
 #define JOYSTICKID1 0x0
 #define JOYSTICKID2 0x1

 #define JOY_BUTTON1 0x1
 #define JOY_BUTTON2 0x2
 #define JOY_BUTTON3 0x4
 #define JOY_BUTTON4 0x8
 #endif

 namespace ce {

// ---                                              class SJoystickState--- */

 struct DECLSPEC SJoystickState
 {
  unsigned int x; 
  unsigned int y; 
  unsigned int z; 
  unsigned int buttons; 

  /* unsigned int xmin; // !< Minimum X-coordinate.
  unsigned int ymin; // !< Minimum Y-coordinate.
  unsigned int zmin; // !< Minimum Z-coordinate.

  unsigned int xmax; // !< Maximum X-coordinate.
  unsigned int ymax; // !< Maximum Y-coordinate.
  unsigned int zmax; // !< Maximum Z-coordinate.

  unsigned int num_buttons; // !< Number of joystick buttons.
  unsigned int max_buttons; // !< Maximum number of buttons supported by the joystick.
  unsigned int num_axes; // !< Number of axes currently in use by the joystick.
  unsigned int max_axes; // !< Maximum number of axes supported by the joystick. */

  inline SJoystickState(void) : x(0x0), y(0x0), z(0x0), buttons(0x0) { };

  inline SJoystickState(const SJoystickState &State) :
     x(State.x), y(State.y), z(State.z), buttons(State.buttons) { };

  const SJoystickState& APICALL 
    operator = (const SJoystickState &State)
  {
    if (this == &State) return *(this);

    this -> x = State.x;
    this -> y = State.y;
    this -> z = State.z;
    this -> buttons = State.buttons;

    return *(this);
  };

  const SJoystickState* APICALL 
    operator -> (void) const
  { return this; };

 };

 inline const int APICALL 
  operator == (const SJoystickState &StateA, const SJoystickState &StateB)
 {
  if ((StateA.x != StateB.x) || (StateA.y != StateB.y) || 
      (StateA.z != StateB.z) || (StateA.buttons != StateB.buttons))
    return FALSE;
 }

 inline const int APICALL 
  operator != (const SJoystickState &StateA, const SJoystickState &StateB)
 {
  if ((StateA.x != StateB.x) || (StateA.y != StateB.y) || 
      (StateA.z != StateB.z) || (StateA.buttons != StateB.buttons))
    return TRUE;
 }

// ---                                                                  --- */

// ---                                             class IJoystickEvent --- */

 class IJoystickDevice;

 class DECLSPEC IJoystickEvent
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IJoystickEvent(void) { };
    #endif

    virtual void APICALL 
      OnJoyButtonPressed(const IJoystickDevice *Owner, const int joyid, 
        const unsigned int button, const SJoystickState &State) = 0;

    virtual void APICALL 
      OnJoyButtonReleased(const IJoystickDevice *Owner, const int joyid, 
        const unsigned int button, const SJoystickState &State) = 0;

    virtual void APICALL 
      OnJoystickEvent(const IJoystickDevice *Owner, 
        const int joyid, const SJoystickState &State) = 0;

 };

// ---                                                                  --- */

// ---                                            class IJoystickDevice --- */

 class IJoystickDevice : public IInputDevice
 {
  public:

    #ifndef DOXYGEN_SHOULD_SKIP_THIS
    virtual ~IJoystickDevice(void) { };
    #endif

    virtual int APICALL
      GetNumSupported(void) const = 0;

    virtual int APICALL
      IsJoyButtonPressed(
        const int joyid = 0x0, const int button = 0x0) const = 0;

    virtual int APICALL
      IsJoyButtonReleased(
        const int joyid = 0x0, const int button = 0x0) const = 0;

    virtual int APICALL
      GetJoyPosition(const int joyid, unsigned int *get_x, unsigned int *get_y, 
        unsigned int *get_z = NULL) const = 0;

    virtual unsigned int APICALL
      GetJoyXPosition(const int joyid = 0x0) const = 0;

    virtual unsigned int APICALL
      GetJoyYPosition(const int joyid = 0x0) const = 0;

    virtual unsigned int APICALL
      GetJoyZPosition(const int joyid = 0x0) const = 0;

    // virtual unsigned int APICALL
    //   GetCurrentJoystick(const int joyid) const = 0;

    virtual void APICALL 
      SetJoystickEvent(IJoystickEvent *Event) const = 0;

    virtual IJoystickEvent* APICALL 
      GetJoystickEvent(void) const = 0;

 };

// ---                                          end class IJoystickDevice --- */

 } // end namespace ce

 #include "close_code.h"

 #if _MSC_VER > 1000
 #pragma warning(default:4100)
 #endif

 #endif // CE_WITHOUT_JOYSTICK
 #endif // _CE_JOYSTICK_H_