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