SCA_MouseSensor.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): 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
    
    short int m_mousemode;
    bool m_triggermode;
    int m_val;

    SCA_IInputDevice::KX_EnumInputs m_hotkey;
    
    short m_x;

    short m_y;
    
 public:
    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 //__KX_MOUSESENSOR