0d8acc9c0c20406d10ce0f46dcecae2fc8ba2468
[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                 float sensor_x = m_camera->GetSensorWidth();
218                 bool orthographic = !m_camera->GetCameraData()->m_perspective;
219                 float nearfrust = m_camera->GetCameraNear();
220                 float farfrust = m_camera->GetCameraFar();
221                 float aspect_ratio = 1.0f;
222                 Scene *blenderScene = m_scene->GetBlenderScene();
223                 MT_Matrix4x4 projmat;
224
225                 // compute the aspect ratio from frame blender scene settings so that render to texture
226                 // works the same in Blender and in Blender player
227                 if (blenderScene->r.ysch != 0)
228                         aspect_ratio = float(blenderScene->r.xsch*blenderScene->r.xasp) / float(blenderScene->r.ysch*blenderScene->r.yasp);
229
230                 if (orthographic) {
231
232                         RAS_FramingManager::ComputeDefaultOrtho(
233                                     nearfrust,
234                                     farfrust,
235                                     m_camera->GetScale(),
236                                     aspect_ratio,
237                                     frustrum
238                                     );
239
240                         projmat = m_rasterizer->GetOrthoMatrix(
241                                     frustrum.x1, frustrum.x2, frustrum.y1, frustrum.y2, frustrum.camnear, frustrum.camfar);
242                 } else
243                 {
244                         RAS_FramingManager::ComputeDefaultFrustum(
245                                     nearfrust,
246                                     farfrust,
247                                     lens,
248                                     sensor_x,
249                                     aspect_ratio,
250                                     frustrum);
251                         
252                         projmat = m_rasterizer->GetFrustumMatrix(
253                                     frustrum.x1, frustrum.x2, frustrum.y1, frustrum.y2, frustrum.camnear, frustrum.camfar);
254                 }
255                 m_camera->SetProjectionMatrix(projmat);
256         }
257
258         MT_Transform camtrans(m_camera->GetWorldToCamera());
259         MT_Matrix4x4 viewmat(camtrans);
260         
261         m_rasterizer->SetViewMatrix(viewmat, m_camera->NodeGetWorldOrientation(), m_camera->NodeGetWorldPosition(), m_camera->GetCameraData()->m_perspective);
262         m_camera->SetModelviewMatrix(viewmat);
263         // restore the stereo mode now that the matrix is computed
264         m_rasterizer->SetStereoMode(stereomode);
265
266         m_scene->CalculateVisibleMeshes(m_rasterizer,m_camera);
267
268         m_scene->RenderBuckets(camtrans, m_rasterizer, m_rendertools);
269
270         // restore the canvas area now that the render is completed
271         m_canvas->GetWindowArea() = area;
272 }
273
274
275 // cast Image pointer to ImageRender
276 inline ImageRender * getImageRender (PyImage * self)
277 { return static_cast<ImageRender*>(self->m_image); }
278
279
280 // python methods
281
282 // Blender Scene type
283 BlendType<KX_Scene> sceneType ("KX_Scene");
284 // Blender Camera type
285 BlendType<KX_Camera> cameraType ("KX_Camera");
286
287
288 // object initialization
289 static int ImageRender_init (PyObject * pySelf, PyObject * args, PyObject * kwds)
290 {
291         // parameters - scene object
292         PyObject * scene;
293         // camera object
294         PyObject * camera;
295         // parameter keywords
296         static const char *kwlist[] = {"sceneObj", "cameraObj", NULL};
297         // get parameters
298         if (!PyArg_ParseTupleAndKeywords(args, kwds, "OO",
299                 const_cast<char**>(kwlist), &scene, &camera))
300                 return -1;
301         try
302         {
303                 // get scene pointer
304                 KX_Scene * scenePtr (NULL);
305                 if (scene != NULL) scenePtr = sceneType.checkType(scene);
306                 // throw exception if scene is not available
307                 if (scenePtr == NULL) THRWEXCP(SceneInvalid, S_OK);
308
309                 // get camera pointer
310                 KX_Camera * cameraPtr (NULL);
311                 if (camera != NULL) cameraPtr = cameraType.checkType(camera);
312                 // throw exception if camera is not available
313                 if (cameraPtr == NULL) THRWEXCP(CameraInvalid, S_OK);
314
315                 // get pointer to image structure
316                 PyImage * self = reinterpret_cast<PyImage*>(pySelf);
317                 // create source object
318                 if (self->m_image != NULL) delete self->m_image;
319                 self->m_image = new ImageRender(scenePtr, cameraPtr);
320         }
321         catch (Exception & exp)
322         {
323                 exp.report();
324                 return -1;
325         }
326         // initialization succeded
327         return 0;
328 }
329
330
331 // get background color
332 PyObject * getBackground (PyImage * self, void * closure)
333 {
334         return Py_BuildValue("[BBBB]",
335                              getImageRender(self)->getBackground(0),
336                              getImageRender(self)->getBackground(1),
337                              getImageRender(self)->getBackground(2),
338                              getImageRender(self)->getBackground(3));
339 }
340
341 // set color
342 static int setBackground (PyImage * self, PyObject * value, void * closure)
343 {
344         // check validity of parameter
345         if (value == NULL || !PySequence_Check(value) || PySequence_Size(value) != 4
346                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 0))
347                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 1))
348                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 2))
349                 || !PyLong_Check(PySequence_Fast_GET_ITEM(value, 3)))
350         {
351                 PyErr_SetString(PyExc_TypeError, "The value must be a sequence of 4 integer between 0 and 255");
352                 return -1;
353         }
354         // set background color
355         getImageRender(self)->setBackground((unsigned char)(PyLong_AsSsize_t(PySequence_Fast_GET_ITEM(value, 0))),
356                 (unsigned char)(PyLong_AsSsize_t(PySequence_Fast_GET_ITEM(value, 1))),
357                 (unsigned char)(PyLong_AsSsize_t(PySequence_Fast_GET_ITEM(value, 2))),
358         (unsigned char)(PyLong_AsSsize_t(PySequence_Fast_GET_ITEM(value, 3))));
359         // success
360         return 0;
361 }
362
363
364 // methods structure
365 static PyMethodDef imageRenderMethods[] =
366 { // methods from ImageBase class
367         {"refresh", (PyCFunction)Image_refresh, METH_NOARGS, "Refresh image - invalidate its current content"},
368         {NULL}
369 };
370 // attributes structure
371 static PyGetSetDef imageRenderGetSets[] =
372
373         {(char*)"background", (getter)getBackground, (setter)setBackground, (char*)"background color", NULL},
374     // attribute from ImageViewport
375         {(char*)"capsize", (getter)ImageViewport_getCaptureSize, (setter)ImageViewport_setCaptureSize, (char*)"size of render area", NULL},
376         {(char*)"alpha", (getter)ImageViewport_getAlpha, (setter)ImageViewport_setAlpha, (char*)"use alpha in texture", NULL},
377         {(char*)"whole", (getter)ImageViewport_getWhole, (setter)ImageViewport_setWhole, (char*)"use whole viewport to render", NULL},
378         // attributes from ImageBase class
379         {(char*)"valid", (getter)Image_valid, NULL, (char*)"bool to tell if an image is available", NULL},
380         {(char*)"image", (getter)Image_getImage, NULL, (char*)"image data", NULL},
381         {(char*)"size", (getter)Image_getSize, NULL, (char*)"image size", NULL},
382         {(char*)"scale", (getter)Image_getScale, (setter)Image_setScale, (char*)"fast scale of image (near neighbour)", NULL},
383         {(char*)"flip", (getter)Image_getFlip, (setter)Image_setFlip, (char*)"flip image vertically", NULL},
384         {(char*)"filter", (getter)Image_getFilter, (setter)Image_setFilter, (char*)"pixel filter", NULL},
385         {NULL}
386 };
387
388
389 // define python type
390 PyTypeObject ImageRenderType =
391
392         PyVarObject_HEAD_INIT(NULL, 0)
393         "VideoTexture.ImageRender",   /*tp_name*/
394         sizeof(PyImage),          /*tp_basicsize*/
395         0,                         /*tp_itemsize*/
396         (destructor)Image_dealloc, /*tp_dealloc*/
397         0,                         /*tp_print*/
398         0,                         /*tp_getattr*/
399         0,                         /*tp_setattr*/
400         0,                         /*tp_compare*/
401         0,                         /*tp_repr*/
402         0,                         /*tp_as_number*/
403         0,                         /*tp_as_sequence*/
404         0,                         /*tp_as_mapping*/
405         0,                         /*tp_hash */
406         0,                         /*tp_call*/
407         0,                         /*tp_str*/
408         0,                         /*tp_getattro*/
409         0,                         /*tp_setattro*/
410         &imageBufferProcs,         /*tp_as_buffer*/
411         Py_TPFLAGS_DEFAULT,        /*tp_flags*/
412         "Image source from render",       /* tp_doc */
413         0,                             /* tp_traverse */
414         0,                             /* tp_clear */
415         0,                             /* tp_richcompare */
416         0,                             /* tp_weaklistoffset */
417         0,                             /* tp_iter */
418         0,                             /* tp_iternext */
419         imageRenderMethods,    /* tp_methods */
420         0,                   /* tp_members */
421         imageRenderGetSets,          /* tp_getset */
422         0,                         /* tp_base */
423         0,                         /* tp_dict */
424         0,                         /* tp_descr_get */
425         0,                         /* tp_descr_set */
426         0,                         /* tp_dictoffset */
427         (initproc)ImageRender_init,     /* tp_init */
428         0,                         /* tp_alloc */
429         Image_allocNew,           /* tp_new */
430 };
431
432 // object initialization
433 static int ImageMirror_init (PyObject * pySelf, PyObject * args, PyObject * kwds)
434 {
435         // parameters - scene object
436         PyObject * scene;
437         // reference object for mirror
438         PyObject * observer;
439         // object holding the mirror
440         PyObject * mirror;
441         // material of the mirror
442         short materialID = 0;
443         // parameter keywords
444         static const char *kwlist[] = {"scene", "observer", "mirror", "material", NULL};
445         // get parameters
446         if (!PyArg_ParseTupleAndKeywords(args, kwds, "OOO|h",
447                                          const_cast<char**>(kwlist), &scene, &observer, &mirror, &materialID))
448                 return -1;
449         try
450         {
451                 // get scene pointer
452                 KX_Scene * scenePtr (NULL);
453                 if (scene != NULL && PyObject_TypeCheck(scene, &KX_Scene::Type))
454                         scenePtr = static_cast<KX_Scene*>BGE_PROXY_REF(scene);
455                 else
456                         THRWEXCP(SceneInvalid, S_OK);
457                 
458                 if(scenePtr==NULL) /* incase the python proxy reference is invalid */
459                         THRWEXCP(SceneInvalid, S_OK);
460                 
461                 // get observer pointer
462                 KX_GameObject * observerPtr (NULL);
463                 if (observer != NULL && PyObject_TypeCheck(observer, &KX_GameObject::Type))
464                         observerPtr = static_cast<KX_GameObject*>BGE_PROXY_REF(observer);
465                 else if (observer != NULL && PyObject_TypeCheck(observer, &KX_Camera::Type))
466                         observerPtr = static_cast<KX_Camera*>BGE_PROXY_REF(observer);
467                 else
468                         THRWEXCP(ObserverInvalid, S_OK);
469                 
470                 if(observerPtr==NULL) /* incase the python proxy reference is invalid */
471                         THRWEXCP(ObserverInvalid, S_OK);
472
473                 // get mirror pointer
474                 KX_GameObject * mirrorPtr (NULL);
475                 if (mirror != NULL && PyObject_TypeCheck(mirror, &KX_GameObject::Type))
476                         mirrorPtr = static_cast<KX_GameObject*>BGE_PROXY_REF(mirror);
477                 else
478                         THRWEXCP(MirrorInvalid, S_OK);
479                 
480                 if(mirrorPtr==NULL) /* incase the python proxy reference is invalid */
481                         THRWEXCP(MirrorInvalid, S_OK);
482
483                 // locate the material in the mirror
484                 RAS_IPolyMaterial * material = getMaterial(mirror, materialID);
485                 if (material == NULL)
486                         THRWEXCP(MaterialNotAvail, S_OK);
487
488                 // get pointer to image structure
489                 PyImage * self = reinterpret_cast<PyImage*>(pySelf);
490
491                 // create source object
492                 if (self->m_image != NULL)
493                 {
494                         delete self->m_image;
495                         self->m_image = NULL;
496                 }
497                 self->m_image = new ImageRender(scenePtr, observerPtr, mirrorPtr, material);
498         }
499         catch (Exception & exp)
500         {
501                 exp.report();
502                 return -1;
503         }
504         // initialization succeded
505         return 0;
506 }
507
508 // get background color
509 PyObject * getClip (PyImage * self, void * closure)
510 {
511         return PyFloat_FromDouble(getImageRender(self)->getClip());
512 }
513
514 // set clip
515 static int setClip (PyImage * self, PyObject * value, void * closure)
516 {
517         // check validity of parameter
518         double clip;
519         if (value == NULL || !PyFloat_Check(value) || (clip = PyFloat_AsDouble(value)) < 0.01 || clip > 5000.0)
520         {
521                 PyErr_SetString(PyExc_TypeError, "The value must be an float between 0.01 and 5000");
522                 return -1;
523         }
524         // set background color
525         getImageRender(self)->setClip(float(clip));
526         // success
527         return 0;
528 }
529
530 // attributes structure
531 static PyGetSetDef imageMirrorGetSets[] =
532
533         {(char*)"clip", (getter)getClip, (setter)setClip, (char*)"clipping distance", NULL},
534         // attribute from ImageRender
535         {(char*)"background", (getter)getBackground, (setter)setBackground, (char*)"background color", NULL},
536         // attribute from ImageViewport
537         {(char*)"capsize", (getter)ImageViewport_getCaptureSize, (setter)ImageViewport_setCaptureSize, (char*)"size of render area", NULL},
538         {(char*)"alpha", (getter)ImageViewport_getAlpha, (setter)ImageViewport_setAlpha, (char*)"use alpha in texture", NULL},
539         {(char*)"whole", (getter)ImageViewport_getWhole, (setter)ImageViewport_setWhole, (char*)"use whole viewport to render", NULL},
540         // attributes from ImageBase class
541         {(char*)"valid", (getter)Image_valid, NULL, (char*)"bool to tell if an image is available", NULL},
542         {(char*)"image", (getter)Image_getImage, NULL, (char*)"image data", NULL},
543         {(char*)"size", (getter)Image_getSize, NULL, (char*)"image size", NULL},
544         {(char*)"scale", (getter)Image_getScale, (setter)Image_setScale, (char*)"fast scale of image (near neighbour)", NULL},
545         {(char*)"flip", (getter)Image_getFlip, (setter)Image_setFlip, (char*)"flip image vertically", NULL},
546         {(char*)"filter", (getter)Image_getFilter, (setter)Image_setFilter, (char*)"pixel filter", NULL},
547         {NULL}
548 };
549
550
551 // constructor
552 ImageRender::ImageRender (KX_Scene * scene, KX_GameObject * observer, KX_GameObject * mirror, RAS_IPolyMaterial * mat) :
553     ImageViewport(),
554     m_render(false),
555     m_scene(scene),
556     m_observer(observer),
557     m_mirror(mirror),
558     m_clip(100.f)
559 {
560         // this constructor is used for automatic planar mirror
561         // create a camera, take all data by default, in any case we will recompute the frustrum on each frame
562         RAS_CameraData camdata;
563         vector<RAS_TexVert*> mirrorVerts;
564         vector<RAS_TexVert*>::iterator it;
565         float mirrorArea = 0.f;
566         float mirrorNormal[3] = {0.f, 0.f, 0.f};
567         float mirrorUp[3];
568         float dist, vec[3], axis[3];
569         float zaxis[3] = {0.f, 0.f, 1.f};
570         float yaxis[3] = {0.f, 1.f, 0.f};
571         float mirrorMat[3][3];
572         float left, right, top, bottom, back;
573         // make sure this camera will delete its node
574         m_camera= new KX_Camera(scene, KX_Scene::m_callbacks, camdata, true, true);
575         m_camera->SetName("__mirror__cam__");
576         // don't add the camera to the scene object list, it doesn't need to be accessible
577         m_owncamera = true;
578         // retrieve rendering objects
579         m_engine = KX_GetActiveEngine();
580         m_rasterizer = m_engine->GetRasterizer();
581         m_canvas = m_engine->GetCanvas();
582         m_rendertools = m_engine->GetRenderTools();
583         // locate the vertex assigned to mat and do following calculation in mesh coordinates
584         for (int meshIndex = 0; meshIndex < mirror->GetMeshCount(); meshIndex++)
585         {
586                 RAS_MeshObject* mesh = mirror->GetMesh(meshIndex);
587                 int numPolygons = mesh->NumPolygons();
588                 for (int polygonIndex=0; polygonIndex < numPolygons; polygonIndex++)
589                 {
590                         RAS_Polygon* polygon = mesh->GetPolygon(polygonIndex);
591                         if (polygon->GetMaterial()->GetPolyMaterial() == mat)
592                         {
593                                 RAS_TexVert *v1, *v2, *v3, *v4;
594                                 float normal[3];
595                                 float area;
596                                 // this polygon is part of the mirror,
597                                 v1 = polygon->GetVertex(0);
598                                 v2 = polygon->GetVertex(1);
599                                 v3 = polygon->GetVertex(2);
600                                 mirrorVerts.push_back(v1);
601                                 mirrorVerts.push_back(v2);
602                                 mirrorVerts.push_back(v3);
603                                 if (polygon->VertexCount() == 4)
604                                 {
605                                         v4 = polygon->GetVertex(3);
606                                         mirrorVerts.push_back(v4);
607                                         area = normal_quad_v3( normal,(float*)v1->getXYZ(), (float*)v2->getXYZ(), (float*)v3->getXYZ(), (float*)v4->getXYZ());
608                                 } else
609                                 {
610                                         area = normal_tri_v3( normal,(float*)v1->getXYZ(), (float*)v2->getXYZ(), (float*)v3->getXYZ());
611                                 }
612                                 area = fabs(area);
613                                 mirrorArea += area;
614                                 mul_v3_fl(normal, area);
615                                 add_v3_v3v3(mirrorNormal, mirrorNormal, normal);
616                         }
617                 }
618         }
619         if (mirrorVerts.size() == 0 || mirrorArea < FLT_EPSILON)
620         {
621                 // no vertex or zero size mirror
622                 THRWEXCP(MirrorSizeInvalid, S_OK);
623         }
624         // compute average normal of mirror faces
625         mul_v3_fl(mirrorNormal, 1.0f/mirrorArea);
626         if (normalize_v3(mirrorNormal) == 0.f)
627         {
628                 // no normal
629                 THRWEXCP(MirrorNormalInvalid, S_OK);
630         }
631         // the mirror plane has an equation of the type ax+by+cz = d where (a,b,c) is the normal vector
632         // if the mirror is more vertical then horizontal, the Z axis is the up direction.
633         // otherwise the Y axis is the up direction.
634         // If the mirror is not perfectly vertical(horizontal), the Z(Y) axis projection on the mirror
635         // plan by the normal will be the up direction.
636         if (fabs(mirrorNormal[2]) > fabs(mirrorNormal[1]) &&
637                 fabs(mirrorNormal[2]) > fabs(mirrorNormal[0]))
638         {
639                 // the mirror is more horizontal than vertical
640                 copy_v3_v3(axis, yaxis);
641         }
642         else
643         {
644                 // the mirror is more vertical than horizontal
645                 copy_v3_v3(axis, zaxis);
646         }
647         dist = dot_v3v3(mirrorNormal, axis);
648         if (fabs(dist) < FLT_EPSILON)
649         {
650                 // the mirror is already fully aligned with up axis
651                 copy_v3_v3(mirrorUp, axis);
652         }
653         else
654         {
655                 // projection of axis to mirror plane through normal
656                 copy_v3_v3(vec, mirrorNormal);
657                 mul_v3_fl(vec, dist);
658                 sub_v3_v3v3(mirrorUp, axis, vec);
659                 if (normalize_v3(mirrorUp) == 0.f)
660                 {
661                         // should not happen
662                         THRWEXCP(MirrorHorizontal, S_OK);
663                         return;
664                 }
665         }
666         // compute rotation matrix between local coord and mirror coord
667         // to match camera orientation, we select mirror z = -normal, y = up, x = y x z
668         negate_v3_v3(mirrorMat[2], mirrorNormal);
669         copy_v3_v3(mirrorMat[1], mirrorUp);
670         cross_v3_v3v3(mirrorMat[0], mirrorMat[1], mirrorMat[2]);
671         // transpose to make it a orientation matrix from local space to mirror space
672         transpose_m3(mirrorMat);
673         // transform all vertex to plane coordinates and determine mirror position
674         left = FLT_MAX;
675         right = -FLT_MAX;
676         bottom = FLT_MAX;
677         top = -FLT_MAX;
678         back = -FLT_MAX; // most backward vertex (=highest Z coord in mirror space)
679         for (it = mirrorVerts.begin(); it != mirrorVerts.end(); it++)
680         {
681                 copy_v3_v3(vec, (float*)(*it)->getXYZ());
682                 mul_m3_v3(mirrorMat, vec);
683                 if (vec[0] < left)
684                         left = vec[0];
685                 if (vec[0] > right)
686                         right = vec[0];
687                 if (vec[1] < bottom)
688                         bottom = vec[1];
689                 if (vec[1] > top)
690                         top = vec[1];
691                 if (vec[2] > back)
692                         back = vec[2];
693         }
694         // now store this information in the object for later rendering
695         m_mirrorHalfWidth = (right-left)*0.5f;
696         m_mirrorHalfHeight = (top-bottom)*0.5f;
697         if (m_mirrorHalfWidth < 0.01f || m_mirrorHalfHeight < 0.01f)
698         {
699                 // mirror too small
700                 THRWEXCP(MirrorTooSmall, S_OK);
701         }
702         // mirror position in mirror coord
703         vec[0] = (left+right)*0.5f;
704         vec[1] = (top+bottom)*0.5f;
705         vec[2] = back;
706         // convert it in local space: transpose again the matrix to get back to mirror to local transform
707         transpose_m3(mirrorMat);
708         mul_m3_v3(mirrorMat, vec);
709         // mirror position in local space
710         m_mirrorPos.setValue(vec[0], vec[1], vec[2]);
711         // mirror normal vector (pointed towards the back of the mirror) in local space
712         m_mirrorZ.setValue(-mirrorNormal[0], -mirrorNormal[1], -mirrorNormal[2]);
713         m_mirrorY.setValue(mirrorUp[0], mirrorUp[1], mirrorUp[2]);
714         m_mirrorX = m_mirrorY.cross(m_mirrorZ);
715         m_render = true;
716
717         setBackground(0, 0, 255, 255);
718 }
719
720
721
722
723 // define python type
724 PyTypeObject ImageMirrorType =
725
726         PyVarObject_HEAD_INIT(NULL, 0)
727         "VideoTexture.ImageMirror",   /*tp_name*/
728         sizeof(PyImage),          /*tp_basicsize*/
729         0,                         /*tp_itemsize*/
730         (destructor)Image_dealloc, /*tp_dealloc*/
731         0,                         /*tp_print*/
732         0,                         /*tp_getattr*/
733         0,                         /*tp_setattr*/
734         0,                         /*tp_compare*/
735         0,                         /*tp_repr*/
736         0,                         /*tp_as_number*/
737         0,                         /*tp_as_sequence*/
738         0,                         /*tp_as_mapping*/
739         0,                         /*tp_hash */
740         0,                         /*tp_call*/
741         0,                         /*tp_str*/
742         0,                         /*tp_getattro*/
743         0,                         /*tp_setattro*/
744         &imageBufferProcs,         /*tp_as_buffer*/
745         Py_TPFLAGS_DEFAULT,        /*tp_flags*/
746         "Image source from mirror",       /* tp_doc */
747         0,                             /* tp_traverse */
748         0,                             /* tp_clear */
749         0,                             /* tp_richcompare */
750         0,                             /* tp_weaklistoffset */
751         0,                             /* tp_iter */
752         0,                             /* tp_iternext */
753         imageRenderMethods,    /* tp_methods */
754         0,                   /* tp_members */
755         imageMirrorGetSets,          /* tp_getset */
756         0,                         /* tp_base */
757         0,                         /* tp_dict */
758         0,                         /* tp_descr_get */
759         0,                         /* tp_descr_set */
760         0,                         /* tp_dictoffset */
761         (initproc)ImageMirror_init,     /* tp_init */
762         0,                         /* tp_alloc */
763         Image_allocNew,           /* tp_new */
764 };
765
766