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