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