Code cleanup: simplify subwindow code.
[blender.git] / source / blender / windowmanager / intern / wm_subwindow.c
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (at your option) any later version. 
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with this program; if not, write to the Free Software Foundation,
16  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
17  *
18  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
19  * All rights reserved.
20  *
21  * Contributor(s): 2007 Blender Foundation (refactor)
22  *
23  * ***** END GPL LICENSE BLOCK *****
24  *
25  *
26  * Subwindow opengl handling. 
27  * BTW: subwindows open/close in X11 are way too slow, tried it, and choose for my own system... (ton)
28  * 
29  */
30
31 /** \file blender/windowmanager/intern/wm_subwindow.c
32  *  \ingroup wm
33  *
34  * Internal subwindows used for OpenGL state, used for regions and screens.
35  */
36
37 #include <string.h>
38
39 #include "MEM_guardedalloc.h"
40
41 #include "DNA_windowmanager_types.h"
42 #include "DNA_screen_types.h"
43
44 #include "BLI_blenlib.h"
45 #include "BLI_math.h"
46 #include "BLI_utildefines.h"
47
48 #include "BIF_gl.h"
49
50 #include "GPU_matrix.h"
51
52 #include "WM_api.h"
53 #include "wm_subwindow.h"
54
55 /**
56  * \note #wmSubWindow stored in #wmWindow but not exposed outside this C file,
57  * it seems a bit redundant (area regions can store it too, but we keep it
58  * because we can store all kind of future opengl fanciness here.
59  *
60  * We use indices and array because:
61  * - index has safety, no pointers from this C file hanging around
62  * - fast lookups of indices with array, list would give overhead
63  * - old code used it this way...
64  * - keep option open to have 2 screens using same window
65  */
66
67 typedef struct wmSubWindow {
68         struct wmSubWindow *next, *prev;
69         
70         rcti winrct;
71         int swinid;
72 } wmSubWindow;
73
74
75 /* ******************* open, free, set, get data ******************** */
76
77 /* not subwindow itself */
78 static void wm_subwindow_free(wmSubWindow *UNUSED(swin))
79 {
80         /* future fancy stuff */
81 }
82
83 void wm_subwindows_free(wmWindow *win)
84 {
85         wmSubWindow *swin;
86         
87         for (swin = win->subwindows.first; swin; swin = swin->next)
88                 wm_subwindow_free(swin);
89         
90         BLI_freelistN(&win->subwindows);
91 }
92
93
94 static wmSubWindow *swin_from_swinid(wmWindow *win, int swinid)
95 {
96         wmSubWindow *swin;
97         
98         for (swin = win->subwindows.first; swin; swin = swin->next)
99                 if (swin->swinid == swinid)
100                         break;
101         return swin;
102 }
103
104
105 static void wm_swin_size_get(wmSubWindow *swin, int *x, int *y)
106 {
107         *x = BLI_rcti_size_x(&swin->winrct) + 1;
108         *y = BLI_rcti_size_y(&swin->winrct) + 1;
109 }
110 void wm_subwindow_size_get(wmWindow *win, int swinid, int *x, int *y)
111 {
112         wmSubWindow *swin = swin_from_swinid(win, swinid);
113
114         if (swin) {
115                 wm_swin_size_get(swin, x, y);
116         }
117 }
118
119
120 static void wm_swin_origin_get(wmSubWindow *swin, int *x, int *y)
121 {
122         *x = swin->winrct.xmin;
123         *y = swin->winrct.ymin;
124 }
125 void wm_subwindow_origin_get(wmWindow *win, int swinid, int *x, int *y)
126 {
127         wmSubWindow *swin = swin_from_swinid(win, swinid);
128
129         if (swin) {
130                 wm_swin_origin_get(swin, x, y);
131         }
132 }
133
134
135 static void wm_swin_matrix_get(wmWindow *win, wmSubWindow *swin, float mat[4][4])
136 {
137         const bScreen *screen = WM_window_get_active_screen(win);
138
139         /* used by UI, should find a better way to get the matrix there */
140         if (swin->swinid == screen->mainwin) {
141                 int width, height;
142
143                 wm_swin_size_get(swin, &width, &height);
144                 orthographic_m4(mat, -GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS, -100, 100);
145         }
146         else {
147                 gpuGetProjectionMatrix(mat);
148         }
149 }
150 void wm_subwindow_matrix_get(wmWindow *win, int swinid, float mat[4][4])
151 {
152         wmSubWindow *swin = swin_from_swinid(win, swinid);
153
154         if (swin) {
155                 wm_swin_matrix_get(win, swin, mat);
156         }
157 }
158
159
160 static void wm_swin_rect_get(wmSubWindow *swin, rcti *r_rect)
161 {
162         *r_rect = swin->winrct;
163 }
164 void wm_subwindow_rect_get(wmWindow *win, int swinid, rcti *r_rect)
165 {
166         wmSubWindow *swin = swin_from_swinid(win, swinid);
167
168         if (swin) {
169                 wm_swin_rect_get(swin, r_rect);
170         }
171 }
172
173
174 static void wm_swin_rect_set(wmSubWindow *swin, const rcti *rect)
175 {
176         swin->winrct = *rect;
177 }
178 void wm_subwindow_rect_set(wmWindow *win, int swinid, const rcti *rect)
179 {
180         wmSubWindow *swin = swin_from_swinid(win, swinid);
181
182         if (swin) {
183                 wm_swin_rect_set(swin, rect);
184         }
185 }
186
187
188 /* always sets pixel-precise 2D window/view matrices */
189 /* coords is in whole pixels. xmin = 15, xmax = 16: means window is 2 pix big */
190 int wm_subwindow_open(wmWindow *win, const rcti *winrct, bool activate)
191 {
192         wmSubWindow *swin;
193         int width, height;
194         int freewinid = 1;
195         
196         for (swin = win->subwindows.first; swin; swin = swin->next)
197                 if (freewinid <= swin->swinid)
198                         freewinid = swin->swinid + 1;
199
200         swin = MEM_callocN(sizeof(wmSubWindow), "swinopen");
201         BLI_addtail(&win->subwindows, swin);
202         
203         swin->swinid = freewinid;
204         swin->winrct = *winrct;
205
206         if (activate) {
207                 /* and we appy it all right away */
208                 wmSubWindowSet(win, swin->swinid);
209
210                 /* extra service */
211                 wm_swin_size_get(swin, &width, &height);
212                 wmOrtho2_pixelspace(width, height);
213                 gpuLoadIdentity();
214         }
215
216         return swin->swinid;
217 }
218
219 void wm_subwindow_close(wmWindow *win, int swinid)
220 {
221         wmSubWindow *swin = swin_from_swinid(win, swinid);
222
223         if (swin) {
224                 wm_subwindow_free(swin);
225                 BLI_remlink(&win->subwindows, swin);
226                 MEM_freeN(swin);
227         }
228         else {
229                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
230         }
231 }
232
233 /* pixels go from 0-99 for a 100 pixel window */
234 void wm_subwindow_position(wmWindow *win, int swinid, const rcti *winrct, bool activate)
235 {
236         wmSubWindow *swin = swin_from_swinid(win, swinid);
237         
238         if (swin) {
239                 const int winsize_x = WM_window_pixels_x(win);
240                 const int winsize_y = WM_window_pixels_y(win);
241
242                 int width, height;
243                 
244                 swin->winrct = *winrct;
245                 
246                 /* CRITICAL, this clamping ensures that
247                  * the viewport never goes outside the screen
248                  * edges (assuming the x, y coords aren't
249                  *        outside). This caused a hardware lock
250                  * on Matrox cards if it happens.
251                  *
252                  * Really Blender should never _ever_ try
253                  * to do such a thing, but just to be safe
254                  * clamp it anyway (or fix the bScreen
255                  * scaling routine, and be damn sure you
256                  * fixed it). - zr  (2001!)
257                  */
258                 
259                 if (swin->winrct.xmax > winsize_x)
260                         swin->winrct.xmax = winsize_x;
261                 if (swin->winrct.ymax > winsize_y)
262                         swin->winrct.ymax = winsize_y;
263                 
264                 if (activate) {
265                         /* extra service */
266                         wmSubWindowSet(win, swinid);
267                         wm_swin_size_get(swin, &width, &height);
268                         wmOrtho2_pixelspace(width, height);
269                 }
270         }
271         else {
272                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
273         }
274 }
275
276 /* ---------------- WM versions of OpenGL style API calls ------------------------ */
277 /* ----------------- exported in WM_api.h ------------------------------------------------------ */
278
279 void wmSubWindowScissorSet(wmWindow *win, int swinid, const rcti *srct, bool srct_pad)
280 {
281         int width, height;
282         wmSubWindow *swin = swin_from_swinid(win, swinid);
283         
284         if (swin == NULL) {
285                 printf("%s %d: doesn't exist\n", __func__, swinid);
286                 return;
287         }
288         
289         width  = BLI_rcti_size_x(&swin->winrct) + 1;
290         height = BLI_rcti_size_y(&swin->winrct) + 1;
291         glViewport(swin->winrct.xmin, swin->winrct.ymin, width, height);
292         
293         if (srct) {
294                 int scissor_width  = BLI_rcti_size_x(srct);
295                 int scissor_height = BLI_rcti_size_y(srct);
296
297                 /* typically a single pixel doesn't matter,
298                  * but one pixel offset is noticeable with viewport border render */
299                 if (srct_pad) {
300                         scissor_width  += 1;
301                         scissor_height += 1;
302                 }
303
304                 glScissor(srct->xmin, srct->ymin, scissor_width, scissor_height);
305         }
306         else
307                 glScissor(swin->winrct.xmin, swin->winrct.ymin, width, height);
308         
309         wmOrtho2_pixelspace(width, height);
310         gpuLoadIdentity();
311 }
312
313 /* enable the WM versions of opengl calls */
314 void wmSubWindowSet(wmWindow *win, int swinid)
315 {
316         wmSubWindowScissorSet(win, swinid, NULL, true);
317 }
318
319 void wmOrtho2(float x1, float x2, float y1, float y2)
320 {
321         /* prevent opengl from generating errors */
322         if (x1 == x2) x2 += 1.0f;
323         if (y1 == y2) y2 += 1.0f;
324
325         gpuOrtho(x1, x2, y1, y2, -100, 100);
326 }
327
328 static void wmOrtho2_offset(const float x, const float y, const float ofs)
329 {
330         wmOrtho2(ofs, x + ofs, ofs, y + ofs);
331 }
332
333 /**
334  * default pixel alignment.
335  */
336 void wmOrtho2_region_pixelspace(const ARegion *ar)
337 {
338         wmOrtho2_offset(ar->winx, ar->winy, -0.01f);
339 }
340
341 void wmOrtho2_pixelspace(const float x, const float y)
342 {
343         wmOrtho2_offset(x, y, -GLA_PIXEL_OFS);
344 }
345
346 /* ********** END MY WINDOW ************** */
347