Fix for bug #3858: the game engine mouse focus sensor did not work
[blender-staging.git] / source / gameengine / Ketsji / KX_MouseFocusSensor.h
1 /**
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  * KX_MouseFocusSensor determines mouse in/out/over events.
29  */
30
31 #ifndef __KX_MOUSEFOCUSSENSOR
32 #define __KX_MOUSEFOCUSSENSOR
33
34 #include "SCA_MouseSensor.h"
35
36 class KX_RayCast;
37
38 /**
39  * The mouse focus sensor extends the basic SCA_MouseSensor. It has
40  * been placed in KX because it needs access to the rasterizer and
41  * SuMO.
42  *
43  * - extend the valid modes?
44  * - */
45 class KX_MouseFocusSensor : public SCA_MouseSensor
46 {
47
48         Py_Header;
49         
50  public:
51         
52         KX_MouseFocusSensor(class SCA_MouseManager* keybdmgr,
53                                                 int startx,
54                                                 int starty,
55                                                 short int mousemode,
56                                                 int focusmode,
57                                                 RAS_ICanvas* canvas,
58                                                 KX_Scene* kxscene,
59                                                 KX_KetsjiEngine* kxengine,
60                                                 SCA_IObject* gameobj,
61                                                 PyTypeObject* T=&Type );
62
63         virtual ~KX_MouseFocusSensor() { ; };
64         virtual CValue* GetReplica() {
65                 CValue* replica = new KX_MouseFocusSensor(*this);
66                 // this will copy properties and so on...
67                 CValue::AddDataToReplica(replica);
68                 return replica;
69         };
70         /**
71          * @attention Overrides default evaluate. 
72          */
73         virtual bool Evaluate(CValue* event);
74         virtual void Init();
75
76         virtual bool IsPositiveTrigger() {
77                 bool result = m_positive_event;
78                 if (m_invert) result = !result;
79                 return result;
80         };
81
82         bool RayHit(KX_ClientObjectInfo* client, KX_RayCast* result, void * const data);
83         bool NeedRayCast(KX_ClientObjectInfo* client) { return true; }
84         
85
86         
87         /* --------------------------------------------------------------------- */
88         /* Python interface ---------------------------------------------------- */
89         /* --------------------------------------------------------------------- */
90         virtual PyObject*  _getattr(const STR_String& attr);
91
92         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRayTarget);
93         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRaySource);
94         
95         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetHitObject);
96         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetHitPosition);
97         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetHitNormal);
98         KX_PYMETHOD_DOC(KX_MouseFocusSensor,GetRayDirection);
99
100         /* --------------------------------------------------------------------- */
101         SCA_IObject*    m_hitObject;
102
103  private:
104         /**
105          * The focus mode. 1 for handling focus, 0 for not handling, 2 for focus on any object
106         */
107          int    m_focusmode;
108
109         /**
110          * Flags whether the previous test showed a mouse-over.
111          */
112         bool m_mouse_over_in_previous_frame;
113
114         /**
115          * Flags whether the previous test evaluated positive.
116          */
117         bool m_positive_event;
118
119         
120         /**
121          * Tests whether the object is in mouse focus in this frame.
122          */
123         bool ParentObjectHasFocus(void);
124
125         /**
126          * (in game world coordinates) the place where the object was hit.
127          */
128         MT_Point3                m_hitPosition;
129
130         /**
131          * (in game world coordinates) the position to which to shoot the ray.
132          */
133         MT_Point3                m_prevTargetPoint;
134
135         /**
136          * (in game world coordinates) the position from which to shoot the ray.
137          */
138         MT_Point3                m_prevSourcePoint;
139         
140         /**
141          * (in game world coordinates) the face normal of the vertex where
142          * the object was hit.  */
143         MT_Vector3               m_hitNormal;
144
145
146         /**
147          * The active canvas. The size of this canvas determines a part of
148          * the start position of the picking ray.  */
149         RAS_ICanvas* m_gp_canvas;
150
151         /**
152          * The KX scene that holds the camera. The camera position
153          * determines a part of the start location of the picking ray.  */
154         KX_Scene* m_kxscene;
155
156         /**
157          * The KX engine is needed for computing the viewport */
158         KX_KetsjiEngine* m_kxengine;
159 };
160
161 #endif //__KX_MOUSESENSOR
162