b5a0a63cf6883879e2a50de02f91ac5eadee5931
[blender.git] / source / gameengine / Ketsji / KX_CameraActuator.cpp
1 /**
2  * KX_CameraActuator.cpp
3  *
4  * $Id$
5  *
6  * ***** BEGIN GPL LICENSE BLOCK *****
7  *
8  * This program is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU General Public License
10  * as published by the Free Software Foundation; either version 2
11  * of the License, or (at your option) any later version.
12  *
13  * This program is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, write to the Free Software Foundation,
20  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
21  *
22  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
23  * All rights reserved.
24  *
25  * The Original Code is: all of this file.
26  *
27  * Contributor(s): none yet.
28  *
29  * ***** END GPL LICENSE BLOCK *****
30  *
31  */
32
33 #include "KX_CameraActuator.h"
34 #include <iostream>
35 #include <math.h>
36 #include <float.h>
37 #include "KX_GameObject.h"
38
39 #include "PyObjectPlus.h" 
40
41 #ifdef HAVE_CONFIG_H
42 #include <config.h>
43 #endif
44
45
46 /* ------------------------------------------------------------------------- */
47 /* Native functions                                                          */
48 /* ------------------------------------------------------------------------- */
49
50 KX_CameraActuator::KX_CameraActuator(
51         SCA_IObject* gameobj, 
52         SCA_IObject *obj,
53         float hght,
54         float minhght,
55         float maxhght,
56         bool  xytog
57 ): 
58         SCA_IActuator(gameobj),
59         m_ob (obj),
60         m_height (hght),
61         m_minHeight (minhght),
62         m_maxHeight (maxhght),
63         m_x (xytog)
64 {
65         if (m_ob)
66                 m_ob->RegisterActuator(this);
67 }
68
69 KX_CameraActuator::~KX_CameraActuator()
70 {
71         if (m_ob)
72                 m_ob->UnregisterActuator(this);
73 }
74
75         CValue* 
76 KX_CameraActuator::
77 GetReplica(
78 ) {
79         KX_CameraActuator* replica = new KX_CameraActuator(*this);
80         replica->ProcessReplica();
81         return replica;
82 };
83
84 void KX_CameraActuator::ProcessReplica()
85 {
86         if (m_ob)
87                 m_ob->RegisterActuator(this);
88         SCA_IActuator::ProcessReplica();
89 }
90
91 bool KX_CameraActuator::UnlinkObject(SCA_IObject* clientobj)
92 {
93         if (clientobj == m_ob)
94         {
95                 // this object is being deleted, we cannot continue to track it.
96                 m_ob = NULL;
97                 return true;
98         }
99         return false;
100 }
101
102
103 void KX_CameraActuator::Relink(GEN_Map<GEN_HashedPtr, void*> *obj_map)
104 {
105         void **h_obj = (*obj_map)[m_ob];
106         if (h_obj) {
107                 if (m_ob)
108                         m_ob->UnregisterActuator(this);
109                 m_ob = (SCA_IObject*)(*h_obj);
110                 m_ob->RegisterActuator(this);
111         }
112 }
113
114 /* three functions copied from blender arith... don't know if there's an equivalent */
115
116 static float Kx_Normalize(float *n)
117 {
118         float d;
119         
120         d= n[0]*n[0]+n[1]*n[1]+n[2]*n[2];
121         /* FLT_EPSILON is too large! A larger value causes normalize errors in a scaled down utah teapot */
122         if(d>0.0000000000001) {
123                 d= sqrt(d);
124
125                 n[0]/=d; 
126                 n[1]/=d; 
127                 n[2]/=d;
128         } else {
129                 n[0]=n[1]=n[2]= 0.0;
130                 d= 0.0;
131         }
132         return d;
133 }
134
135 static void Kx_Crossf(float *c, float *a, float *b)
136 {
137         c[0] = a[1] * b[2] - a[2] * b[1];
138         c[1] = a[2] * b[0] - a[0] * b[2];
139         c[2] = a[0] * b[1] - a[1] * b[0];
140 }
141
142
143 static void Kx_VecUpMat3(float *vec, float mat[][3], short axis)
144 {
145
146         // Construct a camera matrix s.t. the specified axis
147
148         // maps to the given vector (*vec). Also defines the rotation
149
150         // about this axis by mapping one of the other axis to the y-axis.
151
152
153         float inp;
154         short cox = 0, coy = 0, coz = 0;
155         
156         /* up varieeren heeft geen zin, is eigenlijk helemaal geen up!
157          * zie VecUpMat3old
158          */
159
160         if(axis==0) {
161                 cox= 0; coy= 1; coz= 2;         /* Y up Z tr */
162         }
163         if(axis==1) {
164                 cox= 1; coy= 2; coz= 0;         /* Z up X tr */
165         }
166         if(axis==2) {
167                 cox= 2; coy= 0; coz= 1;         /* X up Y tr */
168         }
169         if(axis==3) {
170                 cox= 0; coy= 1; coz= 2;         /* Y op -Z tr */
171                 vec[0]= -vec[0];
172                 vec[1]= -vec[1];
173                 vec[2]= -vec[2];
174         }
175         if(axis==4) {
176                 cox= 1; coy= 0; coz= 2;         /*  */
177         }
178         if(axis==5) {
179                 cox= 2; coy= 1; coz= 0;         /* Y up X tr */
180         }
181
182         mat[coz][0]= vec[0];
183         mat[coz][1]= vec[1];
184         mat[coz][2]= vec[2];
185         if (Kx_Normalize((float *)mat[coz]) == 0.f) {
186                 /* this is a very abnormal situation: the camera has reach the object center exactly
187                    We will choose a completely arbitrary direction */
188                 mat[coz][0] = 1.0f;
189                 mat[coz][1] = 0.0f;
190                 mat[coz][2] = 0.0f;
191         }
192         
193         inp= mat[coz][2];
194         mat[coy][0]= - inp*mat[coz][0];
195         mat[coy][1]= - inp*mat[coz][1];
196         mat[coy][2]= 1.0 - inp*mat[coz][2];
197
198         if (Kx_Normalize((float *)mat[coy]) == 0.f) {
199                 /* the camera is vertical, chose the y axis arbitrary */
200                 mat[coy][0] = 0.f;
201                 mat[coy][1] = 1.f;
202                 mat[coy][2] = 0.f;
203         }
204         
205         Kx_Crossf(mat[cox], mat[coy], mat[coz]);
206         
207 }
208
209 bool KX_CameraActuator::Update(double curtime, bool frame)
210 {
211         /* wondering... is it really neccesary/desirable to suppress negative    */
212         /* events here?                                                          */
213         bool bNegativeEvent = IsNegativeEvent();
214         RemoveAllEvents();
215
216         if (bNegativeEvent || !m_ob) 
217                 return false;
218         
219         KX_GameObject *obj = (KX_GameObject*) GetParent();
220         MT_Point3 from = obj->NodeGetWorldPosition();
221         MT_Matrix3x3 frommat = obj->NodeGetWorldOrientation();
222         /* These casts are _very_ dangerous!!! */
223         MT_Point3 lookat = ((KX_GameObject*)m_ob)->NodeGetWorldPosition();
224         MT_Matrix3x3 actormat = ((KX_GameObject*)m_ob)->NodeGetWorldOrientation();
225
226         float fp1[3], fp2[3], rc[3];
227         float inp, fac; //, factor = 0.0; /* some factor...                                    */
228         float mindistsq, maxdistsq, distsq;
229         float mat[3][3];
230         
231         /* The rules:                                                            */
232         /* CONSTRAINT 1: not implemented */
233         /* CONSTRAINT 2: can camera see actor?              */
234         /* CONSTRAINT 3: fixed height relative to floor below actor.             */
235         /* CONSTRAINT 4: camera rotates behind actor                              */
236         /* CONSTRAINT 5: minimum / maximum distance                             */
237         /* CONSTRAINT 6: again: fixed height relative to floor below actor        */
238         /* CONSTRAINT 7: track to floor below actor                               */
239         /* CONSTRAINT 8: look a little bit left or right, depending on how the
240
241            character is looking (horizontal x)
242  */
243
244         /* ...and then set the camera position. Since we assume the parent of    */
245         /* this actuator is always a camera, just set the parent position and    */
246         /* rotation. We do not check whether we really have a camera as parent.  */
247         /* It may be better to turn this into a general tracking actuator later  */
248         /* on, since lots of plausible relations can be filled in here.          */
249
250         /* ... set up some parameters ...                                        */
251         /* missing here: the 'floorloc' of the actor's shadow */
252
253         mindistsq= m_minHeight*m_minHeight;
254         maxdistsq= m_maxHeight*m_maxHeight;
255
256         /* C1: not checked... is a future option                                 */
257
258         /* C2: blender test_visibility function. Can this be a ray-test?         */
259
260         /* C3: fixed height  */
261         from[2] = (15.0*from[2] + lookat[2] + m_height)/16.0;
262
263
264         /* C4: camera behind actor   */
265         if (m_x) {
266                 fp1[0] = actormat[0][0];
267                 fp1[1] = actormat[1][0];
268                 fp1[2] = actormat[2][0];
269
270                 fp2[0] = frommat[0][0];
271                 fp2[1] = frommat[1][0];
272                 fp2[2] = frommat[2][0];
273         } 
274         else {
275                 fp1[0] = actormat[0][1];
276                 fp1[1] = actormat[1][1];
277                 fp1[2] = actormat[2][1];
278
279                 fp2[0] = frommat[0][1];
280                 fp2[1] = frommat[1][1];
281                 fp2[2] = frommat[2][1];
282         }
283         
284         inp= fp1[0]*fp2[0] + fp1[1]*fp2[1] + fp1[2]*fp2[2];
285         fac= (-1.0 + inp)/32.0;
286
287         from[0]+= fac*fp1[0];
288         from[1]+= fac*fp1[1];
289         from[2]+= fac*fp1[2];
290         
291         /* alleen alstie ervoor ligt: cross testen en loodrechte bijtellen */
292         if(inp<0.0) {
293                 if(fp1[0]*fp2[1] - fp1[1]*fp2[0] > 0.0) {
294                         from[0]-= fac*fp1[1];
295                         from[1]+= fac*fp1[0];
296                 }
297                 else {
298                         from[0]+= fac*fp1[1];
299                         from[1]-= fac*fp1[0];
300                 }
301         }
302
303         /* CONSTRAINT 5: minimum / maximum afstand */
304
305         rc[0]= (lookat[0]-from[0]);
306         rc[1]= (lookat[1]-from[1]);
307         rc[2]= (lookat[2]-from[2]);
308         distsq= rc[0]*rc[0] + rc[1]*rc[1] + rc[2]*rc[2];
309
310         if(distsq > maxdistsq) {
311                 distsq = 0.15*(distsq-maxdistsq)/distsq;
312                 
313                 from[0] += distsq*rc[0];
314                 from[1] += distsq*rc[1];
315                 from[2] += distsq*rc[2];
316         }
317         else if(distsq < mindistsq) {
318                 distsq = 0.15*(mindistsq-distsq)/mindistsq;
319                 
320                 from[0] -= distsq*rc[0];
321                 from[1] -= distsq*rc[1];
322                 from[2] -= distsq*rc[2];
323         }
324
325
326         /* CONSTRAINT 7: track to schaduw */
327         rc[0]= (lookat[0]-from[0]);
328         rc[1]= (lookat[1]-from[1]);
329         rc[2]= (lookat[2]-from[2]);
330         Kx_VecUpMat3(rc, mat, 3);       /* y up Track -z */
331         
332
333
334
335         /* now set the camera position and rotation */
336         
337         obj->NodeSetLocalPosition(from);
338         
339         actormat[0][0]= mat[0][0]; actormat[0][1]= mat[1][0]; actormat[0][2]= mat[2][0];
340         actormat[1][0]= mat[0][1]; actormat[1][1]= mat[1][1]; actormat[1][2]= mat[2][1];
341         actormat[2][0]= mat[0][2]; actormat[2][1]= mat[1][2]; actormat[2][2]= mat[2][2];
342         obj->NodeSetLocalOrientation(actormat);
343
344         return true;
345 }
346
347 CValue *KX_CameraActuator::findObject(char *obName) 
348 {
349         /* hook to object system */
350         return NULL;
351 }
352
353 /* ------------------------------------------------------------------------- */
354 /* Python functions                                                          */
355 /* ------------------------------------------------------------------------- */
356
357 /* Integration hooks ------------------------------------------------------- */
358 PyTypeObject KX_CameraActuator::Type = {
359         PyVarObject_HEAD_INIT(NULL, 0)
360         "KX_CameraActuator",
361         sizeof(PyObjectPlus_Proxy),
362         0,
363         py_base_dealloc,
364         0,
365         0,
366         0,
367         0,
368         py_base_repr,
369         0,0,0,0,0,0,0,0,0,
370         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
371         0,0,0,0,0,0,0,
372         Methods,
373         0,
374         0,
375         &SCA_IActuator::Type,
376         0,0,0,0,0,0,
377         py_base_new
378 };
379
380 PyMethodDef KX_CameraActuator::Methods[] = {
381         // ---> deprecated (all)
382         {"setObject",(PyCFunction) KX_CameraActuator::sPySetObject, METH_O,                     (const char *)SetObject_doc},
383         {"getObject",(PyCFunction) KX_CameraActuator::sPyGetObject, METH_VARARGS,       (const char *)GetObject_doc},
384         {"setMin"       ,(PyCFunction) KX_CameraActuator::sPySetMin,    METH_VARARGS,   (const char *)SetMin_doc},
385         {"getMin"       ,(PyCFunction) KX_CameraActuator::sPyGetMin,    METH_NOARGS,    (const char *)GetMin_doc},
386         {"setMax"       ,(PyCFunction) KX_CameraActuator::sPySetMax,    METH_VARARGS,   (const char *)SetMax_doc},
387         {"getMax"       ,(PyCFunction) KX_CameraActuator::sPyGetMax,    METH_NOARGS,    (const char *)GetMax_doc},
388         {"setHeight",(PyCFunction) KX_CameraActuator::sPySetHeight,     METH_VARARGS,   (const char *)SetHeight_doc},
389         {"getHeight",(PyCFunction) KX_CameraActuator::sPyGetHeight,     METH_NOARGS,    (const char *)GetHeight_doc},
390         {"setXY"        ,(PyCFunction) KX_CameraActuator::sPySetXY,             METH_VARARGS,   (const char *)SetXY_doc},
391         {"getXY"        ,(PyCFunction) KX_CameraActuator::sPyGetXY,             METH_NOARGS,    (const char *)GetXY_doc},
392         {NULL,NULL,NULL,NULL} //Sentinel
393 };
394
395 PyAttributeDef KX_CameraActuator::Attributes[] = {
396         KX_PYATTRIBUTE_FLOAT_RW("min",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_minHeight),
397         KX_PYATTRIBUTE_FLOAT_RW("max",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_maxHeight),
398         KX_PYATTRIBUTE_FLOAT_RW("height",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_height),
399         KX_PYATTRIBUTE_BOOL_RW("useXY",KX_CameraActuator,m_x),
400         KX_PYATTRIBUTE_RW_FUNCTION("object", KX_CameraActuator, pyattr_get_object,      pyattr_set_object),
401         {NULL}
402 };
403
404 /* get obj  ---------------------------------------------------------- */
405 const char KX_CameraActuator::GetObject_doc[] = 
406 "getObject(name_only = 1)\n"
407 "name_only - optional arg, when true will return the KX_GameObject rather then its name\n"
408 "\tReturns the object this sensor reacts to.\n";
409 PyObject* KX_CameraActuator::PyGetObject(PyObject* args)
410 {
411         int ret_name_only = 1;
412         
413         ShowDeprecationWarning("getObject()", "the object property");
414         
415         if (!PyArg_ParseTuple(args, "|i:getObject", &ret_name_only))
416                 return NULL;
417         
418         if (!m_ob)
419                 Py_RETURN_NONE;
420         
421         if (ret_name_only)
422                 return PyUnicode_FromString(m_ob->GetName().ReadPtr());
423         else
424                 return m_ob->GetProxy();
425 }
426 /* set obj  ---------------------------------------------------------- */
427 const char KX_CameraActuator::SetObject_doc[] = 
428 "setObject(object)\n"
429 "\t- object: KX_GameObject, string or None\n"
430 "\tSets the object this sensor reacts to.\n";
431 PyObject* KX_CameraActuator::PySetObject(PyObject* value)
432 {
433         KX_GameObject *gameobj;
434         
435         ShowDeprecationWarning("setObject()", "the object property");
436         
437         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.setObject(value): KX_CameraActuator"))
438                 return NULL; // ConvertPythonToGameObject sets the error
439         
440         if (m_ob != NULL)
441                 m_ob->UnregisterActuator(this); 
442
443         m_ob = (SCA_IObject*)gameobj;
444         if (m_ob)
445                 m_ob->RegisterActuator(this);
446         
447         Py_RETURN_NONE;
448 }
449
450 /* get min  ---------------------------------------------------------- */
451 const char KX_CameraActuator::GetMin_doc[] = 
452 "getMin\n"
453 "\tReturns the minimum value set in the Min: field.\n";
454 PyObject* KX_CameraActuator::PyGetMin()
455 {
456         ShowDeprecationWarning("getMin()", "the min property");
457         return PyFloat_FromDouble(m_minHeight);
458 }
459 /* set min  ---------------------------------------------------------- */
460 const char KX_CameraActuator::SetMin_doc[] = 
461 "setMin\n"
462 "\tSets the minimum value.\n";
463 PyObject* KX_CameraActuator::PySetMin(PyObject* args)
464 {
465         ShowDeprecationWarning("setMin()", "the min property");
466         float min;
467         if(PyArg_ParseTuple(args,"f:setMin", &min))
468         {
469                 m_minHeight = min;
470                 Py_RETURN_NONE;
471         }
472         return NULL;
473 }
474 /* get min  ---------------------------------------------------------- */
475 const char KX_CameraActuator::GetMax_doc[] = 
476 "getMax\n"
477 "\tReturns the maximum value set in the Max: field.\n";
478 PyObject* KX_CameraActuator::PyGetMax()
479 {
480         ShowDeprecationWarning("getMax()", "the max property");
481         return PyFloat_FromDouble(m_maxHeight);
482 }
483 /* set min  ---------------------------------------------------------- */
484 const char KX_CameraActuator::SetMax_doc[] = 
485 "setMax\n"
486 "\tSets the maximum value.\n";
487 PyObject* KX_CameraActuator::PySetMax(PyObject* args)
488 {
489         ShowDeprecationWarning("getMax()", "the max property");
490         float max;
491         if(PyArg_ParseTuple(args,"f:setMax", &max))
492         {
493                 m_maxHeight = max;
494                 Py_RETURN_NONE;
495         }
496         return NULL;
497 }
498 /* get height  ---------------------------------------------------------- */
499 const char KX_CameraActuator::GetHeight_doc[] = 
500 "getHeight\n"
501 "\tReturns the height value set in the height: field.\n";
502 PyObject* KX_CameraActuator::PyGetHeight()
503 {
504         ShowDeprecationWarning("getHeight()", "the height property");
505         return PyFloat_FromDouble(m_height);
506 }
507 /* set height  ---------------------------------------------------------- */
508 const char KX_CameraActuator::SetHeight_doc[] = 
509 "setHeight\n"
510 "\tSets the height value.\n";
511 PyObject* KX_CameraActuator::PySetHeight(PyObject* args)
512 {
513         ShowDeprecationWarning("getHeight()", "the height property");
514         float height;
515         if(PyArg_ParseTuple(args,"f:setHeight", &height))
516         {
517                 m_height = height;
518                 Py_RETURN_NONE;
519         }
520         return NULL;
521 }
522 /* set XY  ---------------------------------------------------------- */
523 const char KX_CameraActuator::SetXY_doc[] = 
524 "setXY\n"
525 "\tSets axis the camera tries to get behind.\n"
526 "\t1=x, 0=y\n";
527 PyObject* KX_CameraActuator::PySetXY(PyObject* args)
528 {
529         ShowDeprecationWarning("setXY()", "the useXY property");
530         int value;
531         if(PyArg_ParseTuple(args,"i:setXY", &value))
532         {
533                 m_x = value != 0;
534                 Py_RETURN_NONE;
535         }
536         return NULL;
537 }
538
539 /* get XY -------------------------------------------------------------*/
540 const char KX_CameraActuator::GetXY_doc[] =
541 "getXY\n"
542 "\tGets the axis the camera tries to get behind.\n"
543 "\tTrue = X, False = Y\n";
544 PyObject* KX_CameraActuator::PyGetXY()
545 {
546         ShowDeprecationWarning("getXY()", "the xy property");
547         return PyLong_FromSsize_t(m_x);
548 }
549
550 PyObject* KX_CameraActuator::pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
551 {
552         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
553         if (self->m_ob==NULL)
554                 Py_RETURN_NONE;
555         else
556                 return self->m_ob->GetProxy();
557 }
558
559 int KX_CameraActuator::pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
560 {
561         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
562         KX_GameObject *gameobj;
563         
564         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.object = value: KX_CameraActuator"))
565                 return PY_SET_ATTR_FAIL; // ConvertPythonToGameObject sets the error
566         
567         if (self->m_ob)
568                 self->m_ob->UnregisterActuator(self);   
569
570         if ((self->m_ob = (SCA_IObject*)gameobj))
571                 self->m_ob->RegisterActuator(self);
572         
573         return PY_SET_ATTR_SUCCESS;
574 }
575
576 /* eof */