KX_MouseFocusSensor.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_MOUSEFOCUSSENSOR
#define __KX_MOUSEFOCUSSENSOR

#include "SCA_MouseSensor.h"

class KX_RayCast;

class KX_MouseFocusSensor : public SCA_MouseSensor
{

    Py_Header
    
 public:
    
    KX_MouseFocusSensor(class SCA_MouseManager* eventmgr,
                        int startx,
                        int starty,
                        short int mousemode,
                        int focusmode,
                        bool bTouchPulse,
                        KX_Scene* kxscene,
                        KX_KetsjiEngine* kxengine,
                        SCA_IObject* gameobj);

    virtual ~KX_MouseFocusSensor() { ; };
    virtual CValue* GetReplica() {
        CValue* replica = new KX_MouseFocusSensor(*this);
        // this will copy properties and so on...
        replica->ProcessReplica();
        return replica;
    };

    virtual void Replace_IScene(SCA_IScene *val)
    {
        m_kxscene= static_cast<KX_Scene *>(val);
    };


    virtual bool Evaluate();
    virtual void Init();

    virtual bool IsPositiveTrigger() {
        bool result = m_positive_event;
        if (m_invert) result = !result;
        return result;
    };

    bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
    bool NeedRayCast(KX_ClientObjectInfo* client) { return true; }
    
    const MT_Point3& RaySource() const;
    const MT_Point3& RayTarget() const;
    const MT_Point3& HitPosition() const;
    const MT_Vector3& HitNormal() const;
    const MT_Vector2& HitUV() const;
    
#ifdef WITH_PYTHON

    /* --------------------------------------------------------------------- */
    /* Python interface ---------------------------------------------------- */
    /* --------------------------------------------------------------------- */

    /* attributes */
    static PyObject*    pyattr_get_ray_source(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_ray_target(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_ray_direction(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_hit_object(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_hit_position(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_hit_normal(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
    static PyObject*    pyattr_get_hit_uv(void* self_v, const KX_PYATTRIBUTE_DEF *attrdef);
        
#endif // WITH_PYTHON

    /* --------------------------------------------------------------------- */
    SCA_IObject*    m_hitObject;
    void*           m_hitObject_Last; /* only use for comparison, never access */

 private:
    int m_focusmode;

    bool m_mouse_over_in_previous_frame;

    bool m_bTouchPulse;
    
    bool m_positive_event;

    bool ParentObjectHasFocusCamera(KX_Camera *cam);
    
    bool ParentObjectHasFocus(void);

    MT_Point3        m_hitPosition;

    MT_Point3        m_prevTargetPoint;

    MT_Point3        m_prevSourcePoint;
    
    MT_Vector3       m_hitNormal;

    MT_Vector2       m_hitUV;

    KX_Scene* m_kxscene;

    KX_KetsjiEngine* m_kxengine;
};

#endif //__KX_MOUSESENSOR