merge from trunk #37722
[blender-staging.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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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 /** \file gameengine/Ketsji/KX_CameraActuator.cpp
34  *  \ingroup ketsji
35  */
36
37
38 #include "KX_CameraActuator.h"
39 #include <iostream>
40 #include <math.h>
41 #include <float.h>
42 #include "KX_GameObject.h"
43
44 #include "PyObjectPlus.h" 
45
46
47 /* ------------------------------------------------------------------------- */
48 /* Native functions                                                          */
49 /* ------------------------------------------------------------------------- */
50
51 KX_CameraActuator::KX_CameraActuator(
52         SCA_IObject* gameobj, 
53         SCA_IObject *obj,
54         float hght,
55         float minhght,
56         float maxhght,
57         bool  xytog,
58         float damping
59 ): 
60         SCA_IActuator(gameobj, KX_ACT_CAMERA),
61         m_ob (obj),
62         m_height (hght),
63         m_minHeight (minhght),
64         m_maxHeight (maxhght),
65         m_x (xytog),
66         m_damping (damping)
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         return replica;
85 };
86
87 void KX_CameraActuator::ProcessReplica()
88 {
89         if (m_ob)
90                 m_ob->RegisterActuator(this);
91         SCA_IActuator::ProcessReplica();
92 }
93
94 bool KX_CameraActuator::UnlinkObject(SCA_IObject* clientobj)
95 {
96         if (clientobj == m_ob)
97         {
98                 // this object is being deleted, we cannot continue to track it.
99                 m_ob = NULL;
100                 return true;
101         }
102         return false;
103 }
104
105
106 void KX_CameraActuator::Relink(CTR_Map<CTR_HashedPtr, void*> *obj_map)
107 {
108         void **h_obj = (*obj_map)[m_ob];
109         if (h_obj) {
110                 if (m_ob)
111                         m_ob->UnregisterActuator(this);
112                 m_ob = (SCA_IObject*)(*h_obj);
113                 m_ob->RegisterActuator(this);
114         }
115 }
116
117 /* three functions copied from blender arith... don't know if there's an equivalent */
118
119 static float Kx_Normalize(float *n)
120 {
121         float d;
122         
123         d= n[0]*n[0]+n[1]*n[1]+n[2]*n[2];
124         /* FLT_EPSILON is too large! A larger value causes normalize errors in a scaled down utah teapot */
125         if(d>0.0000000000001) {
126                 d= sqrt(d);
127
128                 n[0]/=d; 
129                 n[1]/=d; 
130                 n[2]/=d;
131         } else {
132                 n[0]=n[1]=n[2]= 0.0;
133                 d= 0.0;
134         }
135         return d;
136 }
137
138 static void Kx_Crossf(float *c, float *a, float *b)
139 {
140         c[0] = a[1] * b[2] - a[2] * b[1];
141         c[1] = a[2] * b[0] - a[0] * b[2];
142         c[2] = a[0] * b[1] - a[1] * b[0];
143 }
144
145
146 static void Kx_VecUpMat3(float *vec, float mat[][3], short axis)
147 {
148
149         // Construct a camera matrix s.t. the specified axis
150
151         // maps to the given vector (*vec). Also defines the rotation
152
153         // about this axis by mapping one of the other axis to the y-axis.
154
155
156         float inp;
157         short cox = 0, coy = 0, coz = 0;
158         
159         /* up varieeren heeft geen zin, is eigenlijk helemaal geen up!
160          * zie VecUpMat3old
161          */
162
163         if(axis==0) {
164                 cox= 0; coy= 1; coz= 2;         /* Y up Z tr */
165         }
166         if(axis==1) {
167                 cox= 1; coy= 2; coz= 0;         /* Z up X tr */
168         }
169         if(axis==2) {
170                 cox= 2; coy= 0; coz= 1;         /* X up Y tr */
171         }
172         if(axis==3) {
173                 cox= 0; coy= 1; coz= 2;         /* Y op -Z tr */
174                 vec[0]= -vec[0];
175                 vec[1]= -vec[1];
176                 vec[2]= -vec[2];
177         }
178         if(axis==4) {
179                 cox= 1; coy= 0; coz= 2;         /*  */
180         }
181         if(axis==5) {
182                 cox= 2; coy= 1; coz= 0;         /* Y up X tr */
183         }
184
185         mat[coz][0]= vec[0];
186         mat[coz][1]= vec[1];
187         mat[coz][2]= vec[2];
188         if (Kx_Normalize((float *)mat[coz]) == 0.f) {
189                 /* this is a very abnormal situation: the camera has reach the object center exactly
190                    We will choose a completely arbitrary direction */
191                 mat[coz][0] = 1.0f;
192                 mat[coz][1] = 0.0f;
193                 mat[coz][2] = 0.0f;
194         }
195         
196         inp= mat[coz][2];
197         mat[coy][0]= - inp*mat[coz][0];
198         mat[coy][1]= - inp*mat[coz][1];
199         mat[coy][2]= 1.0 - inp*mat[coz][2];
200
201         if (Kx_Normalize((float *)mat[coy]) == 0.f) {
202                 /* the camera is vertical, chose the y axis arbitrary */
203                 mat[coy][0] = 0.f;
204                 mat[coy][1] = 1.f;
205                 mat[coy][2] = 0.f;
206         }
207         
208         Kx_Crossf(mat[cox], mat[coy], mat[coz]);
209         
210 }
211
212 bool KX_CameraActuator::Update(double curtime, bool frame)
213 {
214         /* wondering... is it really neccesary/desirable to suppress negative    */
215         /* events here?                                                          */
216         bool bNegativeEvent = IsNegativeEvent();
217         RemoveAllEvents();
218
219         if (bNegativeEvent || !m_ob) 
220                 return false;
221         
222         KX_GameObject *obj = (KX_GameObject*) GetParent();
223         MT_Point3 from = obj->NodeGetWorldPosition();
224         MT_Matrix3x3 frommat = obj->NodeGetWorldOrientation();
225         /* These casts are _very_ dangerous!!! */
226         MT_Point3 lookat = ((KX_GameObject*)m_ob)->NodeGetWorldPosition();
227         MT_Matrix3x3 actormat = ((KX_GameObject*)m_ob)->NodeGetWorldOrientation();
228
229         float fp1[3], fp2[3], rc[3];
230         float inp, fac; //, factor = 0.0; /* some factor...                                    */
231         float mindistsq, maxdistsq, distsq;
232         float mat[3][3];
233         
234         /* The rules:                                                            */
235         /* CONSTRAINT 1: not implemented */
236         /* CONSTRAINT 2: can camera see actor?              */
237         /* CONSTRAINT 3: fixed height relative to floor below actor.             */
238         /* CONSTRAINT 4: camera rotates behind actor                              */
239         /* CONSTRAINT 5: minimum / maximum distance                             */
240         /* CONSTRAINT 6: again: fixed height relative to floor below actor        */
241         /* CONSTRAINT 7: track to floor below actor                               */
242         /* CONSTRAINT 8: look a little bit left or right, depending on how the
243
244            character is looking (horizontal x)
245  */
246
247         /* ...and then set the camera position. Since we assume the parent of    */
248         /* this actuator is always a camera, just set the parent position and    */
249         /* rotation. We do not check whether we really have a camera as parent.  */
250         /* It may be better to turn this into a general tracking actuator later  */
251         /* on, since lots of plausible relations can be filled in here.          */
252
253         /* ... set up some parameters ...                                        */
254         /* missing here: the 'floorloc' of the actor's shadow */
255
256         mindistsq= m_minHeight*m_minHeight;
257         maxdistsq= m_maxHeight*m_maxHeight;
258
259         /* C1: not checked... is a future option                                 */
260
261         /* C2: blender test_visibility function. Can this be a ray-test?         */
262
263         /* C3: fixed height  */
264         from[2] = (15.0*from[2] + lookat[2] + m_height)/16.0;
265
266
267         /* C4: camera behind actor   */
268         if (m_x) {
269                 fp1[0] = actormat[0][0];
270                 fp1[1] = actormat[1][0];
271                 fp1[2] = actormat[2][0];
272
273                 fp2[0] = frommat[0][0];
274                 fp2[1] = frommat[1][0];
275                 fp2[2] = frommat[2][0];
276         } 
277         else {
278                 fp1[0] = actormat[0][1];
279                 fp1[1] = actormat[1][1];
280                 fp1[2] = actormat[2][1];
281
282                 fp2[0] = frommat[0][1];
283                 fp2[1] = frommat[1][1];
284                 fp2[2] = frommat[2][1];
285         }
286         
287         inp= fp1[0]*fp2[0] + fp1[1]*fp2[1] + fp1[2]*fp2[2];
288         fac= (-1.0 + inp) * m_damping;
289
290         from[0]+= fac*fp1[0];
291         from[1]+= fac*fp1[1];
292         from[2]+= fac*fp1[2];
293         
294         /* alleen alstie ervoor ligt: cross testen en loodrechte bijtellen */
295         if(inp<0.0) {
296                 if(fp1[0]*fp2[1] - fp1[1]*fp2[0] > 0.0) {
297                         from[0]-= fac*fp1[1];
298                         from[1]+= fac*fp1[0];
299                 }
300                 else {
301                         from[0]+= fac*fp1[1];
302                         from[1]-= fac*fp1[0];
303                 }
304         }
305
306         /* CONSTRAINT 5: minimum / maximum afstand */
307
308         rc[0]= (lookat[0]-from[0]);
309         rc[1]= (lookat[1]-from[1]);
310         rc[2]= (lookat[2]-from[2]);
311         distsq= rc[0]*rc[0] + rc[1]*rc[1] + rc[2]*rc[2];
312
313         if(distsq > maxdistsq) {
314                 distsq = 0.15*(distsq-maxdistsq)/distsq;
315                 
316                 from[0] += distsq*rc[0];
317                 from[1] += distsq*rc[1];
318                 from[2] += distsq*rc[2];
319         }
320         else if(distsq < mindistsq) {
321                 distsq = 0.15*(mindistsq-distsq)/mindistsq;
322                 
323                 from[0] -= distsq*rc[0];
324                 from[1] -= distsq*rc[1];
325                 from[2] -= distsq*rc[2];
326         }
327
328
329         /* CONSTRAINT 7: track to schaduw */
330         rc[0]= (lookat[0]-from[0]);
331         rc[1]= (lookat[1]-from[1]);
332         rc[2]= (lookat[2]-from[2]);
333         Kx_VecUpMat3(rc, mat, 3);       /* y up Track -z */
334         
335
336
337
338         /* now set the camera position and rotation */
339         
340         obj->NodeSetLocalPosition(from);
341         
342         actormat[0][0]= mat[0][0]; actormat[0][1]= mat[1][0]; actormat[0][2]= mat[2][0];
343         actormat[1][0]= mat[0][1]; actormat[1][1]= mat[1][1]; actormat[1][2]= mat[2][1];
344         actormat[2][0]= mat[0][2]; actormat[2][1]= mat[1][2]; actormat[2][2]= mat[2][2];
345         obj->NodeSetLocalOrientation(actormat);
346
347         return true;
348 }
349
350 CValue *KX_CameraActuator::findObject(char *obName) 
351 {
352         /* hook to object system */
353         return NULL;
354 }
355
356 #ifdef WITH_PYTHON
357
358 /* ------------------------------------------------------------------------- */
359 /* Python functions                                                          */
360 /* ------------------------------------------------------------------------- */
361
362 /* Integration hooks ------------------------------------------------------- */
363 PyTypeObject KX_CameraActuator::Type = {
364         PyVarObject_HEAD_INIT(NULL, 0)
365         "KX_CameraActuator",
366         sizeof(PyObjectPlus_Proxy),
367         0,
368         py_base_dealloc,
369         0,
370         0,
371         0,
372         0,
373         py_base_repr,
374         0,0,0,0,0,0,0,0,0,
375         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
376         0,0,0,0,0,0,0,
377         Methods,
378         0,
379         0,
380         &SCA_IActuator::Type,
381         0,0,0,0,0,0,
382         py_base_new
383 };
384
385 PyMethodDef KX_CameraActuator::Methods[] = {
386         {NULL, NULL} //Sentinel
387 };
388
389 PyAttributeDef KX_CameraActuator::Attributes[] = {
390         KX_PYATTRIBUTE_FLOAT_RW("min",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_minHeight),
391         KX_PYATTRIBUTE_FLOAT_RW("max",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_maxHeight),
392         KX_PYATTRIBUTE_FLOAT_RW("height",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_height),
393         KX_PYATTRIBUTE_BOOL_RW("useXY",KX_CameraActuator,m_x),
394         KX_PYATTRIBUTE_RW_FUNCTION("object", KX_CameraActuator, pyattr_get_object,      pyattr_set_object),
395         KX_PYATTRIBUTE_FLOAT_RW("damping",0.f,10.f,KX_CameraActuator,m_damping),
396         {NULL}
397 };
398
399 PyObject* KX_CameraActuator::pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
400 {
401         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
402         if (self->m_ob==NULL)
403                 Py_RETURN_NONE;
404         else
405                 return self->m_ob->GetProxy();
406 }
407
408 int KX_CameraActuator::pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
409 {
410         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
411         KX_GameObject *gameobj;
412         
413         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.object = value: KX_CameraActuator"))
414                 return PY_SET_ATTR_FAIL; // ConvertPythonToGameObject sets the error
415         
416         if (self->m_ob)
417                 self->m_ob->UnregisterActuator(self);   
418
419         if ((self->m_ob = (SCA_IObject*)gameobj))
420                 self->m_ob->RegisterActuator(self);
421         
422         return PY_SET_ATTR_SUCCESS;
423 }
424
425 #endif // WITH_PYTHON
426
427 /* eof */