c8b4cf9206
svn merge https://svn.blender.org/svnroot/bf-blender/trunk/blender -r19820:HEAD Notes: * Game and sequencer RNA, and sequencer header are now out of date a bit after changes in trunk. * I didn't know how to port these bugfixes, most likely they are not needed anymore. * Fix "duplicate strip" always increase the user count for ipo. * IPO pinning on sequencer strips was lost during Undo.
860 lines
24 KiB
C++
860 lines
24 KiB
C++
/**
|
|
* $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): none yet.
|
|
*
|
|
* ***** END GPL LICENSE BLOCK *****
|
|
* Sensor for keyboard input
|
|
*/
|
|
#include "SCA_KeyboardSensor.h"
|
|
#include "SCA_KeyboardManager.h"
|
|
#include "SCA_LogicManager.h"
|
|
#include "StringValue.h"
|
|
#include "SCA_IInputDevice.h"
|
|
|
|
#ifdef HAVE_CONFIG_H
|
|
#include <config.h>
|
|
#endif
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Native functions */
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
SCA_KeyboardSensor::SCA_KeyboardSensor(SCA_KeyboardManager* keybdmgr,
|
|
short int hotkey,
|
|
short int qual,
|
|
short int qual2,
|
|
bool bAllKeys,
|
|
const STR_String& targetProp,
|
|
const STR_String& toggleProp,
|
|
SCA_IObject* gameobj,
|
|
PyTypeObject* T )
|
|
:SCA_ISensor(gameobj,keybdmgr,T),
|
|
m_pKeyboardMgr(keybdmgr),
|
|
m_hotkey(hotkey),
|
|
m_qual(qual),
|
|
m_qual2(qual2),
|
|
m_bAllKeys(bAllKeys),
|
|
m_targetprop(targetProp),
|
|
m_toggleprop(toggleProp)
|
|
{
|
|
if (hotkey == SCA_IInputDevice::KX_ESCKEY)
|
|
keybdmgr->GetInputDevice()->HookEscape();
|
|
// SetDrawColor(0xff0000ff);
|
|
Init();
|
|
}
|
|
|
|
|
|
|
|
SCA_KeyboardSensor::~SCA_KeyboardSensor()
|
|
{
|
|
}
|
|
|
|
void SCA_KeyboardSensor::Init()
|
|
{
|
|
// this function is used when the sensor is disconnected from all controllers
|
|
// by the state engine. It reinitializes the sensor as if it was just created.
|
|
// However, if the target key is pressed when the sensor is reactivated, it
|
|
// will not generated an event (see remark in Evaluate()).
|
|
m_val = (m_invert)?1:0;
|
|
m_reset = true;
|
|
}
|
|
|
|
CValue* SCA_KeyboardSensor::GetReplica()
|
|
{
|
|
SCA_KeyboardSensor* replica = new SCA_KeyboardSensor(*this);
|
|
// this will copy properties and so on...
|
|
replica->ProcessReplica();
|
|
replica->Init();
|
|
return replica;
|
|
}
|
|
|
|
|
|
|
|
short int SCA_KeyboardSensor::GetHotkey()
|
|
{
|
|
return m_hotkey;
|
|
}
|
|
|
|
|
|
|
|
bool SCA_KeyboardSensor::IsPositiveTrigger()
|
|
{
|
|
bool result = (m_val != 0);
|
|
|
|
if (m_invert)
|
|
result = !result;
|
|
|
|
return result;
|
|
}
|
|
|
|
|
|
|
|
bool SCA_KeyboardSensor::TriggerOnAllKeys()
|
|
{
|
|
return m_bAllKeys;
|
|
}
|
|
|
|
|
|
|
|
bool SCA_KeyboardSensor::Evaluate()
|
|
{
|
|
bool result = false;
|
|
bool reset = m_reset && m_level;
|
|
bool qual = true;
|
|
bool qual_change = false;
|
|
short int m_val_orig = m_val;
|
|
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
// cerr << "SCA_KeyboardSensor::Eval event, sensing for "<< m_hotkey << " at device " << inputdev << "\n";
|
|
|
|
/* See if we need to do logging: togPropState exists and is
|
|
* different from 0 */
|
|
CValue* myparent = GetParent();
|
|
CValue* togPropState = myparent->GetProperty(m_toggleprop);
|
|
if (togPropState &&
|
|
(((int)togPropState->GetNumber()) != 0) )
|
|
{
|
|
LogKeystrokes();
|
|
}
|
|
|
|
m_reset = false;
|
|
|
|
/* Now see whether events must be bounced. */
|
|
if (m_bAllKeys)
|
|
{
|
|
bool justactivated = false;
|
|
bool justreleased = false;
|
|
bool active = false;
|
|
|
|
for (int i=SCA_IInputDevice::KX_BEGINKEY ; i<= SCA_IInputDevice::KX_ENDKEY;i++)
|
|
{
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) i);
|
|
switch (inevent.m_status)
|
|
{
|
|
case SCA_InputEvent::KX_JUSTACTIVATED:
|
|
justactivated = true;
|
|
break;
|
|
case SCA_InputEvent::KX_JUSTRELEASED:
|
|
justreleased = true;
|
|
break;
|
|
case SCA_InputEvent::KX_ACTIVE:
|
|
active = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (justactivated)
|
|
{
|
|
m_val=1;
|
|
result = true;
|
|
} else
|
|
{
|
|
if (justreleased)
|
|
{
|
|
m_val=(active)?1:0;
|
|
result = true;
|
|
} else
|
|
{
|
|
if (active)
|
|
{
|
|
if (m_val == 0)
|
|
{
|
|
m_val = 1;
|
|
if (m_level) {
|
|
result = true;
|
|
}
|
|
}
|
|
} else
|
|
{
|
|
if (m_val == 1)
|
|
{
|
|
m_val = 0;
|
|
result = true;
|
|
}
|
|
}
|
|
}
|
|
if (m_tap)
|
|
// special case for tap mode: only generate event for new activation
|
|
result = false;
|
|
}
|
|
|
|
|
|
} else
|
|
{
|
|
|
|
// cerr << "======= SCA_KeyboardSensor::Evaluate:: peeking at key status" << endl;
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue(
|
|
(SCA_IInputDevice::KX_EnumInputs) m_hotkey);
|
|
|
|
// cerr << "======= SCA_KeyboardSensor::Evaluate:: status: " << inevent.m_status << endl;
|
|
|
|
|
|
/* Check qualifier keys
|
|
* - see if the qualifiers we request are pressed - 'qual' true/false
|
|
* - see if the qualifiers we request changed their state - 'qual_change' true/false
|
|
*/
|
|
if (m_qual > 0) {
|
|
const SCA_InputEvent & qualevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) m_qual);
|
|
switch(qualevent.m_status) {
|
|
case SCA_InputEvent::KX_NO_INPUTSTATUS:
|
|
qual = false;
|
|
break;
|
|
case SCA_InputEvent::KX_JUSTRELEASED:
|
|
qual_change = true;
|
|
qual = false;
|
|
break;
|
|
case SCA_InputEvent::KX_JUSTACTIVATED:
|
|
qual_change = true;
|
|
}
|
|
}
|
|
if (m_qual2 > 0 && qual==true) {
|
|
const SCA_InputEvent & qualevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) m_qual2);
|
|
/* copy of above */
|
|
switch(qualevent.m_status) {
|
|
case SCA_InputEvent::KX_NO_INPUTSTATUS:
|
|
qual = false;
|
|
break;
|
|
case SCA_InputEvent::KX_JUSTRELEASED:
|
|
qual_change = true;
|
|
qual = false;
|
|
break;
|
|
case SCA_InputEvent::KX_JUSTACTIVATED:
|
|
qual_change = true;
|
|
}
|
|
}
|
|
/* done reading qualifiers */
|
|
|
|
if (inevent.m_status == SCA_InputEvent::KX_NO_INPUTSTATUS)
|
|
{
|
|
if (m_val == 1)
|
|
{
|
|
// this situation may occur after a scene suspend: the keyboard release
|
|
// event was not captured, produce now the event off
|
|
m_val = 0;
|
|
result = true;
|
|
}
|
|
} else
|
|
{
|
|
if (inevent.m_status == SCA_InputEvent::KX_JUSTACTIVATED)
|
|
{
|
|
m_val=1;
|
|
result = true;
|
|
} else
|
|
{
|
|
if (inevent.m_status == SCA_InputEvent::KX_JUSTRELEASED)
|
|
{
|
|
m_val = 0;
|
|
result = true;
|
|
} else
|
|
{
|
|
if (inevent.m_status == SCA_InputEvent::KX_ACTIVE)
|
|
{
|
|
if (m_val == 0)
|
|
{
|
|
m_val = 1;
|
|
if (m_level)
|
|
{
|
|
result = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/* Modify the key state based on qual(s)
|
|
* Tested carefuly. dont touch unless your really sure.
|
|
* note, this will only change the results if key modifiers are set.
|
|
*
|
|
* When all modifiers and keys are positive
|
|
* - pulse true
|
|
*
|
|
* When ANY of the modifiers or main key become inactive,
|
|
* - pulse false
|
|
*/
|
|
if (qual==false) { /* one of the qualifiers are not pressed */
|
|
if (m_val_orig && qual_change) { /* we were originally enabled, but a qualifier changed */
|
|
result = true;
|
|
} else {
|
|
result = false;
|
|
}
|
|
m_val = 0; /* since one of the qualifiers is not on, set the state to false */
|
|
} else { /* we done have any qualifiers or they are all pressed */
|
|
if (m_val && qual_change) { /* the main key state is true and our qualifier just changed */
|
|
result = true;
|
|
}
|
|
}
|
|
/* done with key quals */
|
|
|
|
}
|
|
|
|
if (reset)
|
|
// force an event
|
|
result = true;
|
|
return result;
|
|
|
|
}
|
|
|
|
void SCA_KeyboardSensor::AddToTargetProp(int keyIndex)
|
|
{
|
|
if (IsPrintable(keyIndex)) {
|
|
CValue* tprop = GetParent()->GetProperty(m_targetprop);
|
|
|
|
if (tprop) {
|
|
/* overwrite the old property */
|
|
if (IsDelete(keyIndex)) {
|
|
/* strip one char, if possible */
|
|
STR_String newprop = tprop->GetText();
|
|
int oldlength = newprop.Length();
|
|
if (oldlength >= 1 ) {
|
|
newprop.SetLength(oldlength - 1);
|
|
CStringValue * newstringprop = new CStringValue(newprop, m_targetprop);
|
|
GetParent()->SetProperty(m_targetprop, newstringprop);
|
|
newstringprop->Release();
|
|
}
|
|
} else {
|
|
/* append */
|
|
char pchar = ToCharacter(keyIndex, IsShifted());
|
|
STR_String newprop = tprop->GetText() + pchar;
|
|
CStringValue * newstringprop = new CStringValue(newprop, m_targetprop);
|
|
GetParent()->SetProperty(m_targetprop, newstringprop);
|
|
newstringprop->Release();
|
|
}
|
|
} else {
|
|
if (!IsDelete(keyIndex)) {
|
|
/* Make a new property. Deletes can be ignored. */
|
|
char pchar = ToCharacter(keyIndex, IsShifted());
|
|
STR_String newprop = pchar;
|
|
CStringValue * newstringprop = new CStringValue(newprop, m_targetprop);
|
|
GetParent()->SetProperty(m_targetprop, newstringprop);
|
|
newstringprop->Release();
|
|
}
|
|
}
|
|
}
|
|
|
|
}
|
|
|
|
/**
|
|
* Tests whether shift is pressed
|
|
*/
|
|
bool SCA_KeyboardSensor::IsShifted(void)
|
|
{
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
|
|
if ( (inputdev->GetEventValue(SCA_IInputDevice::KX_RIGHTSHIFTKEY).m_status
|
|
== SCA_InputEvent::KX_ACTIVE)
|
|
|| (inputdev->GetEventValue(SCA_IInputDevice::KX_RIGHTSHIFTKEY).m_status
|
|
== SCA_InputEvent::KX_JUSTACTIVATED)
|
|
|| (inputdev->GetEventValue(SCA_IInputDevice::KX_LEFTSHIFTKEY).m_status
|
|
== SCA_InputEvent::KX_ACTIVE)
|
|
|| (inputdev->GetEventValue(SCA_IInputDevice::KX_LEFTSHIFTKEY).m_status
|
|
== SCA_InputEvent::KX_JUSTACTIVATED)
|
|
) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
void SCA_KeyboardSensor::LogKeystrokes(void)
|
|
{
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
int num = inputdev->GetNumActiveEvents();
|
|
|
|
/* weird loop, this one... */
|
|
if (num > 0)
|
|
{
|
|
|
|
int index = 0;
|
|
/* Check on all keys whether they were pushed. This does not
|
|
* untangle the ordering, so don't type too fast :) */
|
|
for (int i=SCA_IInputDevice::KX_BEGINKEY ; i<= SCA_IInputDevice::KX_ENDKEY;i++)
|
|
{
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) i);
|
|
if (inevent.m_status == SCA_InputEvent::KX_JUSTACTIVATED) //NO_INPUTSTATUS)
|
|
{
|
|
if (index < num)
|
|
{
|
|
AddToTargetProp(i);
|
|
index++;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Python Functions */
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
//Deprecated ----->
|
|
/** 1. GetKey : check which key this sensor looks at */
|
|
const char SCA_KeyboardSensor::GetKey_doc[] =
|
|
"getKey()\n"
|
|
"\tReturn the code of the key this sensor is listening to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PyGetKey()
|
|
{
|
|
ShowDeprecationWarning("getKey()", "the key property");
|
|
return PyInt_FromLong(m_hotkey);
|
|
}
|
|
|
|
/** 2. SetKey: change the key to look at */
|
|
const char SCA_KeyboardSensor::SetKey_doc[] =
|
|
"setKey(keycode)\n"
|
|
"\t- keycode: any code from GameKeys\n"
|
|
"\tSet the key this sensor should listen to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PySetKey(PyObject* args)
|
|
{
|
|
ShowDeprecationWarning("setKey()", "the key property");
|
|
int keyCode;
|
|
|
|
if(!PyArg_ParseTuple(args, "i:setKey", &keyCode)) {
|
|
return NULL;
|
|
}
|
|
|
|
/* Since we have symbolic constants for this in Python, we don't guard */
|
|
/* anything. It's up to the user to provide a sensible number. */
|
|
m_hotkey = keyCode;
|
|
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
/** 3. GetHold1 : set the first bucky bit */
|
|
const char SCA_KeyboardSensor::GetHold1_doc[] =
|
|
"getHold1()\n"
|
|
"\tReturn the code of the first key modifier to the key this \n"
|
|
"\tsensor is listening to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PyGetHold1()
|
|
{
|
|
ShowDeprecationWarning("getHold1()", "the hold1 property");
|
|
return PyInt_FromLong(m_qual);
|
|
}
|
|
|
|
/** 4. SetHold1: change the first bucky bit */
|
|
const char SCA_KeyboardSensor::SetHold1_doc[] =
|
|
"setHold1(keycode)\n"
|
|
"\t- keycode: any code from GameKeys\n"
|
|
"\tSet the first modifier to the key this sensor should listen to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PySetHold1(PyObject* args)
|
|
{
|
|
ShowDeprecationWarning("setHold1()", "the hold1 property");
|
|
int keyCode;
|
|
|
|
if(!PyArg_ParseTuple(args, "i:setHold1", &keyCode)) {
|
|
return NULL;
|
|
}
|
|
|
|
/* Since we have symbolic constants for this in Python, we don't guard */
|
|
/* anything. It's up to the user to provide a sensible number. */
|
|
m_qual = keyCode;
|
|
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
/** 5. GetHold2 : get the second bucky bit */
|
|
const char SCA_KeyboardSensor::GetHold2_doc[] =
|
|
"getHold2()\n"
|
|
"\tReturn the code of the second key modifier to the key this \n"
|
|
"\tsensor is listening to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PyGetHold2()
|
|
{
|
|
ShowDeprecationWarning("getHold2()", "the hold2 property");
|
|
return PyInt_FromLong(m_qual2);
|
|
}
|
|
|
|
/** 6. SetHold2: change the second bucky bit */
|
|
const char SCA_KeyboardSensor::SetHold2_doc[] =
|
|
"setHold2(keycode)\n"
|
|
"\t- keycode: any code from GameKeys\n"
|
|
"\tSet the first modifier to the key this sensor should listen to.\n" ;
|
|
PyObject* SCA_KeyboardSensor::PySetHold2(PyObject* args)
|
|
{
|
|
ShowDeprecationWarning("setHold2()", "the hold2 property");
|
|
int keyCode;
|
|
|
|
if(!PyArg_ParseTuple(args, "i:setHold2", &keyCode)) {
|
|
return NULL;
|
|
}
|
|
|
|
/* Since we have symbolic constants for this in Python, we don't guard */
|
|
/* anything. It's up to the user to provide a sensible number. */
|
|
m_qual2 = keyCode;
|
|
|
|
Py_RETURN_NONE;
|
|
}
|
|
|
|
|
|
const char SCA_KeyboardSensor::GetPressedKeys_doc[] =
|
|
"getPressedKeys()\n"
|
|
"\tGet a list of pressed keys that have either been pressed, or just released this frame.\n" ;
|
|
|
|
PyObject* SCA_KeyboardSensor::PyGetPressedKeys()
|
|
{
|
|
ShowDeprecationWarning("getPressedKeys()", "events");
|
|
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
|
|
int num = inputdev->GetNumJustEvents();
|
|
PyObject* resultlist = PyList_New(num);
|
|
|
|
if (num > 0)
|
|
{
|
|
|
|
int index = 0;
|
|
|
|
for (int i=SCA_IInputDevice::KX_BEGINKEY ; i<= SCA_IInputDevice::KX_ENDKEY;i++)
|
|
{
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) i);
|
|
if ((inevent.m_status == SCA_InputEvent::KX_JUSTACTIVATED)
|
|
|| (inevent.m_status == SCA_InputEvent::KX_JUSTRELEASED))
|
|
{
|
|
PyObject* keypair = PyList_New(2);
|
|
PyList_SET_ITEM(keypair,0,PyInt_FromLong(i));
|
|
PyList_SET_ITEM(keypair,1,PyInt_FromLong(inevent.m_status));
|
|
PyList_SET_ITEM(resultlist,index,keypair);
|
|
index++;
|
|
|
|
if (index >= num) /* should not happen */
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return resultlist;
|
|
}
|
|
|
|
|
|
|
|
const char SCA_KeyboardSensor::GetCurrentlyPressedKeys_doc[] =
|
|
"getCurrentlyPressedKeys()\n"
|
|
"\tGet a list of keys that are currently pressed.\n" ;
|
|
|
|
PyObject* SCA_KeyboardSensor::PyGetCurrentlyPressedKeys()
|
|
{
|
|
ShowDeprecationWarning("getCurrentlyPressedKeys()", "events");
|
|
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
|
|
int num = inputdev->GetNumActiveEvents();
|
|
PyObject* resultlist = PyList_New(num);
|
|
|
|
if (num > 0)
|
|
{
|
|
int index = 0;
|
|
|
|
for (int i=SCA_IInputDevice::KX_BEGINKEY ; i<= SCA_IInputDevice::KX_ENDKEY;i++)
|
|
{
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) i);
|
|
if ( (inevent.m_status == SCA_InputEvent::KX_ACTIVE)
|
|
|| (inevent.m_status == SCA_InputEvent::KX_JUSTACTIVATED))
|
|
{
|
|
PyObject* keypair = PyList_New(2);
|
|
PyList_SET_ITEM(keypair,0,PyInt_FromLong(i));
|
|
PyList_SET_ITEM(keypair,1,PyInt_FromLong(inevent.m_status));
|
|
PyList_SET_ITEM(resultlist,index,keypair);
|
|
index++;
|
|
|
|
if (index >= num) /* should never happen */
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return resultlist;
|
|
}
|
|
|
|
//<---- Deprecated
|
|
|
|
KX_PYMETHODDEF_DOC_O(SCA_KeyboardSensor, getKeyStatus,
|
|
"getKeyStatus(keycode)\n"
|
|
"\tGet the given key's status (KX_NO_INPUTSTATUS, KX_JUSTACTIVATED, KX_ACTIVE or KX_JUSTRELEASED).\n")
|
|
{
|
|
if (!PyInt_Check(value)) {
|
|
PyErr_SetString(PyExc_ValueError, "sensor.getKeyStatus(int): Keyboard Sensor, expected an int");
|
|
return NULL;
|
|
}
|
|
|
|
int keycode = PyInt_AsLong(value);
|
|
|
|
if ((keycode < SCA_IInputDevice::KX_BEGINKEY)
|
|
|| (keycode > SCA_IInputDevice::KX_ENDKEY)){
|
|
PyErr_SetString(PyExc_AttributeError, "sensor.getKeyStatus(int): Keyboard Sensor, invalid keycode specified!");
|
|
return NULL;
|
|
}
|
|
|
|
SCA_IInputDevice* inputdev = m_pKeyboardMgr->GetInputDevice();
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) keycode);
|
|
return PyInt_FromLong(inevent.m_status);
|
|
}
|
|
|
|
/* ------------------------------------------------------------------------- */
|
|
/* Python Integration Hooks */
|
|
/* ------------------------------------------------------------------------- */
|
|
|
|
PyTypeObject SCA_KeyboardSensor::Type = {
|
|
#if (PY_VERSION_HEX >= 0x02060000)
|
|
PyVarObject_HEAD_INIT(NULL, 0)
|
|
#else
|
|
/* python 2.5 and below */
|
|
PyObject_HEAD_INIT( NULL ) /* required py macro */
|
|
0, /* ob_size */
|
|
#endif
|
|
"SCA_KeyboardSensor",
|
|
sizeof(PyObjectPlus_Proxy),
|
|
0,
|
|
py_base_dealloc,
|
|
0,
|
|
0,
|
|
0,
|
|
0,
|
|
py_base_repr,
|
|
0,0,0,0,0,0,
|
|
py_base_getattro,
|
|
py_base_setattro,
|
|
0,0,0,0,0,0,0,0,0,
|
|
Methods
|
|
};
|
|
|
|
PyParentObject SCA_KeyboardSensor::Parents[] = {
|
|
&SCA_KeyboardSensor::Type,
|
|
&SCA_ISensor::Type,
|
|
&SCA_ILogicBrick::Type,
|
|
&CValue::Type,
|
|
NULL
|
|
};
|
|
|
|
PyMethodDef SCA_KeyboardSensor::Methods[] = {
|
|
//Deprecated functions ------>
|
|
{"getKey", (PyCFunction) SCA_KeyboardSensor::sPyGetKey, METH_NOARGS, (PY_METHODCHAR)GetKey_doc},
|
|
{"setKey", (PyCFunction) SCA_KeyboardSensor::sPySetKey, METH_VARARGS, (PY_METHODCHAR)SetKey_doc},
|
|
{"getHold1", (PyCFunction) SCA_KeyboardSensor::sPyGetHold1, METH_NOARGS, (PY_METHODCHAR)GetHold1_doc},
|
|
{"setHold1", (PyCFunction) SCA_KeyboardSensor::sPySetHold1, METH_VARARGS, (PY_METHODCHAR)SetHold1_doc},
|
|
{"getHold2", (PyCFunction) SCA_KeyboardSensor::sPyGetHold2, METH_NOARGS, (PY_METHODCHAR)GetHold2_doc},
|
|
{"setHold2", (PyCFunction) SCA_KeyboardSensor::sPySetHold2, METH_VARARGS, (PY_METHODCHAR)SetHold2_doc},
|
|
{"getPressedKeys", (PyCFunction) SCA_KeyboardSensor::sPyGetPressedKeys, METH_NOARGS, (PY_METHODCHAR)GetPressedKeys_doc},
|
|
{"getCurrentlyPressedKeys", (PyCFunction) SCA_KeyboardSensor::sPyGetCurrentlyPressedKeys, METH_NOARGS, (PY_METHODCHAR)GetCurrentlyPressedKeys_doc},
|
|
//<----- Deprecated
|
|
KX_PYMETHODTABLE_O(SCA_KeyboardSensor, getKeyStatus),
|
|
{NULL,NULL} //Sentinel
|
|
};
|
|
|
|
PyAttributeDef SCA_KeyboardSensor::Attributes[] = {
|
|
KX_PYATTRIBUTE_RO_FUNCTION("events", SCA_KeyboardSensor, pyattr_get_events),
|
|
KX_PYATTRIBUTE_BOOL_RW("useAllKeys",SCA_KeyboardSensor,m_bAllKeys),
|
|
KX_PYATTRIBUTE_INT_RW("key",0,SCA_IInputDevice::KX_ENDKEY,true,SCA_KeyboardSensor,m_hotkey),
|
|
KX_PYATTRIBUTE_SHORT_RW("hold1",0,SCA_IInputDevice::KX_ENDKEY,true,SCA_KeyboardSensor,m_qual),
|
|
KX_PYATTRIBUTE_SHORT_RW("hold2",0,SCA_IInputDevice::KX_ENDKEY,true,SCA_KeyboardSensor,m_qual2),
|
|
KX_PYATTRIBUTE_STRING_RW("toggleProperty",0,100,false,SCA_KeyboardSensor,m_toggleprop),
|
|
KX_PYATTRIBUTE_STRING_RW("targetProperty",0,100,false,SCA_KeyboardSensor,m_targetprop),
|
|
{ NULL } //Sentinel
|
|
};
|
|
|
|
PyObject* SCA_KeyboardSensor::py_getattro(PyObject *attr)
|
|
{
|
|
py_getattro_up(SCA_ISensor);
|
|
}
|
|
|
|
PyObject* SCA_KeyboardSensor::py_getattro_dict() {
|
|
py_getattro_dict_up(SCA_ISensor);
|
|
}
|
|
|
|
int SCA_KeyboardSensor::py_setattro(PyObject *attr, PyObject *value)
|
|
{
|
|
py_setattro_up(SCA_ISensor);
|
|
}
|
|
|
|
|
|
PyObject* SCA_KeyboardSensor::pyattr_get_events(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
|
|
{
|
|
SCA_KeyboardSensor* self= static_cast<SCA_KeyboardSensor*>(self_v);
|
|
|
|
SCA_IInputDevice* inputdev = self->m_pKeyboardMgr->GetInputDevice();
|
|
|
|
PyObject* resultlist = PyList_New(0);
|
|
|
|
for (int i=SCA_IInputDevice::KX_BEGINKEY ; i<= SCA_IInputDevice::KX_ENDKEY;i++)
|
|
{
|
|
const SCA_InputEvent & inevent = inputdev->GetEventValue((SCA_IInputDevice::KX_EnumInputs) i);
|
|
if (inevent.m_status != SCA_InputEvent::KX_NO_INPUTSTATUS)
|
|
{
|
|
PyObject* keypair = PyList_New(2);
|
|
PyList_SET_ITEM(keypair,0,PyInt_FromLong(i));
|
|
PyList_SET_ITEM(keypair,1,PyInt_FromLong(inevent.m_status));
|
|
PyList_Append(resultlist,keypair);
|
|
}
|
|
}
|
|
return resultlist;
|
|
}
|
|
|
|
|
|
/* Accessed from python */
|
|
|
|
// this code looks ugly, please use an ordinary hashtable
|
|
|
|
char ToCharacter(int keyIndex, bool shifted)
|
|
{
|
|
/* numerals */
|
|
if ( (keyIndex >= SCA_IInputDevice::KX_ZEROKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_NINEKEY) ) {
|
|
if (shifted) {
|
|
char numshift[] = ")!@#$%^&*(";
|
|
return numshift[keyIndex - '0'];
|
|
} else {
|
|
return keyIndex - SCA_IInputDevice::KX_ZEROKEY + '0';
|
|
}
|
|
}
|
|
|
|
/* letters... always lowercase... is that desirable? */
|
|
if ( (keyIndex >= SCA_IInputDevice::KX_AKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_ZKEY) ) {
|
|
if (shifted) {
|
|
return keyIndex - SCA_IInputDevice::KX_AKEY + 'A';
|
|
} else {
|
|
return keyIndex - SCA_IInputDevice::KX_AKEY + 'a';
|
|
}
|
|
}
|
|
|
|
if (keyIndex == SCA_IInputDevice::KX_SPACEKEY) {
|
|
return ' ';
|
|
}
|
|
if (keyIndex == SCA_IInputDevice::KX_RETKEY || keyIndex == SCA_IInputDevice::KX_PADENTER) {
|
|
return '\n';
|
|
}
|
|
|
|
|
|
if (keyIndex == SCA_IInputDevice::KX_PADASTERKEY) {
|
|
return '*';
|
|
}
|
|
|
|
if (keyIndex == SCA_IInputDevice::KX_TABKEY) {
|
|
return '\t';
|
|
}
|
|
|
|
/* comma to period */
|
|
char commatoperiod[] = ",-.";
|
|
char commatoperiodshifted[] = "<_>";
|
|
if (keyIndex == SCA_IInputDevice::KX_COMMAKEY) {
|
|
if (shifted) {
|
|
return commatoperiodshifted[0];
|
|
} else {
|
|
return commatoperiod[0];
|
|
}
|
|
}
|
|
if (keyIndex == SCA_IInputDevice::KX_MINUSKEY) {
|
|
if (shifted) {
|
|
return commatoperiodshifted[1];
|
|
} else {
|
|
return commatoperiod[1];
|
|
}
|
|
}
|
|
if (keyIndex == SCA_IInputDevice::KX_PERIODKEY) {
|
|
if (shifted) {
|
|
return commatoperiodshifted[2];
|
|
} else {
|
|
return commatoperiod[2];
|
|
}
|
|
}
|
|
|
|
/* semicolon to rightbracket */
|
|
char semicolontorightbracket[] = ";\'`/\\=[]";
|
|
char semicolontorightbracketshifted[] = ":\"~\?|+{}";
|
|
if ((keyIndex >= SCA_IInputDevice::KX_SEMICOLONKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_RIGHTBRACKETKEY)) {
|
|
if (shifted) {
|
|
return semicolontorightbracketshifted[keyIndex - SCA_IInputDevice::KX_SEMICOLONKEY];
|
|
} else {
|
|
return semicolontorightbracket[keyIndex - SCA_IInputDevice::KX_SEMICOLONKEY];
|
|
}
|
|
}
|
|
|
|
/* keypad2 to padplus */
|
|
char pad2topadplus[] = "246813579. 0- +";
|
|
if ((keyIndex >= SCA_IInputDevice::KX_PAD2)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_PADPLUSKEY)) {
|
|
return pad2topadplus[keyIndex - SCA_IInputDevice::KX_PAD2];
|
|
}
|
|
|
|
return '!';
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
* Determine whether this character can be printed. We cannot use
|
|
* the library functions here, because we need to test our own
|
|
* keycodes. */
|
|
bool IsPrintable(int keyIndex)
|
|
{
|
|
/* only print
|
|
* - numerals: KX_ZEROKEY to KX_NINEKEY
|
|
* - alphas: KX_AKEY to KX_ZKEY.
|
|
* - specials: KX_RETKEY, KX_PADASTERKEY, KX_PADCOMMAKEY to KX_PERIODKEY,
|
|
* KX_TABKEY , KX_SEMICOLONKEY to KX_RIGHTBRACKETKEY,
|
|
* KX_PAD2 to KX_PADPLUSKEY
|
|
* - delete and backspace: also printable in the sense that they modify
|
|
* the string
|
|
* - retkey: should this be printable?
|
|
* - virgule: prints a space... don't know which key that's supposed
|
|
* to be...
|
|
*/
|
|
if ( ((keyIndex >= SCA_IInputDevice::KX_ZEROKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_NINEKEY))
|
|
|| ((keyIndex >= SCA_IInputDevice::KX_AKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_ZKEY))
|
|
|| (keyIndex == SCA_IInputDevice::KX_SPACEKEY)
|
|
|| (keyIndex == SCA_IInputDevice::KX_RETKEY)
|
|
|| (keyIndex == SCA_IInputDevice::KX_PADENTER)
|
|
|| (keyIndex == SCA_IInputDevice::KX_PADASTERKEY)
|
|
|| (keyIndex == SCA_IInputDevice::KX_TABKEY)
|
|
|| ((keyIndex >= SCA_IInputDevice::KX_COMMAKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_PERIODKEY))
|
|
|| ((keyIndex >= SCA_IInputDevice::KX_SEMICOLONKEY)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_RIGHTBRACKETKEY))
|
|
|| ((keyIndex >= SCA_IInputDevice::KX_PAD2)
|
|
&& (keyIndex <= SCA_IInputDevice::KX_PADPLUSKEY))
|
|
|| (keyIndex == SCA_IInputDevice::KX_DELKEY)
|
|
|| (keyIndex == SCA_IInputDevice::KX_BACKSPACEKEY)
|
|
)
|
|
{
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Tests whether this is a delete key.
|
|
*/
|
|
bool IsDelete(int keyIndex)
|
|
{
|
|
if ( (keyIndex == SCA_IInputDevice::KX_DELKEY)
|
|
|| (keyIndex == SCA_IInputDevice::KX_BACKSPACEKEY) ) {
|
|
return true;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|