dfe45b8cfcd639e29cd4ec5b21506df85c2b6c52
[blender.git] / source / gameengine / Ketsji / KX_CameraActuator.cpp
1 /*
2  * KX_CameraActuator.cpp
3  *
4  *
5  * ***** BEGIN GPL LICENSE BLOCK *****
6  *
7  * This program is free software; you can redistribute it and/or
8  * modify it under the terms of the GNU General Public License
9  * as published by the Free Software Foundation; either version 2
10  * of the License, or (at your option) any later version.
11  *
12  * This program is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software Foundation,
19  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20  *
21  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
22  * All rights reserved.
23  *
24  * The Original Code is: all of this file.
25  *
26  * Contributor(s): none yet.
27  *
28  * ***** END GPL LICENSE BLOCK *****
29  *
30  */
31
32 /** \file gameengine/Ketsji/KX_CameraActuator.cpp
33  *  \ingroup ketsji
34  */
35
36
37 #include "KX_CameraActuator.h"
38 #include <iostream>
39 #include <math.h>
40 #include <float.h>
41 #include "KX_GameObject.h"
42
43 #include "PyObjectPlus.h" 
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         short axis,
57         float damping
58 ): 
59         SCA_IActuator(gameobj, KX_ACT_CAMERA),
60         m_ob (obj),
61         m_height (hght),
62         m_minHeight (minhght),
63         m_maxHeight (maxhght),
64         m_axis(axis),
65         m_damping (damping)
66 {
67         if (m_ob)
68                 m_ob->RegisterActuator(this);
69 }
70
71 KX_CameraActuator::~KX_CameraActuator()
72 {
73         if (m_ob)
74                 m_ob->UnregisterActuator(this);
75 }
76
77         CValue* 
78 KX_CameraActuator::
79 GetReplica(
80 ) {
81         KX_CameraActuator* replica = new KX_CameraActuator(*this);
82         replica->ProcessReplica();
83         return replica;
84 };
85
86 void KX_CameraActuator::ProcessReplica()
87 {
88         if (m_ob)
89                 m_ob->RegisterActuator(this);
90         SCA_IActuator::ProcessReplica();
91 }
92
93 bool KX_CameraActuator::UnlinkObject(SCA_IObject* clientobj)
94 {
95         if (clientobj == m_ob)
96         {
97                 // this object is being deleted, we cannot continue to track it.
98                 m_ob = NULL;
99                 return true;
100         }
101         return false;
102 }
103
104
105 void KX_CameraActuator::Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map)
106 {
107         void **h_obj = (*obj_map)[m_ob];
108         if (h_obj) {
109                 if (m_ob)
110                         m_ob->UnregisterActuator(this);
111                 m_ob = (SCA_IObject*)(*h_obj);
112                 m_ob->RegisterActuator(this);
113         }
114 }
115
116 /* three functions copied from blender arith... don't know if there's an equivalent */
117
118 static float Kx_Normalize(float *n)
119 {
120         float d;
121         
122         d= n[0]*n[0]+n[1]*n[1]+n[2]*n[2];
123         /* FLT_EPSILON is too large! A larger value causes normalize errors in a scaled down utah teapot */
124         if (d>0.0000000000001) {
125                 d= sqrt(d);
126
127                 n[0]/=d; 
128                 n[1]/=d; 
129                 n[2]/=d;
130         } else {
131                 n[0]=n[1]=n[2]= 0.0;
132                 d= 0.0;
133         }
134         return d;
135 }
136
137 static void Kx_Crossf(float *c, float *a, float *b)
138 {
139         c[0] = a[1] * b[2] - a[2] * b[1];
140         c[1] = a[2] * b[0] - a[0] * b[2];
141         c[2] = a[0] * b[1] - a[1] * b[0];
142 }
143
144
145 static void Kx_VecUpMat3(float vec[3], float mat[][3], short axis)
146 {
147
148         // Construct a camera matrix s.t. the specified axis
149
150         // maps to the given vector (*vec). Also defines the rotation
151
152         // about this axis by mapping one of the other axis to the y-axis.
153
154
155         float inp;
156         short cox = 0, coy = 0, coz = 0;
157         
158         /* up range has no meaning, is not really up!
159          * see: VecUpMat3old
160          */
161
162         if (axis==0) {
163                 cox= 0; coy= 1; coz= 2;         /* Y up Z tr */
164         }
165         if (axis==1) {
166                 cox= 1; coy= 2; coz= 0;         /* Z up X tr */
167         }
168         if (axis==2) {
169                 cox= 2; coy= 0; coz= 1;         /* X up Y tr */
170         }
171         if (axis==3) {
172                 cox= 0; coy= 1; coz= 2;         /* Y op -Z tr */
173                 vec[0]= -vec[0];
174                 vec[1]= -vec[1];
175                 vec[2]= -vec[2];
176         }
177         if (axis==4) {
178                 cox= 1; coy= 0; coz= 2;         /*  */
179         }
180         if (axis==5) {
181                 cox= 2; coy= 1; coz= 0;         /* Y up X tr */
182         }
183
184         mat[coz][0]= vec[0];
185         mat[coz][1]= vec[1];
186         mat[coz][2]= vec[2];
187         if (Kx_Normalize((float *)mat[coz]) == 0.f) {
188                 /* this is a very abnormal situation: the camera has reach the object center exactly
189                  * We will choose a completely arbitrary direction */
190                 mat[coz][0] = 1.0f;
191                 mat[coz][1] = 0.0f;
192                 mat[coz][2] = 0.0f;
193         }
194         
195         inp= mat[coz][2];
196         mat[coy][0]= - inp*mat[coz][0];
197         mat[coy][1]= - inp*mat[coz][1];
198         mat[coy][2]= 1.0 - inp*mat[coz][2];
199
200         if (Kx_Normalize((float *)mat[coy]) == 0.f) {
201                 /* the camera is vertical, chose the y axis arbitrary */
202                 mat[coy][0] = 0.f;
203                 mat[coy][1] = 1.f;
204                 mat[coy][2] = 0.f;
205         }
206         
207         Kx_Crossf(mat[cox], mat[coy], mat[coz]);
208         
209 }
210
211 bool KX_CameraActuator::Update(double curtime, bool frame)
212 {
213         /* wondering... is it really necessary/desirable to suppress negative    */
214         /* events here?                                                          */
215         bool bNegativeEvent = IsNegativeEvent();
216         RemoveAllEvents();
217
218         if (bNegativeEvent || !m_ob) 
219                 return false;
220         
221         KX_GameObject *obj = (KX_GameObject*) GetParent();
222         MT_Point3 from = obj->NodeGetWorldPosition();
223         MT_Matrix3x3 frommat = obj->NodeGetWorldOrientation();
224         /* These casts are _very_ dangerous!!! */
225         MT_Point3 lookat = ((KX_GameObject*)m_ob)->NodeGetWorldPosition();
226         MT_Matrix3x3 actormat = ((KX_GameObject*)m_ob)->NodeGetWorldOrientation();
227
228         float fp1[3], fp2[3], rc[3];
229         float inp, fac; //, factor = 0.0; /* some factor...                                    */
230         float mindistsq, maxdistsq, distsq;
231         float mat[3][3];
232         
233         /* The rules:                                                            */
234         /* CONSTRAINT 1: not implemented */
235         /* CONSTRAINT 2: can camera see actor?              */
236         /* CONSTRAINT 3: fixed height relative to floor below actor.             */
237         /* CONSTRAINT 4: camera rotates behind actor                              */
238         /* CONSTRAINT 5: minimum / maximum distance                             */
239         /* CONSTRAINT 6: again: fixed height relative to floor below actor        */
240         /* CONSTRAINT 7: track to floor below actor                               */
241         /* CONSTRAINT 8: look a little bit left or right, depending on how the
242          *
243          * character is looking (horizontal x)
244          */
245
246         /* ...and then set the camera position. Since we assume the parent of    */
247         /* this actuator is always a camera, just set the parent position and    */
248         /* rotation. We do not check whether we really have a camera as parent.  */
249         /* It may be better to turn this into a general tracking actuator later  */
250         /* on, since lots of plausible relations can be filled in here.          */
251
252         /* ... set up some parameters ...                                        */
253         /* missing here: the 'floorloc' of the actor's shadow */
254
255         mindistsq= m_minHeight*m_minHeight;
256         maxdistsq= m_maxHeight*m_maxHeight;
257
258         /* C1: not checked... is a future option                                 */
259
260         /* C2: blender test_visibility function. Can this be a ray-test?         */
261
262         /* C3: fixed height  */
263         from[2] = (15.0*from[2] + lookat[2] + m_height)/16.0;
264
265
266         /* C4: camera behind actor   */
267         switch (m_axis) {
268                 case OB_POSX:
269                         /* X */
270                         fp1[0] = actormat[0][0];
271                         fp1[1] = actormat[1][0];
272                         fp1[2] = actormat[2][0];
273
274                         fp2[0] = frommat[0][0];
275                         fp2[1] = frommat[1][0];
276                         fp2[2] = frommat[2][0];
277                         break;
278                 case OB_POSY:
279                         /* Y */
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                         break;
288                 case OB_NEGX:
289                         /* -X */
290                         fp1[0] = -actormat[0][0];
291                         fp1[1] = -actormat[1][0];
292                         fp1[2] = -actormat[2][0];
293
294                         fp2[0] = frommat[0][0];
295                         fp2[1] = frommat[1][0];
296                         fp2[2] = frommat[2][0];
297                         break;
298                 case OB_NEGY:
299                         /* -Y */
300                         fp1[0] = -actormat[0][1];
301                         fp1[1] = -actormat[1][1];
302                         fp1[2] = -actormat[2][1];
303
304                         fp2[0] = frommat[0][1];
305                         fp2[1] = frommat[1][1];
306                         fp2[2] = frommat[2][1];
307                         break;
308                 default:
309                         assert(0);
310                         break;
311         }
312         
313         inp= fp1[0]*fp2[0] + fp1[1]*fp2[1] + fp1[2]*fp2[2];
314         fac= (-1.0 + inp) * m_damping;
315
316         from[0]+= fac*fp1[0];
317         from[1]+= fac*fp1[1];
318         from[2]+= fac*fp1[2];
319         
320         /* alleen alstie ervoor ligt: cross testen en loodrechte bijtellen */
321         if (inp<0.0) {
322                 if (fp1[0]*fp2[1] - fp1[1]*fp2[0] > 0.0) {
323                         from[0]-= fac*fp1[1];
324                         from[1]+= fac*fp1[0];
325                 }
326                 else {
327                         from[0]+= fac*fp1[1];
328                         from[1]-= fac*fp1[0];
329                 }
330         }
331
332         /* CONSTRAINT 5: minimum / maximum afstand */
333
334         rc[0]= (lookat[0]-from[0]);
335         rc[1]= (lookat[1]-from[1]);
336         rc[2]= (lookat[2]-from[2]);
337         distsq= rc[0]*rc[0] + rc[1]*rc[1] + rc[2]*rc[2];
338
339         if (distsq > maxdistsq) {
340                 distsq = 0.15*(distsq-maxdistsq)/distsq;
341                 
342                 from[0] += distsq*rc[0];
343                 from[1] += distsq*rc[1];
344                 from[2] += distsq*rc[2];
345         }
346         else if (distsq < mindistsq) {
347                 distsq = 0.15*(mindistsq-distsq)/mindistsq;
348                 
349                 from[0] -= distsq*rc[0];
350                 from[1] -= distsq*rc[1];
351                 from[2] -= distsq*rc[2];
352         }
353
354
355         /* CONSTRAINT 7: track to schaduw */
356         rc[0]= (lookat[0]-from[0]);
357         rc[1]= (lookat[1]-from[1]);
358         rc[2]= (lookat[2]-from[2]);
359         Kx_VecUpMat3(rc, mat, 3);       /* y up Track -z */
360         
361
362
363
364         /* now set the camera position and rotation */
365         
366         obj->NodeSetLocalPosition(from);
367         
368         actormat[0][0]= mat[0][0]; actormat[0][1]= mat[1][0]; actormat[0][2]= mat[2][0];
369         actormat[1][0]= mat[0][1]; actormat[1][1]= mat[1][1]; actormat[1][2]= mat[2][1];
370         actormat[2][0]= mat[0][2]; actormat[2][1]= mat[1][2]; actormat[2][2]= mat[2][2];
371         obj->NodeSetLocalOrientation(actormat);
372
373         return true;
374 }
375
376 CValue *KX_CameraActuator::findObject(const char *obName)
377 {
378         /* hook to object system */
379         return NULL;
380 }
381
382 #ifdef WITH_PYTHON
383
384 /* ------------------------------------------------------------------------- */
385 /* Python functions                                                          */
386 /* ------------------------------------------------------------------------- */
387
388 /* Integration hooks ------------------------------------------------------- */
389 PyTypeObject KX_CameraActuator::Type = {
390         PyVarObject_HEAD_INIT(NULL, 0)
391         "KX_CameraActuator",
392         sizeof(PyObjectPlus_Proxy),
393         0,
394         py_base_dealloc,
395         0,
396         0,
397         0,
398         0,
399         py_base_repr,
400         0,0,0,0,0,0,0,0,0,
401         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
402         0,0,0,0,0,0,0,
403         Methods,
404         0,
405         0,
406         &SCA_IActuator::Type,
407         0,0,0,0,0,0,
408         py_base_new
409 };
410
411 PyMethodDef KX_CameraActuator::Methods[] = {
412         {NULL, NULL} //Sentinel
413 };
414
415 PyAttributeDef KX_CameraActuator::Attributes[] = {
416         KX_PYATTRIBUTE_FLOAT_RW("min",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_minHeight),
417         KX_PYATTRIBUTE_FLOAT_RW("max",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_maxHeight),
418         KX_PYATTRIBUTE_FLOAT_RW("height",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_height),
419         KX_PYATTRIBUTE_SHORT_RW("axis", 0, 3, true, KX_CameraActuator,m_axis),
420         KX_PYATTRIBUTE_RW_FUNCTION("object", KX_CameraActuator, pyattr_get_object,      pyattr_set_object),
421         KX_PYATTRIBUTE_FLOAT_RW("damping",0.f,10.f,KX_CameraActuator,m_damping),
422         {NULL}
423 };
424
425 PyObject* KX_CameraActuator::pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
426 {
427         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
428         if (self->m_ob==NULL)
429                 Py_RETURN_NONE;
430         else
431                 return self->m_ob->GetProxy();
432 }
433
434 int KX_CameraActuator::pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
435 {
436         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
437         KX_GameObject *gameobj;
438         
439         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.object = value: KX_CameraActuator"))
440                 return PY_SET_ATTR_FAIL; // ConvertPythonToGameObject sets the error
441         
442         if (self->m_ob)
443                 self->m_ob->UnregisterActuator(self);   
444
445         if ((self->m_ob = (SCA_IObject*)gameobj))
446                 self->m_ob->RegisterActuator(self);
447         
448         return PY_SET_ATTR_SUCCESS;
449 }
450
451 #endif // WITH_PYTHON
452
453 /* eof */