1a8f71891c01a86d36d59847e8a8c46799981472
[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 int wm_subwindow_get_id(wmWindow *win)
95 {
96         if (win->curswin)
97                 return win->curswin->swinid;
98         return 0;
99 }
100
101 static wmSubWindow *swin_from_swinid(wmWindow *win, int swinid)
102 {
103         wmSubWindow *swin;
104         
105         for (swin = win->subwindows.first; swin; swin = swin->next)
106                 if (swin->swinid == swinid)
107                         break;
108         return swin;
109 }
110
111
112 static void wm_swin_size_get(wmSubWindow *swin, int *x, int *y)
113 {
114         *x = BLI_rcti_size_x(&swin->winrct) + 1;
115         *y = BLI_rcti_size_y(&swin->winrct) + 1;
116 }
117 void wm_subwindow_size_get(wmWindow *win, int swinid, int *x, int *y)
118 {
119         wmSubWindow *swin = swin_from_swinid(win, swinid);
120
121         if (swin) {
122                 wm_swin_size_get(swin, x, y);
123         }
124 }
125
126
127 static void wm_swin_origin_get(wmSubWindow *swin, int *x, int *y)
128 {
129         *x = swin->winrct.xmin;
130         *y = swin->winrct.ymin;
131 }
132 void wm_subwindow_origin_get(wmWindow *win, int swinid, int *x, int *y)
133 {
134         wmSubWindow *swin = swin_from_swinid(win, swinid);
135
136         if (swin) {
137                 wm_swin_origin_get(swin, x, y);
138         }
139 }
140
141
142 static void wm_swin_matrix_get(wmWindow *win, wmSubWindow *swin, float mat[4][4])
143 {
144         const bScreen *screen = WM_window_get_active_screen(win);
145
146         /* used by UI, should find a better way to get the matrix there */
147         if (swin->swinid == screen->mainwin) {
148                 int width, height;
149
150                 wm_swin_size_get(swin, &width, &height);
151                 orthographic_m4(mat, -GLA_PIXEL_OFS, (float)width - GLA_PIXEL_OFS, -GLA_PIXEL_OFS, (float)height - GLA_PIXEL_OFS, -100, 100);
152         }
153         else {
154                 gpuGetProjectionMatrix(mat);
155         }
156 }
157 void wm_subwindow_matrix_get(wmWindow *win, int swinid, float mat[4][4])
158 {
159         wmSubWindow *swin = swin_from_swinid(win, swinid);
160
161         if (swin) {
162                 wm_swin_matrix_get(win, swin, mat);
163         }
164 }
165
166
167 static void wm_swin_rect_get(wmSubWindow *swin, rcti *r_rect)
168 {
169         *r_rect = swin->winrct;
170 }
171 void wm_subwindow_rect_get(wmWindow *win, int swinid, rcti *r_rect)
172 {
173         wmSubWindow *swin = swin_from_swinid(win, swinid);
174
175         if (swin) {
176                 wm_swin_rect_get(swin, r_rect);
177         }
178 }
179
180
181 static void wm_swin_rect_set(wmSubWindow *swin, const rcti *rect)
182 {
183         swin->winrct = *rect;
184 }
185 void wm_subwindow_rect_set(wmWindow *win, int swinid, const rcti *rect)
186 {
187         wmSubWindow *swin = swin_from_swinid(win, swinid);
188
189         if (swin) {
190                 wm_swin_rect_set(swin, rect);
191         }
192 }
193
194
195 /* always sets pixel-precise 2D window/view matrices */
196 /* coords is in whole pixels. xmin = 15, xmax = 16: means window is 2 pix big */
197 int wm_subwindow_open(wmWindow *win, const rcti *winrct, bool activate)
198 {
199         wmSubWindow *swin;
200         int width, height;
201         int freewinid = 1;
202         
203         for (swin = win->subwindows.first; swin; swin = swin->next)
204                 if (freewinid <= swin->swinid)
205                         freewinid = swin->swinid + 1;
206
207         win->curswin = swin = MEM_callocN(sizeof(wmSubWindow), "swinopen");
208         BLI_addtail(&win->subwindows, swin);
209         
210         swin->swinid = freewinid;
211         swin->winrct = *winrct;
212
213         if (activate) {
214                 /* and we appy it all right away */
215                 wmSubWindowSet(win, swin->swinid);
216
217                 /* extra service */
218                 wm_swin_size_get(swin, &width, &height);
219                 wmOrtho2_pixelspace(width, height);
220                 gpuLoadIdentity();
221         }
222
223         return swin->swinid;
224 }
225
226 void wm_subwindow_close(wmWindow *win, int swinid)
227 {
228         wmSubWindow *swin = swin_from_swinid(win, swinid);
229
230         if (swin) {
231                 if (swin == win->curswin)
232                         win->curswin = NULL;
233                 wm_subwindow_free(swin);
234                 BLI_remlink(&win->subwindows, swin);
235                 MEM_freeN(swin);
236         }
237         else {
238                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
239         }
240 }
241
242 /* pixels go from 0-99 for a 100 pixel window */
243 void wm_subwindow_position(wmWindow *win, int swinid, const rcti *winrct, bool activate)
244 {
245         wmSubWindow *swin = swin_from_swinid(win, swinid);
246         
247         if (swin) {
248                 const int winsize_x = WM_window_pixels_x(win);
249                 const int winsize_y = WM_window_pixels_y(win);
250
251                 int width, height;
252                 
253                 swin->winrct = *winrct;
254                 
255                 /* CRITICAL, this clamping ensures that
256                  * the viewport never goes outside the screen
257                  * edges (assuming the x, y coords aren't
258                  *        outside). This caused a hardware lock
259                  * on Matrox cards if it happens.
260                  *
261                  * Really Blender should never _ever_ try
262                  * to do such a thing, but just to be safe
263                  * clamp it anyway (or fix the bScreen
264                  * scaling routine, and be damn sure you
265                  * fixed it). - zr  (2001!)
266                  */
267                 
268                 if (swin->winrct.xmax > winsize_x)
269                         swin->winrct.xmax = winsize_x;
270                 if (swin->winrct.ymax > winsize_y)
271                         swin->winrct.ymax = winsize_y;
272                 
273                 if (activate) {
274                         /* extra service */
275                         wmSubWindowSet(win, swinid);
276                         wm_swin_size_get(swin, &width, &height);
277                         wmOrtho2_pixelspace(width, height);
278                 }
279         }
280         else {
281                 printf("%s: Internal error, bad winid: %d\n", __func__, swinid);
282         }
283 }
284
285 /* ---------------- WM versions of OpenGL style API calls ------------------------ */
286 /* ----------------- exported in WM_api.h ------------------------------------------------------ */
287
288 /* internal state, no threaded opengl! XXX */
289 static wmWindow *_curwindow = NULL;
290 static wmSubWindow *_curswin = NULL;
291
292 void wmSubWindowScissorSet(wmWindow *win, int swinid, const rcti *srct, bool srct_pad)
293 {
294         int width, height;
295         _curswin = swin_from_swinid(win, swinid);
296         
297         if (_curswin == NULL) {
298                 printf("%s %d: doesn't exist\n", __func__, swinid);
299                 return;
300         }
301         
302         win->curswin = _curswin;
303         _curwindow = win;
304         
305         width  = BLI_rcti_size_x(&_curswin->winrct) + 1;
306         height = BLI_rcti_size_y(&_curswin->winrct) + 1;
307         glViewport(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
308         
309         if (srct) {
310                 int scissor_width  = BLI_rcti_size_x(srct);
311                 int scissor_height = BLI_rcti_size_y(srct);
312
313                 /* typically a single pixel doesn't matter,
314                  * but one pixel offset is noticeable with viewport border render */
315                 if (srct_pad) {
316                         scissor_width  += 1;
317                         scissor_height += 1;
318                 }
319
320                 glScissor(srct->xmin, srct->ymin, scissor_width, scissor_height);
321         }
322         else
323                 glScissor(_curswin->winrct.xmin, _curswin->winrct.ymin, width, height);
324         
325         wmOrtho2_pixelspace(width, height);
326         gpuLoadIdentity();
327         
328         glFlush();
329 }
330
331 /* enable the WM versions of opengl calls */
332 void wmSubWindowSet(wmWindow *win, int swinid)
333 {
334         wmSubWindowScissorSet(win, swinid, NULL, true);
335 }
336
337 void wmOrtho2(float x1, float x2, float y1, float y2)
338 {
339         /* prevent opengl from generating errors */
340         if (x1 == x2) x2 += 1.0f;
341         if (y1 == y2) y2 += 1.0f;
342
343         gpuOrtho(x1, x2, y1, y2, -100, 100);
344 }
345
346 static void wmOrtho2_offset(const float x, const float y, const float ofs)
347 {
348         wmOrtho2(ofs, x + ofs, ofs, y + ofs);
349 }
350
351 /**
352  * default pixel alignment.
353  */
354 void wmOrtho2_region_pixelspace(const ARegion *ar)
355 {
356         wmOrtho2_offset(ar->winx, ar->winy, -0.01f);
357 }
358
359 void wmOrtho2_pixelspace(const float x, const float y)
360 {
361         wmOrtho2_offset(x, y, -GLA_PIXEL_OFS);
362 }
363
364 /* ********** END MY WINDOW ************** */
365