blender/source/gameengine/GameLogic/SCA_MouseSensor.h
Campbell Barton 6b9f3b5f5c BGE Python API
Remove the last of the odd C++/python wrapper code from http://www.python.org/doc/PyCPP.html (~1998)

* Use python subclasses rather then having fake subclassing through get/set attributes calling parent types.
* PyObject getset arrays are created while initializing the types, converted from our own attribute arrays. This way python deals with subclasses and we dont have to define getattro or setattro functions for each type.
* GameObjects and Scenes no longer have attribute access to properties. only dictionary style access - ob['prop']
* remove each class's get/set/dir functions.
* remove isA() methods, can use PyObject_TypeCheck() in C and issubclass() in python.
* remove Parents[] array for each C++ class, was only used for isA() and wasnt correct in quite a few cases.
* remove PyTypeObject that was being passed as the last argument to each class (the parent classes too).

TODO -
* Light and VertexProxy need to be converted to using attributes.
* memory for getset arrays is never freed, not that bad since its will only allocates once.
2009-06-28 11:22:26 +00:00

125 lines
3.2 KiB
C++

/**
* Senses mouse events
*
* $Id$
*
* ***** 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 *****
*/
#ifndef __KX_MOUSESENSOR
#define __KX_MOUSESENSOR
#include "SCA_ISensor.h"
#include "BoolValue.h"
#include "SCA_IInputDevice.h"
class SCA_MouseSensor : public SCA_ISensor
{
Py_Header;
class SCA_MouseManager* m_pMouseMgr;
/**
* 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);
static int UpdateHotkey(void *self, const PyAttributeDef*);
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);
/* --------------------------------------------------------------------- */
/* Python interface ---------------------------------------------------- */
/* --------------------------------------------------------------------- */
//Deprecated functions ----->
/* read x-coordinate */
KX_PYMETHOD_DOC_NOARGS(SCA_MouseSensor,GetXPosition);
/* read y-coordinate */
KX_PYMETHOD_DOC_NOARGS(SCA_MouseSensor,GetYPosition);
//<----- deprecated
// get button status
KX_PYMETHOD_DOC_O(SCA_MouseSensor,getButtonStatus);
};
#endif //__KX_MOUSESENSOR