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