blender/source/gameengine/GamePlayer/common/GPC_MouseDevice.h

106 lines
3.2 KiB
C
Raw Normal View History

/*
* ***** BEGIN GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
2002-10-12 11:37:38 +00:00
*
* This program 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software Foundation,
2010-02-12 13:34:04 +00:00
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
2002-10-12 11:37:38 +00:00
*
* The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
* All rights reserved.
*
* The Original Code is: all of this file.
*
* Contributor(s): none yet.
*
* ***** END GPL LICENSE BLOCK *****
2002-10-12 11:37:38 +00:00
*/
/** \file GPC_MouseDevice.h
* \ingroup player
*/
#ifndef __GPC_MOUSEDEVICE_H__
#define __GPC_MOUSEDEVICE_H__
2002-10-12 11:37:38 +00:00
#ifdef WIN32
#pragma warning (disable:4786)
#endif /* WIN32 */
2002-10-12 11:37:38 +00:00
#include "SCA_IInputDevice.h"
/**
* Generic Ketsji mouse device.
* \see SCA_IInputDevice
2002-10-12 11:37:38 +00:00
*/
class GPC_MouseDevice : public SCA_IInputDevice
{
public:
/**
* Button identifier.
*/
typedef enum {
buttonLeft,
buttonMiddle,
buttonRight,
buttonWheelUp,
buttonWheelDown
2002-10-12 11:37:38 +00:00
} TButtonId;
GPC_MouseDevice();
virtual ~GPC_MouseDevice(void);
virtual bool IsPressed(SCA_IInputDevice::KX_EnumInputs inputcode);
virtual void NextFrame();
/**
* Call this routine to update the mouse device when a button state changes.
* \param button Which button state changes.
* \param isDown The new state of the button.
* \param x Position x-coordinate of the cursor at the time of the state change.
* \param y Position y-coordinate of the cursor at the time of the state change.
* \return Indication as to whether the event was processed.
2002-10-12 11:37:38 +00:00
*/
virtual bool ConvertButtonEvent(TButtonId button, bool isDown);
/**
* Call this routine to update the mouse device when a button state and
* cursor position changes at the same time (e.g. in Win32 messages).
* \param button Which button state changes.
* \param isDown The new state of the button.
* \param x Position x-coordinate of the cursor at the time of the state change.
* \param y Position y-coordinate of the cursor at the time of the state change.
* \return Indication as to whether the event was processed.
2002-10-12 11:37:38 +00:00
*/
virtual bool ConvertButtonEvent(TButtonId button, bool isDown, int x, int y);
/**
* Call this routine to update the mouse device when the cursor has moved.
* \param x Position x-coordinate of the cursor.
* \param y Position y-coordinate of the cursor.
* \return Indication as to whether the event was processed.
2002-10-12 11:37:38 +00:00
*/
virtual bool ConvertMoveEvent(int x, int y);
protected:
/**
* This routine converts a single mouse event to a Ketsji mouse event.
* \param kxevent Ketsji event code.
* \param eventval Value for this event.
* \return Indication as to whether the event was processed.
2002-10-12 11:37:38 +00:00
*/
virtual bool ConvertEvent(KX_EnumInputs kxevent, int eventval, unsigned int unicode);
2002-10-12 11:37:38 +00:00
};
#endif /* __GPC_MOUSEDEVICE_H__ */