blender/source/gameengine/GameLogic/SCA_MouseSensor.h
Jorge Bernal 6ffc988ae3 BGE Clean-up: New EXP prefix for the BGE Expression module
The expression module now uses an EXP prefix and it follows a
distribution similar to blender.

Additionally the hash function in EXP_HashedPtr.h was simplified and the
files EXP_C-Api.h &.EXP_C-Api.cpp were deleted because were unused.

Reviewers: campbellbarton, moguri, sybren, hg1

Projects: #game_engine

Differential Revision: https://developer.blender.org/D1221
2015-07-12 16:58:12 +02:00

121 lines
3.1 KiB
C++

/*
* ***** BEGIN GPL LICENSE BLOCK *****
*
* 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.
*
* 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,
* Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
* 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): José I. Romero (cleanup and fixes)
*
* ***** END GPL LICENSE BLOCK *****
*/
/** \file SCA_MouseSensor.h
* \ingroup gamelogic
* \brief Senses mouse events
*/
#ifndef __SCA_MOUSESENSOR_H__
#define __SCA_MOUSESENSOR_H__
#include "SCA_ISensor.h"
#include "EXP_BoolValue.h"
#include "SCA_IInputDevice.h"
class SCA_MouseSensor : public SCA_ISensor
{
Py_Header
/**
* Use SCA_IInputDevice values to encode the mouse mode for now.
*/
short int m_mousemode;
/**
* Triggermode true means all mouse events trigger. Useful mainly
* for button presses.
*/
bool m_triggermode;
/**
* Remember the last state update
*/
int m_val;
SCA_IInputDevice::KX_EnumInputs m_hotkey;
/**
* valid x coordinate, MUST be followed by y coordinate
*/
short m_x;
/**
* valid y coordinate
*/
short m_y;
public:
/**
* Allowable modes for the trigger status of the mouse sensor.
*/
enum KX_MOUSESENSORMODE {
KX_MOUSESENSORMODE_NODEF = 0,
KX_MOUSESENSORMODE_LEFTBUTTON,
KX_MOUSESENSORMODE_MIDDLEBUTTON,
KX_MOUSESENSORMODE_RIGHTBUTTON,
KX_MOUSESENSORMODE_WHEELUP,
KX_MOUSESENSORMODE_WHEELDOWN,
KX_MOUSESENSORMODE_POSITION,
KX_MOUSESENSORMODE_POSITIONX,
KX_MOUSESENSORMODE_POSITIONY,
KX_MOUSESENSORMODE_MOVEMENT,
KX_MOUSESENSORMODE_MAX
};
bool isValid(KX_MOUSESENSORMODE);
SCA_MouseSensor(class SCA_MouseManager* keybdmgr,
int startx,int starty,
short int mousemode,
SCA_IObject* gameobj);
virtual ~SCA_MouseSensor();
virtual CValue* GetReplica();
virtual bool Evaluate();
virtual void Init();
virtual bool IsPositiveTrigger();
short int GetModeKey();
SCA_IInputDevice::KX_EnumInputs GetHotKey();
void setX(short x);
void setY(short y);
static void UpdateHotkey(void *self);
#ifdef WITH_PYTHON
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
static int UpdateHotkeyPy(void *self, const PyAttributeDef *);
// get button status
KX_PYMETHOD_DOC_O(SCA_MouseSensor,getButtonStatus);
#endif
};
#endif /* __SCA_MOUSESENSOR_H__ */