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