svn merge -r 15409:15529 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / gameengine / Ketsji / KX_MouseFocusSensor.cpp
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 #ifdef WIN32
32 // This warning tells us about truncation of __long__ stl-generated names.
33 // It can occasionally cause DevStudio to have internal compiler warnings.
34 #pragma warning( disable : 4786 )     
35 #endif
36
37 #include "MT_Point3.h"
38 #include "RAS_FramingManager.h"
39 #include "RAS_ICanvas.h"
40 #include "RAS_IRasterizer.h"
41 #include "SCA_IScene.h"
42 #include "KX_Scene.h"
43 #include "KX_Camera.h"
44 #include "KX_MouseFocusSensor.h"
45
46 #include "KX_RayCast.h"
47 #include "KX_IPhysicsController.h"
48 #include "PHY_IPhysicsController.h"
49 #include "PHY_IPhysicsEnvironment.h"
50
51
52 #include "KX_ClientObjectInfo.h"
53
54 /* ------------------------------------------------------------------------- */
55 /* Native functions                                                          */
56 /* ------------------------------------------------------------------------- */
57
58 KX_MouseFocusSensor::KX_MouseFocusSensor(SCA_MouseManager* eventmgr, 
59                                                                                  int startx,
60                                                                                  int starty,
61                                                                                  short int mousemode,
62                                                                                  int focusmode,
63                                                                                  RAS_ICanvas* canvas,
64                                                                                  KX_Scene* kxscene,
65                                                                                  SCA_IObject* gameobj, 
66                                                                                  PyTypeObject* T)
67     : SCA_MouseSensor(eventmgr, startx, starty, mousemode, gameobj, T),
68           m_focusmode(focusmode),
69           m_gp_canvas(canvas),
70           m_kxscene(kxscene)
71 {
72         Init();
73 }
74
75 void KX_MouseFocusSensor::Init()
76 {
77         m_mouse_over_in_previous_frame = (m_invert)?true:false;
78         m_positive_event = false;
79         m_hitObject = 0;
80         m_reset = true;
81 }
82
83 bool KX_MouseFocusSensor::Evaluate(CValue* event)
84 {
85         bool result = false;
86         bool obHasFocus = false;
87         bool reset = m_reset && m_level;
88
89 //      cout << "evaluate focus mouse sensor "<<endl;
90         m_reset = false;
91         if (m_focusmode) {
92                 /* Focus behaviour required. Test mouse-on. The rest is
93                  * equivalent to handling a key. */
94                 obHasFocus = ParentObjectHasFocus();
95                 
96                 if (!obHasFocus) {
97                         m_positive_event = false;
98                         if (m_mouse_over_in_previous_frame) {
99                                 result = true;
100                         } 
101                 } else {
102                         m_positive_event = true;
103                         if (!m_mouse_over_in_previous_frame) {
104                                 result = true;
105                         } 
106                 } 
107                 if (reset) {
108                         // force an event 
109                         result = true;
110                 }
111         } else {
112                 /* No focus behaviour required: revert to the basic mode. This
113          * mode is never used, because the converter never makes this
114          * sensor for a mouse-key event. It is here for
115          * completeness. */
116                 result = SCA_MouseSensor::Evaluate(event);
117                 m_positive_event = (m_val!=0);
118         }
119
120         m_mouse_over_in_previous_frame = obHasFocus;
121
122         return result;
123 }
124
125 bool KX_MouseFocusSensor::RayHit(KX_ClientObjectInfo* client_info, MT_Point3& hit_point, MT_Vector3& hit_normal, void * const data)
126 {
127         KX_GameObject* hitKXObj = client_info->m_gameobject;
128         
129         if (client_info->m_type > KX_ClientObjectInfo::ACTOR)
130         {
131                 // false hit
132                 return false;
133         }
134         
135         /* Is this me? In the ray test, there are a lot of extra checks
136         * for aliasing artefacts from self-hits. That doesn't happen
137         * here, so a simple test suffices. Or does the camera also get
138         * self-hits? (No, and the raysensor shouldn't do it either, since
139         * self-hits are excluded by setting the correct ignore-object.)
140         * Hitspots now become valid. */
141         KX_GameObject* thisObj = (KX_GameObject*) GetParent();
142         if ((m_focusmode == 2) || hitKXObj == thisObj)
143         {
144                 m_hitObject = hitKXObj;
145                 m_hitPosition = hit_point;
146                 m_hitNormal = hit_normal;
147                 return true;
148         }
149         
150         return true;     // object must be visible to trigger
151         //return false;  // occluded objects can trigger
152 }
153
154
155
156 bool KX_MouseFocusSensor::ParentObjectHasFocus(void)
157 {
158         m_hitObject = 0;
159         m_hitPosition = MT_Vector3(0,0,0);
160         m_hitNormal =   MT_Vector3(1,0,0);
161         MT_Point3 resultpoint;
162         MT_Vector3 resultnormal;
163
164         /* All screen handling in the gameengine is done by GL,
165          * specifically the model/view and projection parts. The viewport
166          * part is in the creator. 
167          *
168          * The theory is this:
169          * WCS - world coordinates
170          * -> wcs_camcs_trafo ->
171          * camCS - camera coordinates
172          * -> camcs_clip_trafo ->
173          * clipCS - normalized device coordinates?
174          * -> normview_win_trafo
175          * winCS - window coordinates
176          *
177          * The first two transforms are respectively the model/view and
178          * the projection matrix. These are passed to the rasterizer, and
179          * we store them in the camera for easy access.
180          *
181          * For normalized device coords (xn = x/w, yn = y/w/zw) the
182          * windows coords become (lb = left bottom)
183          *
184          * xwin = [(xn + 1.0) * width]/2 + x_lb
185          * ywin = [(yn + 1.0) * height]/2 + y_lb
186          *
187          * Inverting (blender y is flipped!):
188          *
189          * xn = 2(xwin - x_lb)/width - 1.0
190          * yn = 2(ywin - y_lb)/height - 1.0 
191          *    = 2(height - y_blender - y_lb)/height - 1.0
192          *    = 1.0 - 2(y_blender - y_lb)/height
193          *
194          * */
195         
196         /* Because we don't want to worry about resize events, camera
197          * changes and all that crap, we just determine this over and
198          * over. Stop whining. We have lots of other calculations to do
199          * here as well. These reads are not the main cost. If there is no
200          * canvas, the test is irrelevant. The 1.0 makes sure the
201          * calculations don't bomb. Maybe we should explicitly guard for
202          * division by 0.0...*/
203
204         /**
205          * Get the scenes current viewport.
206          */
207
208         const RAS_Rect & viewport = m_kxscene->GetSceneViewport();
209
210         float height = float(viewport.m_y2 - viewport.m_y1 + 1);
211         float width  = float(viewport.m_x2 - viewport.m_x1 + 1);
212         
213         float x_lb = float(viewport.m_x1);
214         float y_lb = float(viewport.m_y1);
215
216         KX_Camera* cam = m_kxscene->GetActiveCamera();
217         /* There's some strangeness I don't fully get here... These values
218          * _should_ be wrong! */
219
220         /* old: */
221         float nearclip = 0.0;
222         float farclip = 1.0;
223
224         /*      build the from and to point in normalized device coordinates 
225          *      Looks like normailized device coordinates are [-1,1] in x [-1,1] in y
226          *      [0,-1] in z 
227          *      
228          *      The actual z coordinates used don't have to be exact just infront and 
229          *      behind of the near and far clip planes.
230          */ 
231         MT_Vector4 frompoint = MT_Vector4( 
232                 (2 * (m_x-x_lb) / width) - 1.0,
233                 1.0 - (2 * (m_y - y_lb) / height),
234                 nearclip,
235                 1.0
236         );
237         MT_Vector4 topoint = MT_Vector4( 
238                 (2 * (m_x-x_lb) / width) - 1.0,
239                 1.0 - (2 * (m_y-y_lb) / height),
240                 farclip,
241                 1.0
242         );
243
244         /* camera to world  */
245         MT_Transform wcs_camcs_tranform = cam->GetWorldToCamera();
246         if (!cam->GetCameraData()->m_perspective)
247                 wcs_camcs_tranform.getOrigin()[2] *= 100.0;
248         MT_Transform cams_wcs_transform;
249         cams_wcs_transform.invert(wcs_camcs_tranform);
250         
251         MT_Matrix4x4 camcs_wcs_matrix = MT_Matrix4x4(cams_wcs_transform);
252
253         /* badly defined, the first time round.... I wonder why... I might
254          * want to guard against floating point errors here.*/
255         MT_Matrix4x4 clip_camcs_matrix = MT_Matrix4x4(cam->GetProjectionMatrix());
256         clip_camcs_matrix.invert();
257
258         /* shoot-points: clip to cam to wcs . win to clip was already done.*/
259         frompoint = clip_camcs_matrix * frompoint;
260         topoint   = clip_camcs_matrix * topoint;
261         frompoint = camcs_wcs_matrix * frompoint;
262         topoint   = camcs_wcs_matrix * topoint;
263         
264         /* from hom wcs to 3d wcs: */
265         MT_Point3 frompoint3 = MT_Point3(frompoint[0]/frompoint[3], 
266                                                                          frompoint[1]/frompoint[3], 
267                                                                          frompoint[2]/frompoint[3]); 
268         MT_Point3 topoint3 = MT_Point3(topoint[0]/topoint[3], 
269                                                                    topoint[1]/topoint[3], 
270                                                                    topoint[2]/topoint[3]); 
271         m_prevTargetPoint = topoint3;
272         m_prevSourcePoint = frompoint3;
273         
274         /* 2. Get the object from PhysicsEnvironment */
275         /* Shoot! Beware that the first argument here is an
276          * ignore-object. We don't ignore anything... */
277         
278         KX_IPhysicsController* physics_controller = cam->GetPhysicsController();
279         PHY_IPhysicsEnvironment* physics_environment = m_kxscene->GetPhysicsEnvironment();
280
281         bool result = false;
282
283         result = KX_RayCast::RayTest(physics_controller, physics_environment, frompoint3, topoint3, resultpoint, resultnormal, KX_RayCast::Callback<KX_MouseFocusSensor>(this));
284         
285         result = (m_hitObject!=0);
286
287         return result;
288
289 }
290
291 /* ------------------------------------------------------------------------- */
292 /* Python functions                                                          */
293 /* ------------------------------------------------------------------------- */
294
295 /* Integration hooks ------------------------------------------------------- */
296 PyTypeObject KX_MouseFocusSensor::Type = {
297         PyObject_HEAD_INIT(&PyType_Type)
298         0,
299         "KX_MouseFocusSensor",
300         sizeof(KX_MouseFocusSensor),
301         0,
302         PyDestructor,
303         0,
304         __getattr,
305         __setattr,
306         0, //&MyPyCompare,
307         __repr,
308         0, //&cvalue_as_number,
309         0,
310         0,
311         0,
312         0
313 };
314
315 PyParentObject KX_MouseFocusSensor::Parents[] = {
316         &KX_MouseFocusSensor::Type,
317         &SCA_MouseSensor::Type,
318         &SCA_ISensor::Type,
319         &SCA_ILogicBrick::Type,
320         &CValue::Type,
321         NULL
322 };
323
324 PyMethodDef KX_MouseFocusSensor::Methods[] = {
325         {"getRayTarget", (PyCFunction) KX_MouseFocusSensor::sPyGetRayTarget, 
326          METH_VARARGS, GetRayTarget_doc},
327         {"getRaySource", (PyCFunction) KX_MouseFocusSensor::sPyGetRaySource, 
328          METH_VARARGS, GetRaySource_doc},
329         {"getHitObject",(PyCFunction) KX_MouseFocusSensor::sPyGetHitObject,METH_VARARGS, GetHitObject_doc},
330         {"getHitPosition",(PyCFunction) KX_MouseFocusSensor::sPyGetHitPosition,METH_VARARGS, GetHitPosition_doc},
331         {"getHitNormal",(PyCFunction) KX_MouseFocusSensor::sPyGetHitNormal,METH_VARARGS, GetHitNormal_doc},
332         {"getRayDirection",(PyCFunction) KX_MouseFocusSensor::sPyGetRayDirection,METH_VARARGS, GetRayDirection_doc},
333
334
335         {NULL,NULL} //Sentinel
336 };
337
338 PyObject* KX_MouseFocusSensor::_getattr(const STR_String& attr) {
339         _getattr_up(SCA_MouseSensor);
340 }
341
342
343 char KX_MouseFocusSensor::GetHitObject_doc[] = 
344 "getHitObject()\n"
345 "\tReturns the name of the object that was hit by this ray.\n";
346 PyObject* KX_MouseFocusSensor::PyGetHitObject(PyObject* self, 
347                                                                                    PyObject* args, 
348                                                                                    PyObject* kwds)
349 {
350         if (m_hitObject)
351         {
352                 return m_hitObject->AddRef();
353         }
354         Py_Return;
355 }
356
357
358 char KX_MouseFocusSensor::GetHitPosition_doc[] = 
359 "getHitPosition()\n"
360 "\tReturns the position (in worldcoordinates) where the object was hit by this ray.\n";
361 PyObject* KX_MouseFocusSensor::PyGetHitPosition(PyObject* self, 
362                                PyObject* args, 
363                                PyObject* kwds)
364 {
365
366         MT_Point3 pos = m_hitPosition;
367
368         PyObject* resultlist = PyList_New(3);
369         int index;
370         for (index=0;index<3;index++)
371         {
372                 PyList_SetItem(resultlist,index,PyFloat_FromDouble(pos[index]));
373         }
374         return resultlist;
375
376 }
377
378 char KX_MouseFocusSensor::GetRayDirection_doc[] = 
379 "getRayDirection()\n"
380 "\tReturns the direction from the ray (in worldcoordinates) .\n";
381 PyObject* KX_MouseFocusSensor::PyGetRayDirection(PyObject* self, 
382                                PyObject* args, 
383                                PyObject* kwds)
384 {
385
386         MT_Vector3 dir = m_prevTargetPoint - m_prevSourcePoint;
387         dir.normalize();
388
389         PyObject* resultlist = PyList_New(3);
390         int index;
391         for (index=0;index<3;index++)
392         {
393                 PyList_SetItem(resultlist,index,PyFloat_FromDouble(dir[index]));
394         }
395         return resultlist;
396
397 }
398
399 char KX_MouseFocusSensor::GetHitNormal_doc[] = 
400 "getHitNormal()\n"
401 "\tReturns the normal (in worldcoordinates) of the object at the location where the object was hit by this ray.\n";
402 PyObject* KX_MouseFocusSensor::PyGetHitNormal(PyObject* self, 
403                                PyObject* args, 
404                                PyObject* kwds)
405 {
406         MT_Vector3 pos = m_hitNormal;
407
408         PyObject* resultlist = PyList_New(3);
409         int index;
410         for (index=0;index<3;index++)
411         {
412                 PyList_SetItem(resultlist,index,PyFloat_FromDouble(pos[index]));
413         }
414         return resultlist;
415
416 }
417
418
419 /*  getRayTarget                                                */
420 char KX_MouseFocusSensor::GetRayTarget_doc[] = 
421 "getRayTarget()\n"
422 "\tReturns the target of the ray that seeks the focus object,\n"
423 "\tin worldcoordinates.";
424 PyObject* KX_MouseFocusSensor::PyGetRayTarget(PyObject* self, 
425                                                                                           PyObject* args, 
426                                                                                           PyObject* kwds) {
427         PyObject *retVal = PyList_New(3);
428
429         PyList_SetItem(retVal, 0, PyFloat_FromDouble(m_prevTargetPoint[0]));
430         PyList_SetItem(retVal, 1, PyFloat_FromDouble(m_prevTargetPoint[1]));
431         PyList_SetItem(retVal, 2, PyFloat_FromDouble(m_prevTargetPoint[2]));
432         
433         return retVal;
434 }
435
436 /*  getRayTarget                                                */
437 char KX_MouseFocusSensor::GetRaySource_doc[] = 
438 "getRaySource()\n"
439 "\tReturns the source of the ray that seeks the focus object,\n"
440 "\tin worldcoordinates.";
441 PyObject* KX_MouseFocusSensor::PyGetRaySource(PyObject* self, 
442                                                                                           PyObject* args, 
443                                                                                           PyObject* kwds) {
444         PyObject *retVal = PyList_New(3);
445
446         PyList_SetItem(retVal, 0, PyFloat_FromDouble(m_prevSourcePoint[0]));
447         PyList_SetItem(retVal, 1, PyFloat_FromDouble(m_prevSourcePoint[1]));
448         PyList_SetItem(retVal, 2, PyFloat_FromDouble(m_prevSourcePoint[2]));
449         
450         return retVal;
451 }
452
453 /* eof */
454