code cleanup: replace some non utf8 chars
[blender.git] / source / gameengine / Ketsji / KX_Dome.h
1 /*
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 /** \file KX_Dome.h
26  *  \ingroup ketsji
27  */
28
29 #ifndef __KX_DOME_H__
30 #define __KX_DOME_H__
31
32 #include "KX_Scene.h"
33 #include "KX_Camera.h"
34 #include "DNA_screen_types.h"
35 #include "RAS_ICanvas.h"
36 #include "RAS_IRasterizer.h"
37 #include "RAS_IRenderTools.h"
38 #include "KX_KetsjiEngine.h"
39
40 #include "GL/glew.h"
41 #include <vector>
42
43 #include "MEM_guardedalloc.h"
44 #include "BKE_text.h"
45
46 //Dome modes: limit hardcoded in buttons_scene.c
47 #define DOME_FISHEYE                    1
48 #define DOME_TRUNCATED_FRONT    2
49 #define DOME_TRUNCATED_REAR             3
50 #define DOME_ENVMAP                             4
51 #define DOME_PANORAM_SPH                5
52 #define DOME_NUM_MODES                  6
53
54
55 /// class for render 3d scene
56 class KX_Dome
57 {
58 public:
59         /// constructor
60         KX_Dome (RAS_ICanvas* m_canvas,
61                  /// rasterizer
62                  RAS_IRasterizer* m_rasterizer,
63                  /// render tools
64                  RAS_IRenderTools* m_rendertools,
65                  /// engine
66                  KX_KetsjiEngine* m_engine,
67
68                  short res,
69                  short mode,
70                  short angle,
71                  float resbuf,
72                  short tilt,
73                  struct Text* warptext
74                  );
75
76         /// destructor
77         virtual ~KX_Dome (void);
78
79         //openGL checks:
80         bool    dlistSupported;
81         bool    fboSupported;
82
83         //openGL names:
84         GLuint domefacesId[7];      /* ID of the images -- room for 7 images, using only 4 for 180deg x 360deg dome,
85                                      * 6 for panoramic and +1 for warp mesh */
86         GLuint dlistId;             /* ID of the Display Lists of the images (used as an offset) */
87         
88         typedef struct {
89                 double u[3], v[3];
90                 MT_Vector3 verts[3]; //three verts
91         } DomeFace;
92
93         //mesh warp functions
94         typedef struct {
95                 double x, y, u, v, i;
96         } WarpMeshNode;
97
98         struct {
99                 bool usemesh;
100                 int mode;
101                 int n_width, n_height; //nodes width and height
102                 int imagesize;
103                 int bufferwidth, bufferheight;
104                 GLuint fboId;
105                 vector <vector <WarpMeshNode> > nodes;
106         } warp;
107
108         bool ParseWarpMesh(STR_String text);
109
110         vector <DomeFace> cubetop, cubebottom, cuberight, cubeleft, cubefront, cubeback; //for fisheye
111         vector <DomeFace> cubeleftback, cuberightback; //for panorama
112         
113         int nfacestop, nfacesbottom, nfacesleft, nfacesright, nfacesfront, nfacesback;
114         int nfacesleftback, nfacesrightback;
115
116         int GetNumberRenders() { return m_numfaces; }
117
118         void RenderDome(void);
119         void RenderDomeFrame(KX_Scene* scene, KX_Camera* cam, int i);
120         void BindImages(int i);
121
122         void SetViewPort(GLuint viewport[4]);
123         void CalculateFrustum(KX_Camera* cam);
124         void RotateCamera(KX_Camera* cam, int i);
125
126         //Mesh creation Functions
127         void CreateMeshDome180(void);
128         void CreateMeshDome250(void);
129         void CreateMeshPanorama(void);
130
131         void SplitFace(vector <DomeFace>& face, int *nfaces);
132
133         void FlattenDome(MT_Vector3 verts[3]);
134         void FlattenPanorama(MT_Vector3 verts[3]);
135
136         //Draw functions
137         void GLDrawTriangles(vector <DomeFace>& face, int nfaces);
138         void GLDrawWarpQuads(void);
139         void Draw(void);
140         void DrawDomeFisheye(void);
141         void DrawEnvMap(void);
142         void DrawPanorama(void);
143         void DrawDomeWarped(void);
144
145         //setting up openGL
146         void CreateGLImages(void);
147         void ClearGLImages(void);//called on resize
148         bool CreateDL(void); //create Display Lists
149         void ClearDL(void);  //remove Display Lists 
150         bool CreateFBO(void);//create FBO (for warp mesh)
151         void ClearFBO(void); //remove FBO
152
153         void CalculateCameraOrientation();
154         void CalculateImageSize(); //set m_imagesize
155
156         int canvaswidth;
157         int canvasheight;
158
159 protected:
160         int m_drawingmode;
161
162         int m_imagesize;
163         int m_buffersize;       // canvas small dimension
164         int m_numfaces;         // 4 to 6 depending on the kind of dome image
165         int m_numimages;        //numfaces +1 if we have warp mesh
166
167         short m_resolution;     //resolution to tessellate the mesh
168         short m_mode;           // the mode (truncated, warped, panoramic,...)
169         short m_angle;          //the angle of the fisheye
170         float m_radangle;       //the angle of the fisheye in radians
171         float m_resbuffer;      //the resolution of the buffer
172         short m_tilt;           //the dome tilt (camera rotation on horizontal axis)
173         
174         RAS_Rect m_viewport;
175
176         MT_Matrix4x4 m_projmat;
177
178         MT_Matrix3x3 m_locRot[6]; // the rotation matrix
179
180         /// rendered scene
181         KX_Scene * m_scene;
182
183         /// canvas
184         RAS_ICanvas* m_canvas;
185         /// rasterizer
186         RAS_IRasterizer* m_rasterizer;
187         /// render tools
188         RAS_IRenderTools* m_rendertools;
189         /// engine
190         KX_KetsjiEngine* m_engine;
191         
192         
193 #ifdef WITH_CXX_GUARDEDALLOC
194 public:
195         void *operator new(size_t num_bytes) { return MEM_mallocN(num_bytes, "GE:KX_Dome"); }
196         void operator delete( void *mem ) { MEM_freeN(mem); }
197 #endif
198 };
199
200 #endif /* __KX_DOME_H__ */