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