SCA_KeyboardSensor.h

Go to the documentation of this file.

/*
 * ***** 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): none yet.
 *
 * ***** END GPL LICENSE BLOCK *****
 */

#ifndef __KX_KEYBOARDSENSOR
#define __KX_KEYBOARDSENSOR

#include "SCA_ISensor.h"
#include "BoolValue.h"
#include <list>

class SCA_KeyboardSensor : public SCA_ISensor
{
    Py_Header

    int                         m_hotkey;
    short int                   m_qual,m_qual2;
    short int                   m_val;
    bool                        m_bAllKeys;

    STR_String  m_targetprop;
    STR_String  m_toggleprop;

    void LogKeystrokes(void);
    
    void AddToTargetProp(int keyIndex);

    bool IsShifted(void);
    
public:
    SCA_KeyboardSensor(class 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);
    virtual ~SCA_KeyboardSensor();
    virtual CValue* GetReplica();
    virtual void Init();


    short int GetHotkey();
    virtual bool Evaluate();
    virtual bool IsPositiveTrigger();
    bool    TriggerOnAllKeys();

#ifdef WITH_PYTHON
    /* --------------------------------------------------------------------- */
    /* Python interface ---------------------------------------------------- */
    /* --------------------------------------------------------------------- */

    // KeyEvents: 
    KX_PYMETHOD_DOC_NOARGS(SCA_KeyboardSensor,getEventList);
    // KeyStatus: 
    KX_PYMETHOD_DOC_O(SCA_KeyboardSensor,getKeyStatus);
    
    static PyObject*    pyattr_get_events(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
#endif
};


char ToCharacter(int keyIndex, bool shifted);

bool IsPrintable(int keyIndex);

bool IsDelete(int keyIndex);


#endif //__KX_KEYBOARDSENSOR