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