Merge with 2.5 -r 21788:22040.
[blender.git] / source / gameengine / Ketsji / KX_Dome.h
1 /* $Id$
2 -----------------------------------------------------------------------------
3
4 This program is free software; you can redistribute it and/or modify it under
5 the terms of the GNU Lesser General Public License as published by the Free Software
6 Foundation; either version 2 of the License, or (at your option) any later
7 version.
8
9 This program is distributed in the hope that it will be useful, but WITHOUT
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11 FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
12
13 You should have received a copy of the GNU Lesser General Public License along with
14 this program; if not, write to the Free Software Foundation, Inc., 59 Temple
15 Place - Suite 330, Boston, MA 02111-1307, USA, or go to
16 http://www.gnu.org/copyleft/lesser.txt.
17
18 Contributor(s): Dalai Felinto
19
20 This source uses some of the ideas and code from Paul Bourke.
21 Developed as part of a Research and Development project for SAT - La Société des arts technologiques.
22 -----------------------------------------------------------------------------
23 */
24
25 #if !defined KX_DOME_H
26 #define KX_DOME_H
27
28 #include "KX_Scene.h"
29 #include "KX_Camera.h"
30 #include "DNA_screen_types.h"
31 #include "RAS_ICanvas.h"
32 #include "RAS_IRasterizer.h"
33 #include "RAS_IRenderTools.h"
34 #include "KX_KetsjiEngine.h"
35
36 #include "GL/glew.h"
37 #include <vector>
38
39 #include "MEM_guardedalloc.h"
40 #include "BKE_text.h"
41
42 //Dome modes: limit hardcoded in buttons_scene.c
43 #define DOME_FISHEYE                    1
44 #define DOME_TRUNCATED_FRONT    2
45 #define DOME_TRUNCATED_REAR             3
46 #define DOME_ENVMAP                             4
47 #define DOME_PANORAM_SPH                5
48 #define DOME_NUM_MODES                  6
49
50
51 /// class for render 3d scene
52 class KX_Dome
53 {
54 public:
55         /// constructor
56         KX_Dome (
57         RAS_ICanvas* m_canvas,
58     /// rasterizer
59     RAS_IRasterizer* m_rasterizer,
60     /// render tools
61     RAS_IRenderTools* m_rendertools,
62     /// engine
63     KX_KetsjiEngine* m_engine,
64
65         short res,
66         short mode,
67         short angle,
68         float resbuf,
69         short tilt,
70         struct Text* warptext
71         );
72
73         /// destructor
74         virtual ~KX_Dome (void);
75
76         //openGL checks:
77         bool    dlistSupported;
78         bool    fboSupported;
79
80         //openGL names:
81         GLuint domefacesId[7];          // ID of the images -- room for 7 images, using only 4 for 180º x 360º dome, 6 for panoramic and +1 for warp mesh
82         GLuint dlistId;                         // ID of the Display Lists of the images (used as an offset)
83         
84         typedef struct {
85                 double u[3], v[3];
86                 MT_Vector3 verts[3]; //three verts
87         } DomeFace;
88
89         //mesh warp functions
90         typedef struct {
91                 double x, y, u, v, i;
92         } WarpMeshNode;
93
94         struct {
95                 bool usemesh;
96                 int mode;
97                 int n_width, n_height; //nodes width and height
98                 int imagesize;
99                 int bufferwidth, bufferheight;
100                 GLuint fboId;
101                 vector <vector <WarpMeshNode> > nodes;
102         } warp;
103
104         bool ParseWarpMesh(STR_String text);
105
106         vector <DomeFace> cubetop, cubebottom, cuberight, cubeleft, cubefront, cubeback; //for fisheye
107         vector <DomeFace> cubeleftback, cuberightback; //for panorama
108         
109         int nfacestop, nfacesbottom, nfacesleft, nfacesright, nfacesfront, nfacesback;
110         int nfacesleftback, nfacesrightback;
111
112         int GetNumberRenders(){return m_numfaces;};
113
114         void RenderDome(void);
115         void RenderDomeFrame(KX_Scene* scene, KX_Camera* cam, int i);
116         void BindImages(int i);
117
118         void SetViewPort(GLuint viewport[4]);
119         void CalculateFrustum(KX_Camera* cam);
120         void RotateCamera(KX_Camera* cam, int i);
121
122         //Mesh creation Functions
123         void CreateMeshDome180(void);
124         void CreateMeshDome250(void);
125         void CreateMeshPanorama(void);
126
127         void SplitFace(vector <DomeFace>& face, int *nfaces);
128
129         void FlattenDome(MT_Vector3 verts[3]);
130         void FlattenPanorama(MT_Vector3 verts[3]);
131
132         //Draw functions
133         void GLDrawTriangles(vector <DomeFace>& face, int nfaces);
134         void GLDrawWarpQuads(void);
135         void Draw(void);
136         void DrawDomeFisheye(void);
137         void DrawEnvMap(void);
138         void DrawPanorama(void);
139         void DrawDomeWarped(void);
140
141         //setting up openGL
142         void CreateGLImages(void);
143         void ClearGLImages(void);//called on resize
144         bool CreateDL(void); //create Display Lists
145         void ClearDL(void);  //remove Display Lists 
146         bool CreateFBO(void);//create FBO (for warp mesh)
147         void ClearFBO(void); //remove FBO
148
149         void CalculateCameraOrientation();
150         void CalculateImageSize(); //set m_imagesize
151
152         int canvaswidth;
153         int canvasheight;
154
155 protected:
156         int m_drawingmode;
157
158         int m_imagesize;
159         int m_buffersize;       // canvas small dimension
160         int m_numfaces;         // 4 to 6 depending on the kind of dome image
161         int m_numimages;        //numfaces +1 if we have warp mesh
162
163         short m_resolution;     //resolution to tesselate the mesh
164         short m_mode;           // the mode (truncated, warped, panoramic,...)
165         short m_angle;          //the angle of the fisheye
166         float m_radangle;       //the angle of the fisheye in radians
167         float m_resbuffer;      //the resolution of the buffer
168         short m_tilt;           //the dome tilt (camera rotation on horizontal axis)
169         
170         RAS_Rect m_viewport;
171
172         MT_Matrix4x4 m_projmat;
173
174         MT_Matrix3x3 m_locRot [6];// the rotation matrix
175
176         /// rendered scene
177         KX_Scene * m_scene;
178
179     /// canvas
180     RAS_ICanvas* m_canvas;
181     /// rasterizer
182     RAS_IRasterizer* m_rasterizer;
183     /// render tools
184     RAS_IRenderTools* m_rendertools;
185     /// engine
186     KX_KetsjiEngine* m_engine;
187 };
188
189 #endif
190