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