code cleanup: use cosf and sinf when both args and results are float values.
[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 #include "BLI_math_vector.h"
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         short axis,
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_axis(axis),
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 /* copied from blender BLI_math ... don't know if there's an equivalent */
118
119 static void Kx_VecUpMat3(float vec[3], 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 range has no meaning, is not really up!
133          * see: 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         if (normalize_v3((float *)mat[coz]) == 0.f) {
162                 /* this is a very abnormal situation: the camera has reach the object center exactly
163                  * We will choose a completely arbitrary direction */
164                 mat[coz][0] = 1.0f;
165                 mat[coz][1] = 0.0f;
166                 mat[coz][2] = 0.0f;
167         }
168         
169         inp = mat[coz][2];
170         mat[coy][0] =      - inp * mat[coz][0];
171         mat[coy][1] =      - inp * mat[coz][1];
172         mat[coy][2] = 1.0f - inp * mat[coz][2];
173
174         if (normalize_v3((float *)mat[coy]) == 0.f) {
175                 /* the camera is vertical, chose the y axis arbitrary */
176                 mat[coy][0] = 0.f;
177                 mat[coy][1] = 1.f;
178                 mat[coy][2] = 0.f;
179         }
180         
181         cross_v3_v3v3(mat[cox], mat[coy], mat[coz]);
182 }
183
184 bool KX_CameraActuator::Update(double curtime, bool frame)
185 {
186         /* wondering... is it really necessary/desirable to suppress negative    */
187         /* events here?                                                          */
188         bool bNegativeEvent = IsNegativeEvent();
189         RemoveAllEvents();
190
191         if (bNegativeEvent || !m_ob) 
192                 return false;
193         
194         KX_GameObject *obj = (KX_GameObject*) GetParent();
195         MT_Point3 from = obj->NodeGetWorldPosition();
196         MT_Matrix3x3 frommat = obj->NodeGetWorldOrientation();
197         /* These casts are _very_ dangerous!!! */
198         MT_Point3 lookat = ((KX_GameObject*)m_ob)->NodeGetWorldPosition();
199         MT_Matrix3x3 actormat = ((KX_GameObject*)m_ob)->NodeGetWorldOrientation();
200
201         float fp1[3], fp2[3], rc[3];
202         float inp, fac; //, factor = 0.0; /* some factor...                                    */
203         float mindistsq, maxdistsq, distsq;
204         float mat[3][3];
205         
206         /* The rules:                                                            */
207         /* CONSTRAINT 1: not implemented */
208         /* CONSTRAINT 2: can camera see actor?              */
209         /* CONSTRAINT 3: fixed height relative to floor below actor.             */
210         /* CONSTRAINT 4: camera rotates behind actor                              */
211         /* CONSTRAINT 5: minimum / maximum distance                             */
212         /* CONSTRAINT 6: again: fixed height relative to floor below actor        */
213         /* CONSTRAINT 7: track to floor below actor                               */
214         /* CONSTRAINT 8: look a little bit left or right, depending on how the
215          *
216          * character is looking (horizontal x)
217          */
218
219         /* ...and then set the camera position. Since we assume the parent of    */
220         /* this actuator is always a camera, just set the parent position and    */
221         /* rotation. We do not check whether we really have a camera as parent.  */
222         /* It may be better to turn this into a general tracking actuator later  */
223         /* on, since lots of plausible relations can be filled in here.          */
224
225         /* ... set up some parameters ...                                        */
226         /* missing here: the 'floorloc' of the actor's shadow */
227
228         mindistsq= m_minHeight*m_minHeight;
229         maxdistsq= m_maxHeight*m_maxHeight;
230
231         /* C1: not checked... is a future option                                 */
232
233         /* C2: blender test_visibility function. Can this be a ray-test?         */
234
235         /* C3: fixed height  */
236         from[2] = (15.0f * from[2] + lookat[2] + m_height) / 16.0f;
237
238
239         /* C4: camera behind actor   */
240         switch (m_axis) {
241                 case OB_POSX:
242                         /* X */
243                         fp1[0] = actormat[0][0];
244                         fp1[1] = actormat[1][0];
245                         fp1[2] = actormat[2][0];
246
247                         fp2[0] = frommat[0][0];
248                         fp2[1] = frommat[1][0];
249                         fp2[2] = frommat[2][0];
250                         break;
251                 case OB_POSY:
252                         /* Y */
253                         fp1[0] = actormat[0][1];
254                         fp1[1] = actormat[1][1];
255                         fp1[2] = actormat[2][1];
256
257                         fp2[0] = frommat[0][1];
258                         fp2[1] = frommat[1][1];
259                         fp2[2] = frommat[2][1];
260                         break;
261                 case OB_NEGX:
262                         /* -X */
263                         fp1[0] = -actormat[0][0];
264                         fp1[1] = -actormat[1][0];
265                         fp1[2] = -actormat[2][0];
266
267                         fp2[0] = frommat[0][0];
268                         fp2[1] = frommat[1][0];
269                         fp2[2] = frommat[2][0];
270                         break;
271                 case OB_NEGY:
272                         /* -Y */
273                         fp1[0] = -actormat[0][1];
274                         fp1[1] = -actormat[1][1];
275                         fp1[2] = -actormat[2][1];
276
277                         fp2[0] = frommat[0][1];
278                         fp2[1] = frommat[1][1];
279                         fp2[2] = frommat[2][1];
280                         break;
281                 default:
282                         assert(0);
283                         break;
284         }
285         
286         inp = fp1[0]*fp2[0] + fp1[1]*fp2[1] + fp1[2]*fp2[2];
287         fac = (-1.0f + inp) * m_damping;
288
289         from[0]+= fac*fp1[0];
290         from[1]+= fac*fp1[1];
291         from[2]+= fac*fp1[2];
292         
293         /* alleen alstie ervoor ligt: cross testen en loodrechte bijtellen */
294         if (inp < 0.0f) {
295                 if (fp1[0] * fp2[1] - fp1[1] * fp2[0] > 0.0f) {
296                         from[0] -= fac * fp1[1];
297                         from[1] += fac * fp1[0];
298                 }
299                 else {
300                         from[0] += fac * fp1[1];
301                         from[1] -= fac * fp1[0];
302                 }
303         }
304
305         /* CONSTRAINT 5: minimum / maximum afstand */
306
307         rc[0]= (lookat[0]-from[0]);
308         rc[1]= (lookat[1]-from[1]);
309         rc[2]= (lookat[2]-from[2]);
310         distsq = rc[0]*rc[0] + rc[1]*rc[1] + rc[2]*rc[2];
311
312         if (distsq > maxdistsq) {
313                 distsq = 0.15f * (distsq - maxdistsq) / distsq;
314                 
315                 from[0] += distsq*rc[0];
316                 from[1] += distsq*rc[1];
317                 from[2] += distsq*rc[2];
318         }
319         else if (distsq < mindistsq) {
320                 distsq = 0.15f * (mindistsq - distsq) / mindistsq;
321                 
322                 from[0] -= distsq*rc[0];
323                 from[1] -= distsq*rc[1];
324                 from[2] -= distsq*rc[2];
325         }
326
327
328         /* CONSTRAINT 7: track to schaduw */
329         rc[0]= (lookat[0]-from[0]);
330         rc[1]= (lookat[1]-from[1]);
331         rc[2]= (lookat[2]-from[2]);
332         Kx_VecUpMat3(rc, mat, 3);       /* y up Track -z */
333         
334
335
336
337         /* now set the camera position and rotation */
338         
339         obj->NodeSetLocalPosition(from);
340         
341         actormat[0][0]= mat[0][0]; actormat[0][1]= mat[1][0]; actormat[0][2]= mat[2][0];
342         actormat[1][0]= mat[0][1]; actormat[1][1]= mat[1][1]; actormat[1][2]= mat[2][1];
343         actormat[2][0]= mat[0][2]; actormat[2][1]= mat[1][2]; actormat[2][2]= mat[2][2];
344         obj->NodeSetLocalOrientation(actormat);
345
346         return true;
347 }
348
349 CValue *KX_CameraActuator::findObject(const char *obName)
350 {
351         /* hook to object system */
352         return NULL;
353 }
354
355 #ifdef WITH_PYTHON
356
357 /* ------------------------------------------------------------------------- */
358 /* Python functions                                                          */
359 /* ------------------------------------------------------------------------- */
360
361 /* Integration hooks ------------------------------------------------------- */
362 PyTypeObject KX_CameraActuator::Type = {
363         PyVarObject_HEAD_INIT(NULL, 0)
364         "KX_CameraActuator",
365         sizeof(PyObjectPlus_Proxy),
366         0,
367         py_base_dealloc,
368         0,
369         0,
370         0,
371         0,
372         py_base_repr,
373         0,0,0,0,0,0,0,0,0,
374         Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE,
375         0,0,0,0,0,0,0,
376         Methods,
377         0,
378         0,
379         &SCA_IActuator::Type,
380         0,0,0,0,0,0,
381         py_base_new
382 };
383
384 PyMethodDef KX_CameraActuator::Methods[] = {
385         {NULL, NULL} //Sentinel
386 };
387
388 PyAttributeDef KX_CameraActuator::Attributes[] = {
389         KX_PYATTRIBUTE_FLOAT_RW("min",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_minHeight),
390         KX_PYATTRIBUTE_FLOAT_RW("max",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_maxHeight),
391         KX_PYATTRIBUTE_FLOAT_RW("height",-FLT_MAX,FLT_MAX,KX_CameraActuator,m_height),
392         KX_PYATTRIBUTE_SHORT_RW("axis", 0, 3, true, KX_CameraActuator,m_axis),
393         KX_PYATTRIBUTE_RW_FUNCTION("object", KX_CameraActuator, pyattr_get_object,      pyattr_set_object),
394         KX_PYATTRIBUTE_FLOAT_RW("damping",0.f,10.f,KX_CameraActuator,m_damping),
395         {NULL}
396 };
397
398 PyObject* KX_CameraActuator::pyattr_get_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef)
399 {
400         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
401         if (self->m_ob==NULL)
402                 Py_RETURN_NONE;
403         else
404                 return self->m_ob->GetProxy();
405 }
406
407 int KX_CameraActuator::pyattr_set_object(void *self_v, const KX_PYATTRIBUTE_DEF *attrdef, PyObject *value)
408 {
409         KX_CameraActuator* self= static_cast<KX_CameraActuator*>(self_v);
410         KX_GameObject *gameobj;
411         
412         if (!ConvertPythonToGameObject(value, &gameobj, true, "actuator.object = value: KX_CameraActuator"))
413                 return PY_SET_ATTR_FAIL; // ConvertPythonToGameObject sets the error
414         
415         if (self->m_ob)
416                 self->m_ob->UnregisterActuator(self);   
417
418         if ((self->m_ob = (SCA_IObject*)gameobj))
419                 self->m_ob->RegisterActuator(self);
420         
421         return PY_SET_ATTR_SUCCESS;
422 }
423
424 #endif // WITH_PYTHON
425
426 /* eof */