Ghost Context Refactor
[blender-staging.git] / source / gameengine / VideoTexture / ImageRender.cpp
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software  Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * Copyright (c) 2007 The Zdeno Ash Miklas
19  *
20  * This source file is part of VideoTexture library
21  *
22  * Contributor(s):
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file gameengine/VideoTexture/ImageRender.cpp
28  *  \ingroup bgevideotex
29  */
30
31 // implementation
32
33 #include "PyObjectPlus.h"
34 #include <structmember.h>
35 #include <float.h>
36 #include <math.h>
37
38
39 #include "glew-mx.h"
40
41 #include "KX_PythonInit.h"
42 #include "DNA_scene_types.h"
43 #include "RAS_CameraData.h"
44 #include "RAS_MeshObject.h"
45 #include "RAS_Polygon.h"
46 #include "BLI_math.h"
47
48 #include "ImageRender.h"
49 #include "ImageBase.h"
50 #include "BlendType.h"
51 #include "Exception.h"
52 #include "Texture.h"
53
54 ExceptionID SceneInvalid, CameraInvalid, ObserverInvalid;
55 ExceptionID MirrorInvalid, MirrorSizeInvalid, MirrorNormalInvalid, MirrorHorizontal, MirrorTooSmall;
56 ExpDesc SceneInvalidDesc(SceneInvalid, "Scene object is invalid");
57 ExpDesc CameraInvalidDesc(CameraInvalid, "Camera object is invalid");
58 ExpDesc ObserverInvalidDesc(ObserverInvalid, "Observer object is invalid");
59 ExpDesc MirrorInvalidDesc(MirrorInvalid, "Mirror object is invalid");
60 ExpDesc MirrorSizeInvalidDesc(MirrorSizeInvalid, "Mirror has no vertex or no size");
61 ExpDesc MirrorNormalInvalidDesc(MirrorNormalInvalid, "Cannot determine mirror plane");
62 ExpDesc MirrorHorizontalDesc(MirrorHorizontal, "Mirror is horizontal in local space");
63 ExpDesc MirrorTooSmallDesc(MirrorTooSmall, "Mirror is too small");
64
65 // constructor
66 ImageRender::ImageRender (KX_Scene *scene, KX_Camera * camera) :
67     ImageViewport(),
68     m_render(true),
69     m_scene(scene),
70     m_camera(camera),
71     m_owncamera(false),
72     m_observer(NULL),
73     m_mirror(NULL),
74     m_clip(100.f),
75     m_mirrorHalfWidth(0.f),
76     m_mirrorHalfHeight(0.f)
77 {
78         // initialize background color
79         setBackground(0, 0, 255, 255);
80         // retrieve rendering objects
81         m_engine = KX_GetActiveEngine();
82         m_rasterizer = m_engine->GetRasterizer();
83         m_canvas = m_engine->GetCanvas();
84 }
85
86 // destructor
87 ImageRender::~ImageRender (void)
88 {
89         if (m_owncamera)
90                 m_camera->Release();
91 }
92
93
94 // set background color
95 void ImageRender::setBackground (int red, int green, int blue, int alpha)
96 {
97         m_background[0] = (red < 0) ? 0.f : (red > 255) ? 1.f : float(red)/255.f;
98         m_background[1] = (green < 0) ? 0.f : (green > 255) ? 1.f : float(green)/255.f;
99         m_background[2] = (blue < 0) ? 0.f : (blue > 255) ? 1.f : float(blue)/255.f;
100         m_background[3] = (alpha < 0) ? 0.f : (alpha > 255) ? 1.f : float(alpha)/255.f;
101 }
102
103
104 // capture image from viewport
105 void ImageRender::calcImage (unsigned int texId, double ts)
106 {
107         if (m_rasterizer->GetDrawingMode() != RAS_IRasterizer::KX_TEXTURED ||   // no need for texture
108                 m_camera->GetViewport() ||        // camera must be inactive
109                 m_camera == m_scene->GetActiveCamera())
110         {
111                 // no need to compute texture in non texture rendering
112                 m_avail = false;
113                 return;
114         }
115         // render the scene from the camera
116         Render();
117         // get image from viewport
118         ImageViewport::calcImage(texId, ts);
119         // restore OpenGL state
120         m_canvas->EndFrame();
121 }
122
123 void ImageRender::Render()
124 {
125         RAS_FrameFrustum frustrum;
126
127         if (!m_render)
128                 return;
129
130         if (m_mirror)
131         {
132                 // mirror mode, compute camera frustrum, position and orientation
133                 // convert mirror position and normal in world space
134                 const MT_Matrix3x3 & mirrorObjWorldOri = m_mirror->GetSGNode()->GetWorldOrientation();
135                 const MT_Point3 & mirrorObjWorldPos = m_mirror->GetSGNode()->GetWorldPosition();
136                 const MT_Vector3 & mirrorObjWorldScale = m_mirror->GetSGNode()->GetWorldScaling();
137                 MT_Point3 mirrorWorldPos =
138                         mirrorObjWorldPos + mirrorObjWorldScale * (mirrorObjWorldOri * m_mirrorPos);
139                 MT_Vector3 mirrorWorldZ = mirrorObjWorldOri * m_mirrorZ;
140                 // get observer world position
141                 const MT_Point3 & observerWorldPos = m_observer->GetSGNode()->GetWorldPosition();
142                 // get plane D term = mirrorPos . normal
143                 MT_Scalar mirrorPlaneDTerm = mirrorWorldPos.dot(mirrorWorldZ);
144                 // compute distance of observer to mirror = D - observerPos . normal
145                 MT_Scalar observerDistance = mirrorPlaneDTerm - observerWorldPos.dot(mirrorWorldZ);
146                 // if distance < 0.01 => observer is on wrong side of mirror, don't render
147                 if (observerDistance < 0.01)
148                         return;
149                 // set camera world position = observerPos + normal * 2 * distance
150                 MT_Point3 cameraWorldPos = observerWorldPos + (MT_Scalar(2.0)*observerDistance)*mirrorWorldZ;
151                 m_camera->GetSGNode()->SetLocalPosition(cameraWorldPos);
152                 // set camera orientation: z=normal, y=mirror_up in world space, x= y x z
153                 MT_Vector3 mirrorWorldY = mirrorObjWorldOri * m_mirrorY;
154                 MT_Vector3 mirrorWorldX = mirrorObjWorldOri * m_mirrorX;
155                 MT_Matrix3x3 cameraWorldOri(
156                             mirrorWorldX[0], mirrorWorldY[0], mirrorWorldZ[0],
157                             mirrorWorldX[1], mirrorWorldY[1], mirrorWorldZ[1],
158                             mirrorWorldX[2], mirrorWorldY[2], mirrorWorldZ[2]);
159                 m_camera->GetSGNode()->SetLocalOrientation(cameraWorldOri);
160                 m_camera->GetSGNode()->UpdateWorldData(0.0);
161                 // compute camera frustrum:
162                 //   get position of mirror relative to camera: offset = mirrorPos-cameraPos
163                 MT_Vector3 mirrorOffset = mirrorWorldPos - cameraWorldPos;
164                 //   convert to camera orientation
165                 mirrorOffset = mirrorOffset * cameraWorldOri;
166                 //   scale mirror size to world scale:
167                 //     get closest local axis for mirror Y and X axis and scale height and width by local axis scale
168                 MT_Scalar x, y;
169                 x = fabs(m_mirrorY[0]);
170                 y = fabs(m_mirrorY[1]);
171                 float height = (x > y) ?
172                             ((x > fabs(m_mirrorY[2])) ? mirrorObjWorldScale[0] : mirrorObjWorldScale[2]):
173                             ((y > fabs(m_mirrorY[2])) ? mirrorObjWorldScale[1] : mirrorObjWorldScale[2]);
174                 x = fabs(m_mirrorX[0]);
175                 y = fabs(m_mirrorX[1]);
176                 float width = (x > y) ?
177                             ((x > fabs(m_mirrorX[2])) ? mirrorObjWorldScale[0] : mirrorObjWorldScale[2]):
178                             ((y > fabs(m_mirrorX[2])) ? mirrorObjWorldScale[1] : mirrorObjWorldScale[2]);
179                 width *= m_mirrorHalfWidth;
180                 height *= m_mirrorHalfHeight;
181                 //   left = offsetx-width
182                 //   right = offsetx+width
183                 //   top = offsety+height
184                 //   bottom = offsety-height
185                 //   near = -offsetz
186                 //   far = near+100
187                 frustrum.x1 = mirrorOffset[0]-width;
188                 frustrum.x2 = mirrorOffset[0]+width;
189                 frustrum.y1 = mirrorOffset[1]-height;
190                 frustrum.y2 = mirrorOffset[1]+height;
191                 frustrum.camnear = -mirrorOffset[2];
192                 frustrum.camfar = -mirrorOffset[2]+m_clip;
193         }
194         // Store settings to be restored later
195         const RAS_IRasterizer::StereoMode stereomode = m_rasterizer->GetStereoMode();
196         RAS_Rect area = m_canvas->GetWindowArea();
197
198         // The screen area that ImageViewport will copy is also the rendering zone
199         m_canvas->SetViewPort(m_position[0], m_position[1], m_position[0]+m_capSize[0]-1, m_position[1]+m_capSize[1]-1);
200         m_canvas->ClearColor(m_background[0], m_background[1], m_background[2], m_background[3]);
201         m_canvas->ClearBuffer(RAS_ICanvas::COLOR_BUFFER|RAS_ICanvas::DEPTH_BUFFER);
202         m_rasterizer->BeginFrame(m_engine->GetClockTime());
203         m_engine->SetWorldSettings(m_scene->GetWorldInfo());
204         m_rasterizer->SetAuxilaryClientInfo(m_scene);
205         m_rasterizer->DisplayFog();
206         // matrix calculation, don't apply any of the stereo mode
207         m_rasterizer->SetStereoMode(RAS_IRasterizer::RAS_STEREO_NOSTEREO);
208         if (m_mirror)
209         {
210                 // frustrum was computed above
211                 // get frustrum matrix and set projection matrix
212                 MT_Matrix4x4 projmat = m_rasterizer->GetFrustumMatrix(
213                             frustrum.x1, frustrum.x2, frustrum.y1, frustrum.y2, frustrum.camnear, frustrum.camfar);
214
215                 m_camera->SetProjectionMatrix(projmat);
216         }
217         else if (m_camera->hasValidProjectionMatrix()) {
218                 m_rasterizer->SetProjectionMatrix(m_camera->GetProjectionMatrix());
219         }
220         else {
221                 float lens = m_camera->GetLens();
222                 float sensor_x = m_camera->GetSensorWidth();
223                 float sensor_y = m_camera->GetSensorHeight();
224                 bool orthographic = !m_camera->GetCameraData()->m_perspective;
225                 float nearfrust = m_camera->GetCameraNear();
226                 float farfrust = m_camera->GetCameraFar();
227                 float aspect_ratio = 1.0f;
228                 Scene *blenderScene = m_scene->GetBlenderScene();
229                 MT_Matrix4x4 projmat;
230
231                 // compute the aspect ratio from frame blender scene settings so that render to texture
232                 // works the same in Blender and in Blender player
233                 if (blenderScene->r.ysch != 0)
234                         aspect_ratio = float(blenderScene->r.xsch*blenderScene->r.xasp) / float(blenderScene->r.ysch*blenderScene->r.yasp);
235
236                 if (orthographic) {
237
238                         RAS_FramingManager::ComputeDefaultOrtho(
239                                     nearfrust,
240                                     farfrust,
241                                     m_camera->GetScale(),
242                                     aspect_ratio,
243                                                 m_camera->GetSensorFit(),
244                                     frustrum
245                                     );
246
247                         projmat = m_rasterizer->GetOrthoMatrix(
248                                     frustrum.x1, frustrum.x2, frustrum.y1, frustrum.y2, frustrum.camnear, frustrum.camfar);
249                 }
250                 else {
251                         RAS_FramingManager::ComputeDefaultFrustum(
252                                     nearfrust,
253                                     farfrust,
254                                     lens,
255                                     sensor_x,
256                                     sensor_y,
257                                     RAS_SENSORFIT_AUTO,
258                                     aspect_ratio,
259                                     frustrum);
260                         
261                         projmat = m_rasterizer->GetFrustumMatrix(
262                                     frustrum.x1, frustrum.x2, frustrum.y1, frustrum.y2, frustrum.camnear, frustrum.camfar);
263                 }
264                 m_camera->SetProjectionMatrix(projmat);
265         }
266
267         MT_Transform camtrans(m_camera->GetWorldToCamera());
268         MT_Matrix4x4 viewmat(camtrans);
269         
270         m_rasterizer->SetViewMatrix(viewmat, m_camera->NodeGetWorldOrientation(), m_camera->NodeGetWorldPosition(), m_camera->GetCameraData()->m_perspective);
271         m_camera->SetModelviewMatrix(viewmat);
272         // restore the stereo mode now that the matrix is computed
273         m_rasterizer->SetStereoMode(stereomode);
274
275         m_scene->CalculateVisibleMeshes(m_rasterizer,m_camera);
276
277         m_scene->UpdateAnimations(m_engine->GetFrameTime());
278
279         m_scene->RenderBuckets(camtrans, m_rasterizer);
280
281         m_scene->RenderFonts();
282
283         // restore the canvas area now that the render is completed
284         m_canvas->GetWindowArea() = area;
285 }
286
287
288 // cast Image pointer to ImageRender
289 inline ImageRender * getImageRender (PyImage *self)
290 { return static_cast<ImageRender*>(self->m_image); }
291
292
293 // python methods
294
295 // Blender Scene type
296 static BlendType<KX_Scene> sceneType ("KX_Scene");
297 // Blender Camera type
298 static BlendType<KX_Camera> cameraType ("KX_Camera");
299
300
301 // object initialization
302 static int ImageRender_init(PyObject *pySelf, PyObject *args, PyObject *kwds)
303 {
304         // parameters - scene object
305         PyObject *scene;
306         // camera object
307         PyObject *camera;
308         // parameter keywords
309         static const char *kwlist[] = {"sceneObj", "cameraObj", NULL};
310         // get parameters
311         if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO",
312                 const_cast<char**>(kwlist), &scene, &camera))
313                 return -1;
314         try
315         {
316                 // get scene pointer
317                 KX_Scene * scenePtr (NULL);
318                 if (scene != NULL) scenePtr = sceneType.checkType(scene);
319                 // throw exception if scene is not available
320                 if (scenePtr == NULL) THRWEXCP(SceneInvalid, S_OK);
321
322                 // get camera pointer
323                 KX_Camera * cameraPtr (NULL);
324                 if (camera != NULL) cameraPtr = cameraType.checkType(camera);
325                 // throw exception if camera is not available
326                 if (cameraPtr == NULL) THRWEXCP(CameraInvalid, S_OK);
327
328                 // get pointer to image structure
329                 PyImage *self = reinterpret_cast<PyImage*>(pySelf);
330                 // create source object
331                 if (self->m_image != NULL) delete self->m_image;
332                 self->m_image = new ImageRender(scenePtr, cameraPtr);
333         }
334         catch (Exception & exp)
335         {
336                 exp.report();
337                 return -1;
338         }
339         // initialization succeded
340         return 0;
341 }
342
343
344 // get background color
345 static PyObject *getBackground (PyImage *self, void *closure)
346 {
347         return Py_BuildValue("[BBBB]",
348                              getImageRender(self)->getBackground(0),
349                              getImageRender(self)->getBackground(1),
350                              getImageRender(self)->getBackground(2),
351                              getImageRender(self)->getBackground(3));
352 }
353
354 // set color
355 static int setBackground(PyImage *self, PyObject *value, void *closure)
356 {
357         // check validity of parameter
358         if (value == NULL || !PySequence_Check(value) || PySequence_Size(value) != 4
359                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 0))
360                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 1))
361                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 2))
362                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 3)))
363         {
364                 PyErr_SetString(PyExc_TypeError, "The value must be a sequence of 4 integer between 0 and 255");
365                 return -1;
366         }
367         // set background color
368         getImageRender(self)->setBackground(
369                 (unsigned char)(PyLong_AsLong(PySequence_Fast_GET_ITEM(value, 0))),
370                 (unsigned char)(PyLong_AsLong(PySequence_Fast_GET_ITEM(value, 1))),
371                 (unsigned char)(PyLong_AsLong(PySequence_Fast_GET_ITEM(value, 2))),
372                 (unsigned char)(PyLong_AsLong(PySequence_Fast_GET_ITEM(value, 3))));
373         // success
374         return 0;
375 }
376
377
378 // methods structure
379 static PyMethodDef imageRenderMethods[] =
380 { // methods from ImageBase class
381         {"refresh", (PyCFunction)Image_refresh, METH_NOARGS, "Refresh image - invalidate its current content"},
382         {NULL}
383 };
384 // attributes structure
385 static PyGetSetDef imageRenderGetSets[] =
386
387         {(char*)"background", (getter)getBackground, (setter)setBackground, (char*)"background color", NULL},
388         // attribute from ImageViewport
389         {(char*)"capsize", (getter)ImageViewport_getCaptureSize, (setter)ImageViewport_setCaptureSize, (char*)"size of render area", NULL},
390         {(char*)"alpha", (getter)ImageViewport_getAlpha, (setter)ImageViewport_setAlpha, (char*)"use alpha in texture", NULL},
391         {(char*)"whole", (getter)ImageViewport_getWhole, (setter)ImageViewport_setWhole, (char*)"use whole viewport to render", NULL},
392         // attributes from ImageBase class
393         {(char*)"valid", (getter)Image_valid, NULL, (char*)"bool to tell if an image is available", NULL},
394         {(char*)"image", (getter)Image_getImage, NULL, (char*)"image data", NULL},
395         {(char*)"size", (getter)Image_getSize, NULL, (char*)"image size", NULL},
396         {(char*)"scale", (getter)Image_getScale, (setter)Image_setScale, (char*)"fast scale of image (near neighbor)",  NULL},
397         {(char*)"flip", (getter)Image_getFlip, (setter)Image_setFlip, (char*)"flip image vertically", NULL},
398         {(char*)"zbuff", (getter)Image_getZbuff, (setter)Image_setZbuff, (char*)"use depth buffer as texture", NULL},
399         {(char*)"depth", (getter)Image_getDepth, (setter)Image_setDepth, (char*)"get depth information from z-buffer using unsigned int precision", NULL},
400         {(char*)"filter", (getter)Image_getFilter, (setter)Image_setFilter, (char*)"pixel filter", NULL},
401         {NULL}
402 };
403
404
405 // define python type
406 PyTypeObject ImageRenderType = {
407         PyVarObject_HEAD_INIT(NULL, 0)
408         "VideoTexture.ImageRender",   /*tp_name*/
409         sizeof(PyImage),          /*tp_basicsize*/
410         0,                         /*tp_itemsize*/
411         (destructor)Image_dealloc, /*tp_dealloc*/
412         0,                         /*tp_print*/
413         0,                         /*tp_getattr*/
414         0,                         /*tp_setattr*/
415         0,                         /*tp_compare*/
416         0,                         /*tp_repr*/
417         0,                         /*tp_as_number*/
418         0,                         /*tp_as_sequence*/
419         0,                         /*tp_as_mapping*/
420         0,                         /*tp_hash */
421         0,                         /*tp_call*/
422         0,                         /*tp_str*/
423         0,                         /*tp_getattro*/
424         0,                         /*tp_setattro*/
425         &imageBufferProcs,         /*tp_as_buffer*/
426         Py_TPFLAGS_DEFAULT,        /*tp_flags*/
427         "Image source from render",       /* tp_doc */
428         0,                             /* tp_traverse */
429         0,                             /* tp_clear */
430         0,                             /* tp_richcompare */
431         0,                             /* tp_weaklistoffset */
432         0,                             /* tp_iter */
433         0,                             /* tp_iternext */
434         imageRenderMethods,    /* tp_methods */
435         0,                   /* tp_members */
436         imageRenderGetSets,          /* tp_getset */
437         0,                         /* tp_base */
438         0,                         /* tp_dict */
439         0,                         /* tp_descr_get */
440         0,                         /* tp_descr_set */
441         0,                         /* tp_dictoffset */
442         (initproc)ImageRender_init,     /* tp_init */
443         0,                         /* tp_alloc */
444         Image_allocNew,           /* tp_new */
445 };
446
447 // object initialization
448 static int ImageMirror_init(PyObject *pySelf, PyObject *args, PyObject *kwds)
449 {
450         // parameters - scene object
451         PyObject *scene;
452         // reference object for mirror
453         PyObject *observer;
454         // object holding the mirror
455         PyObject *mirror;
456         // material of the mirror
457         short materialID = 0;
458         // parameter keywords
459         static const char *kwlist[] = {"scene", "observer", "mirror", "material", NULL};
460         // get parameters
461         if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOO|h",
462                                          const_cast<char**>(kwlist), &scene, &observer, &mirror, &materialID))
463                 return -1;
464         try
465         {
466                 // get scene pointer
467                 KX_Scene * scenePtr (NULL);
468                 if (scene != NULL && PyObject_TypeCheck(scene, &KX_Scene::Type))
469                         scenePtr = static_cast<KX_Scene*>BGE_PROXY_REF(scene);
470                 else
471                         THRWEXCP(SceneInvalid, S_OK);
472                 
473                 if (scenePtr==NULL) /* in case the python proxy reference is invalid */
474                         THRWEXCP(SceneInvalid, S_OK);
475                 
476                 // get observer pointer
477                 KX_GameObject * observerPtr (NULL);
478                 if (observer != NULL && PyObject_TypeCheck(observer, &KX_GameObject::Type))
479                         observerPtr = static_cast<KX_GameObject*>BGE_PROXY_REF(observer);
480                 else if (observer != NULL && PyObject_TypeCheck(observer, &KX_Camera::Type))
481                         observerPtr = static_cast<KX_Camera*>BGE_PROXY_REF(observer);
482                 else
483                         THRWEXCP(ObserverInvalid, S_OK);
484                 
485                 if (observerPtr==NULL) /* in case the python proxy reference is invalid */
486                         THRWEXCP(ObserverInvalid, S_OK);
487
488                 // get mirror pointer
489                 KX_GameObject * mirrorPtr (NULL);
490                 if (mirror != NULL && PyObject_TypeCheck(mirror, &KX_GameObject::Type))
491                         mirrorPtr = static_cast<KX_GameObject*>BGE_PROXY_REF(mirror);
492                 else
493                         THRWEXCP(MirrorInvalid, S_OK);
494                 
495                 if (mirrorPtr==NULL) /* in case the python proxy reference is invalid */
496                         THRWEXCP(MirrorInvalid, S_OK);
497
498                 // locate the material in the mirror
499                 RAS_IPolyMaterial * material = getMaterial(mirror, materialID);
500                 if (material == NULL)
501                         THRWEXCP(MaterialNotAvail, S_OK);
502
503                 // get pointer to image structure
504                 PyImage *self = reinterpret_cast<PyImage*>(pySelf);
505
506                 // create source object
507                 if (self->m_image != NULL)
508                 {
509                         delete self->m_image;
510                         self->m_image = NULL;
511                 }
512                 self->m_image = new ImageRender(scenePtr, observerPtr, mirrorPtr, material);
513         }
514         catch (Exception & exp)
515         {
516                 exp.report();
517                 return -1;
518         }
519         // initialization succeded
520         return 0;
521 }
522
523 // get background color
524 static PyObject *getClip (PyImage *self, void *closure)
525 {
526         return PyFloat_FromDouble(getImageRender(self)->getClip());
527 }
528
529 // set clip
530 static int setClip(PyImage *self, PyObject *value, void *closure)
531 {
532         // check validity of parameter
533         double clip;
534         if (value == NULL || !PyFloat_Check(value) || (clip = PyFloat_AsDouble(value)) < 0.01 || clip > 5000.0)
535         {
536                 PyErr_SetString(PyExc_TypeError, "The value must be an float between 0.01 and 5000");
537                 return -1;
538         }
539         // set background color
540         getImageRender(self)->setClip(float(clip));
541         // success
542         return 0;
543 }
544
545 // attributes structure
546 static PyGetSetDef imageMirrorGetSets[] =
547
548         {(char*)"clip", (getter)getClip, (setter)setClip, (char*)"clipping distance", NULL},
549         // attribute from ImageRender
550         {(char*)"background", (getter)getBackground, (setter)setBackground, (char*)"background color", NULL},
551         // attribute from ImageViewport
552         {(char*)"capsize", (getter)ImageViewport_getCaptureSize, (setter)ImageViewport_setCaptureSize, (char*)"size of render area", NULL},
553         {(char*)"alpha", (getter)ImageViewport_getAlpha, (setter)ImageViewport_setAlpha, (char*)"use alpha in texture", NULL},
554         {(char*)"whole", (getter)ImageViewport_getWhole, (setter)ImageViewport_setWhole, (char*)"use whole viewport to render", NULL},
555         // attributes from ImageBase class
556         {(char*)"valid", (getter)Image_valid, NULL, (char*)"bool to tell if an image is available", NULL},
557         {(char*)"image", (getter)Image_getImage, NULL, (char*)"image data", NULL},
558         {(char*)"size", (getter)Image_getSize, NULL, (char*)"image size", NULL},
559         {(char*)"scale", (getter)Image_getScale, (setter)Image_setScale, (char*)"fast scale of image (near neighbor)",  NULL},
560         {(char*)"flip", (getter)Image_getFlip, (setter)Image_setFlip, (char*)"flip image vertically", NULL},
561         {(char*)"zbuff", (getter)Image_getZbuff, (setter)Image_setZbuff, (char*)"use depth buffer as texture", NULL},
562         {(char*)"depth", (getter)Image_getDepth, (setter)Image_setDepth, (char*)"get depth information from z-buffer using unsigned int precision", NULL},
563         {(char*)"filter", (getter)Image_getFilter, (setter)Image_setFilter, (char*)"pixel filter", NULL},
564         {NULL}
565 };
566
567
568 // constructor
569 ImageRender::ImageRender (KX_Scene *scene, KX_GameObject *observer, KX_GameObject *mirror, RAS_IPolyMaterial *mat) :
570     ImageViewport(),
571     m_render(false),
572     m_scene(scene),
573     m_observer(observer),
574     m_mirror(mirror),
575     m_clip(100.f)
576 {
577         // this constructor is used for automatic planar mirror
578         // create a camera, take all data by default, in any case we will recompute the frustrum on each frame
579         RAS_CameraData camdata;
580         vector<RAS_TexVert*> mirrorVerts;
581         vector<RAS_TexVert*>::iterator it;
582         float mirrorArea = 0.f;
583         float mirrorNormal[3] = {0.f, 0.f, 0.f};
584         float mirrorUp[3];
585         float dist, vec[3], axis[3];
586         float zaxis[3] = {0.f, 0.f, 1.f};
587         float yaxis[3] = {0.f, 1.f, 0.f};
588         float mirrorMat[3][3];
589         float left, right, top, bottom, back;
590         // make sure this camera will delete its node
591         m_camera= new KX_Camera(scene, KX_Scene::m_callbacks, camdata, true, true);
592         m_camera->SetName("__mirror__cam__");
593         // don't add the camera to the scene object list, it doesn't need to be accessible
594         m_owncamera = true;
595         // retrieve rendering objects
596         m_engine = KX_GetActiveEngine();
597         m_rasterizer = m_engine->GetRasterizer();
598         m_canvas = m_engine->GetCanvas();
599         // locate the vertex assigned to mat and do following calculation in mesh coordinates
600         for (int meshIndex = 0; meshIndex < mirror->GetMeshCount(); meshIndex++)
601         {
602                 RAS_MeshObject* mesh = mirror->GetMesh(meshIndex);
603                 int numPolygons = mesh->NumPolygons();
604                 for (int polygonIndex=0; polygonIndex < numPolygons; polygonIndex++)
605                 {
606                         RAS_Polygon* polygon = mesh->GetPolygon(polygonIndex);
607                         if (polygon->GetMaterial()->GetPolyMaterial() == mat)
608                         {
609                                 RAS_TexVert *v1, *v2, *v3, *v4;
610                                 float normal[3];
611                                 float area;
612                                 // this polygon is part of the mirror,
613                                 v1 = polygon->GetVertex(0);
614                                 v2 = polygon->GetVertex(1);
615                                 v3 = polygon->GetVertex(2);
616                                 mirrorVerts.push_back(v1);
617                                 mirrorVerts.push_back(v2);
618                                 mirrorVerts.push_back(v3);
619                                 if (polygon->VertexCount() == 4) {
620                                         v4 = polygon->GetVertex(3);
621                                         mirrorVerts.push_back(v4);
622                                         area = normal_quad_v3(normal,(float*)v1->getXYZ(), (float*)v2->getXYZ(), (float*)v3->getXYZ(), (float*)v4->getXYZ());
623                                 }
624                                 else {
625                                         area = normal_tri_v3(normal,(float*)v1->getXYZ(), (float*)v2->getXYZ(), (float*)v3->getXYZ());
626                                 }
627                                 area = fabs(area);
628                                 mirrorArea += area;
629                                 mul_v3_fl(normal, area);
630                                 add_v3_v3v3(mirrorNormal, mirrorNormal, normal);
631                         }
632                 }
633         }
634         if (mirrorVerts.size() == 0 || mirrorArea < FLT_EPSILON)
635         {
636                 // no vertex or zero size mirror
637                 THRWEXCP(MirrorSizeInvalid, S_OK);
638         }
639         // compute average normal of mirror faces
640         mul_v3_fl(mirrorNormal, 1.0f/mirrorArea);
641         if (normalize_v3(mirrorNormal) == 0.f)
642         {
643                 // no normal
644                 THRWEXCP(MirrorNormalInvalid, S_OK);
645         }
646         // the mirror plane has an equation of the type ax+by+cz = d where (a,b,c) is the normal vector
647         // if the mirror is more vertical then horizontal, the Z axis is the up direction.
648         // otherwise the Y axis is the up direction.
649         // If the mirror is not perfectly vertical(horizontal), the Z(Y) axis projection on the mirror
650         // plan by the normal will be the up direction.
651         if (fabsf(mirrorNormal[2]) > fabsf(mirrorNormal[1]) &&
652             fabsf(mirrorNormal[2]) > fabsf(mirrorNormal[0]))
653         {
654                 // the mirror is more horizontal than vertical
655                 copy_v3_v3(axis, yaxis);
656         }
657         else
658         {
659                 // the mirror is more vertical than horizontal
660                 copy_v3_v3(axis, zaxis);
661         }
662         dist = dot_v3v3(mirrorNormal, axis);
663         if (fabsf(dist) < FLT_EPSILON)
664         {
665                 // the mirror is already fully aligned with up axis
666                 copy_v3_v3(mirrorUp, axis);
667         }
668         else
669         {
670                 // projection of axis to mirror plane through normal
671                 copy_v3_v3(vec, mirrorNormal);
672                 mul_v3_fl(vec, dist);
673                 sub_v3_v3v3(mirrorUp, axis, vec);
674                 if (normalize_v3(mirrorUp) == 0.f)
675                 {
676                         // should not happen
677                         THRWEXCP(MirrorHorizontal, S_OK);
678                         return;
679                 }
680         }
681         // compute rotation matrix between local coord and mirror coord
682         // to match camera orientation, we select mirror z = -normal, y = up, x = y x z
683         negate_v3_v3(mirrorMat[2], mirrorNormal);
684         copy_v3_v3(mirrorMat[1], mirrorUp);
685         cross_v3_v3v3(mirrorMat[0], mirrorMat[1], mirrorMat[2]);
686         // transpose to make it a orientation matrix from local space to mirror space
687         transpose_m3(mirrorMat);
688         // transform all vertex to plane coordinates and determine mirror position
689         left = FLT_MAX;
690         right = -FLT_MAX;
691         bottom = FLT_MAX;
692         top = -FLT_MAX;
693         back = -FLT_MAX; // most backward vertex (=highest Z coord in mirror space)
694         for (it = mirrorVerts.begin(); it != mirrorVerts.end(); it++)
695         {
696                 copy_v3_v3(vec, (float*)(*it)->getXYZ());
697                 mul_m3_v3(mirrorMat, vec);
698                 if (vec[0] < left)
699                         left = vec[0];
700                 if (vec[0] > right)
701                         right = vec[0];
702                 if (vec[1] < bottom)
703                         bottom = vec[1];
704                 if (vec[1] > top)
705                         top = vec[1];
706                 if (vec[2] > back)
707                         back = vec[2];
708         }
709         // now store this information in the object for later rendering
710         m_mirrorHalfWidth = (right-left)*0.5f;
711         m_mirrorHalfHeight = (top-bottom)*0.5f;
712         if (m_mirrorHalfWidth < 0.01f || m_mirrorHalfHeight < 0.01f)
713         {
714                 // mirror too small
715                 THRWEXCP(MirrorTooSmall, S_OK);
716         }
717         // mirror position in mirror coord
718         vec[0] = (left+right)*0.5f;
719         vec[1] = (top+bottom)*0.5f;
720         vec[2] = back;
721         // convert it in local space: transpose again the matrix to get back to mirror to local transform
722         transpose_m3(mirrorMat);
723         mul_m3_v3(mirrorMat, vec);
724         // mirror position in local space
725         m_mirrorPos.setValue(vec[0], vec[1], vec[2]);
726         // mirror normal vector (pointed towards the back of the mirror) in local space
727         m_mirrorZ.setValue(-mirrorNormal[0], -mirrorNormal[1], -mirrorNormal[2]);
728         m_mirrorY.setValue(mirrorUp[0], mirrorUp[1], mirrorUp[2]);
729         m_mirrorX = m_mirrorY.cross(m_mirrorZ);
730         m_render = true;
731
732         setBackground(0, 0, 255, 255);
733 }
734
735
736
737
738 // define python type
739 PyTypeObject ImageMirrorType = {
740         PyVarObject_HEAD_INIT(NULL, 0)
741         "VideoTexture.ImageMirror",   /*tp_name*/
742         sizeof(PyImage),          /*tp_basicsize*/
743         0,                         /*tp_itemsize*/
744         (destructor)Image_dealloc, /*tp_dealloc*/
745         0,                         /*tp_print*/
746         0,                         /*tp_getattr*/
747         0,                         /*tp_setattr*/
748         0,                         /*tp_compare*/
749         0,                         /*tp_repr*/
750         0,                         /*tp_as_number*/
751         0,                         /*tp_as_sequence*/
752         0,                         /*tp_as_mapping*/
753         0,                         /*tp_hash */
754         0,                         /*tp_call*/
755         0,                         /*tp_str*/
756         0,                         /*tp_getattro*/
757         0,                         /*tp_setattro*/
758         &imageBufferProcs,         /*tp_as_buffer*/
759         Py_TPFLAGS_DEFAULT,        /*tp_flags*/
760         "Image source from mirror",       /* tp_doc */
761         0,                             /* tp_traverse */
762         0,                             /* tp_clear */
763         0,                             /* tp_richcompare */
764         0,                             /* tp_weaklistoffset */
765         0,                             /* tp_iter */
766         0,                             /* tp_iternext */
767         imageRenderMethods,    /* tp_methods */
768         0,                   /* tp_members */
769         imageMirrorGetSets,          /* tp_getset */
770         0,                         /* tp_base */
771         0,                         /* tp_dict */
772         0,                         /* tp_descr_get */
773         0,                         /* tp_descr_set */
774         0,                         /* tp_dictoffset */
775         (initproc)ImageMirror_init,     /* tp_init */
776         0,                         /* tp_alloc */
777         Image_allocNew,           /* tp_new */
778 };
779
780