code cleanup: pass mouse position as int[2] rather then wmEvent
[blender.git] / source / blender / editors / space_image / image_edit.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) 2008 Blender Foundation.
19  * All rights reserved.
20  *
21  *
22  * Contributor(s): Blender Foundation
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file blender/editors/space_image/image_editor.c
28  *  \ingroup spimage
29  */
30
31 #include "DNA_mask_types.h"
32 #include "DNA_object_types.h"
33 #include "DNA_scene_types.h"
34
35 #include "BLI_math.h"
36
37 #include "BKE_context.h"
38 #include "BKE_global.h"
39 #include "BKE_image.h"
40 #include "BKE_main.h"
41 #include "BKE_tessmesh.h"
42
43 #include "IMB_imbuf_types.h"
44
45 #include "ED_image.h"  /* own include */
46 #include "ED_mesh.h"
47 #include "ED_screen.h"
48 #include "ED_uvedit.h"
49
50 #include "UI_view2d.h"
51
52 #include "WM_api.h"
53 #include "WM_types.h"
54
55 /* note; image_panel_properties() uses pointer to sima->image directly */
56 Image *ED_space_image(SpaceImage *sima)
57 {
58         return sima->image;
59 }
60
61 /* called to assign images to UV faces */
62 void ED_space_image_set(SpaceImage *sima, Scene *scene, Object *obedit, Image *ima)
63 {
64         /* context may be NULL, so use global */
65         ED_uvedit_assign_image(G.main, scene, obedit, ima, sima->image);
66
67         /* change the space ima after because uvedit_face_visible_test uses the space ima
68          * to check if the face is displayed in UV-localview */
69         sima->image = ima;
70
71         if (ima == NULL || ima->type == IMA_TYPE_R_RESULT || ima->type == IMA_TYPE_COMPOSITE) {
72                 if (sima->mode == SI_MODE_PAINT) {
73                         sima->mode = SI_MODE_VIEW;
74                 }
75         }
76
77         if (sima->image)
78                 BKE_image_signal(sima->image, &sima->iuser, IMA_SIGNAL_USER_NEW_IMAGE);
79
80         if (sima->image && sima->image->id.us == 0)
81                 sima->image->id.us = 1;
82
83         if (obedit)
84                 WM_main_add_notifier(NC_GEOM | ND_DATA, obedit->data);
85
86         WM_main_add_notifier(NC_SPACE | ND_SPACE_IMAGE, NULL);
87 }
88
89 Mask *ED_space_image_get_mask(SpaceImage *sima)
90 {
91         return sima->mask_info.mask;
92 }
93
94 void ED_space_image_set_mask(bContext *C, SpaceImage *sima, Mask *mask)
95 {
96         sima->mask_info.mask = mask;
97
98         if (C) {
99                 WM_event_add_notifier(C, NC_MASK | NA_SELECTED, mask);
100         }
101 }
102
103 ImBuf *ED_space_image_acquire_buffer(SpaceImage *sima, void **lock_r)
104 {
105         ImBuf *ibuf;
106
107         if (sima && sima->image) {
108 #if 0
109                 if (sima->image->type == IMA_TYPE_R_RESULT && BIF_show_render_spare())
110                         return BIF_render_spare_imbuf();
111                 else
112 #endif
113                 ibuf = BKE_image_acquire_ibuf(sima->image, &sima->iuser, lock_r);
114
115                 if (ibuf && (ibuf->rect || ibuf->rect_float))
116                         return ibuf;
117         }
118
119         return NULL;
120 }
121
122 void ED_space_image_release_buffer(SpaceImage *sima, void *lock)
123 {
124         if (sima && sima->image)
125                 BKE_image_release_ibuf(sima->image, lock);
126 }
127
128 int ED_space_image_has_buffer(SpaceImage *sima)
129 {
130         ImBuf *ibuf;
131         void *lock;
132         int has_buffer;
133
134         ibuf = ED_space_image_acquire_buffer(sima, &lock);
135         has_buffer = (ibuf != NULL);
136         ED_space_image_release_buffer(sima, lock);
137
138         return has_buffer;
139 }
140
141 void ED_image_get_size(Image *ima, int *width, int *height)
142 {
143         ImBuf *ibuf = NULL;
144         void *lock;
145
146         if (ima)
147                 ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
148
149         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
150                 *width = ibuf->x;
151                 *height = ibuf->y;
152         }
153         else {
154                 *width  = IMG_SIZE_FALLBACK;
155                 *height = IMG_SIZE_FALLBACK;
156         }
157
158         if (ima)
159                 BKE_image_release_ibuf(ima, lock);
160 }
161
162 void ED_space_image_get_size(SpaceImage *sima, int *width, int *height)
163 {
164         Scene *scene = sima->iuser.scene;
165         ImBuf *ibuf;
166         void *lock;
167
168         ibuf = ED_space_image_acquire_buffer(sima, &lock);
169
170         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
171                 *width = ibuf->x;
172                 *height = ibuf->y;
173         }
174         else if (sima->image && sima->image->type == IMA_TYPE_R_RESULT && scene) {
175                 /* not very important, just nice */
176                 *width = (scene->r.xsch * scene->r.size) / 100;
177                 *height = (scene->r.ysch * scene->r.size) / 100;
178
179                 if ((scene->r.mode & R_BORDER) && (scene->r.mode & R_CROP)) {
180                         *width *= (scene->r.border.xmax - scene->r.border.xmin);
181                         *height *= (scene->r.border.ymax - scene->r.border.ymin);
182                 }
183
184         }
185         /* I know a bit weak... but preview uses not actual image size */
186         // XXX else if (image_preview_active(sima, width, height));
187         else {
188                 *width  = IMG_SIZE_FALLBACK;
189                 *height = IMG_SIZE_FALLBACK;
190         }
191
192         ED_space_image_release_buffer(sima, lock);
193 }
194
195 void ED_space_image_get_size_fl(SpaceImage *sima, float size[2])
196 {
197         int size_i[2];
198         ED_space_image_get_size(sima, &size_i[0], &size_i[1]);
199         size[0] = size_i[0];
200         size[1] = size_i[1];
201 }
202
203 void ED_image_get_aspect(Image *ima, float *aspx, float *aspy)
204 {
205         *aspx = *aspy = 1.0;
206
207         if ((ima == NULL) || (ima->type == IMA_TYPE_R_RESULT) || (ima->type == IMA_TYPE_COMPOSITE) ||
208             (ima->aspx == 0.0f || ima->aspy == 0.0f))
209         {
210                 return;
211         }
212
213         /* x is always 1 */
214         *aspy = ima->aspy / ima->aspx;
215 }
216
217 void ED_space_image_get_aspect(SpaceImage *sima, float *aspx, float *aspy)
218 {
219         ED_image_get_aspect(ED_space_image(sima), aspx, aspy);
220 }
221
222 void ED_space_image_get_zoom(SpaceImage *sima, ARegion *ar, float *zoomx, float *zoomy)
223 {
224         int width, height;
225
226         ED_space_image_get_size(sima, &width, &height);
227
228         *zoomx = (float)(ar->winrct.xmax - ar->winrct.xmin + 1) / (float)((ar->v2d.cur.xmax - ar->v2d.cur.xmin) * width);
229         *zoomy = (float)(ar->winrct.ymax - ar->winrct.ymin + 1) / (float)((ar->v2d.cur.ymax - ar->v2d.cur.ymin) * height);
230 }
231
232 void ED_space_image_get_uv_aspect(SpaceImage *sima, float *aspx, float *aspy)
233 {
234         int w, h;
235
236         ED_space_image_get_aspect(sima, aspx, aspy);
237         ED_space_image_get_size(sima, &w, &h);
238
239         *aspx *= (float)w;
240         *aspy *= (float)h;
241
242         if (*aspx < *aspy) {
243                 *aspy = *aspy / *aspx;
244                 *aspx = 1.0f;
245         }
246         else {
247                 *aspx = *aspx / *aspy;
248                 *aspy = 1.0f;
249         }
250 }
251
252 void ED_image_get_uv_aspect(Image *ima, float *aspx, float *aspy)
253 {
254         int w, h;
255
256         ED_image_get_aspect(ima, aspx, aspy);
257         ED_image_get_size(ima, &w, &h);
258
259         *aspx *= (float)w;
260         *aspy *= (float)h;
261 }
262
263 /* takes event->mval */
264 void ED_image_mouse_pos(SpaceImage *sima, ARegion *ar, const int mval[2], float co[2])
265 {
266         int sx, sy, width, height;
267         float zoomx, zoomy;
268
269         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
270         ED_space_image_get_size(sima, &width, &height);
271
272         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
273
274         co[0] = ((mval[0] - sx) / zoomx) / width;
275         co[1] = ((mval[1] - sy) / zoomy) / height;
276 }
277
278 void ED_image_point_pos(SpaceImage *sima, ARegion *ar, float x, float y, float *xr, float *yr)
279 {
280         int sx, sy, width, height;
281         float zoomx, zoomy;
282
283         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
284         ED_space_image_get_size(sima, &width, &height);
285
286         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
287
288         *xr = ((x - sx) / zoomx) / width;
289         *yr = ((y - sy) / zoomy) / height;
290 }
291
292 void ED_image_point_pos__reverse(SpaceImage *sima, ARegion *ar, const float co[2], float r_co[2])
293 {
294         float zoomx, zoomy;
295         int width, height;
296         int sx, sy;
297
298         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
299         ED_space_image_get_size(sima, &width, &height);
300         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
301
302         r_co[0] = (co[0] * width  * zoomx) + (float)sx;
303         r_co[1] = (co[1] * height * zoomy) + (float)sy;
304 }
305
306 int ED_space_image_show_render(SpaceImage *sima)
307 {
308         return (sima->image && ELEM(sima->image->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE));
309 }
310
311 int ED_space_image_show_paint(SpaceImage *sima)
312 {
313         if (ED_space_image_show_render(sima))
314                 return 0;
315
316         return (sima->mode == SI_MODE_PAINT);
317 }
318
319 int ED_space_image_show_uvedit(SpaceImage *sima, Object *obedit)
320 {
321         if (sima && (ED_space_image_show_render(sima) || ED_space_image_show_paint(sima)))
322                 return 0;
323
324         if (obedit && obedit->type == OB_MESH) {
325                 struct BMEditMesh *em = BMEdit_FromObject(obedit);
326                 int ret;
327
328                 ret = EDBM_mtexpoly_check(em);
329
330                 return ret;
331         }
332
333         return 0;
334 }
335
336 int ED_space_image_show_uvshadow(SpaceImage *sima, Object *obedit)
337 {
338         if (ED_space_image_show_render(sima))
339                 return 0;
340
341         if (ED_space_image_show_paint(sima))
342                 if (obedit && obedit->type == OB_MESH) {
343                         struct BMEditMesh *em = BMEdit_FromObject(obedit);
344                         int ret;
345
346                         ret = EDBM_mtexpoly_check(em);
347
348                         return ret;
349                 }
350
351         return 0;
352 }
353
354 /* matches clip function */
355 int ED_space_image_check_show_maskedit(SpaceImage *sima)
356 {
357         return (sima->mode == SI_MODE_MASK);
358 }
359
360 int ED_space_image_maskedit_poll(bContext *C)
361 {
362         SpaceImage *sima = CTX_wm_space_image(C);
363
364         if (sima && sima->image) {
365                 return ED_space_image_check_show_maskedit(sima);
366         }
367
368         return FALSE;
369 }
370
371 int ED_space_image_maskedit_mask_poll(bContext *C)
372 {
373         if (ED_space_image_maskedit_poll(C)) {
374                 Image *ima = CTX_data_edit_image(C);
375
376                 if (ima) {
377                         SpaceImage *sima = CTX_wm_space_image(C);
378
379                         return sima->mask_info.mask != NULL;
380                 }
381         }
382
383         return FALSE;
384 }
385
386 /******************** TODO ********************/
387
388 /* XXX notifier? */
389
390 /* goes over all ImageUsers, and sets frame numbers if auto-refresh is set */
391
392 static void image_update_frame(struct Image *UNUSED(ima), struct ImageUser *iuser, void *customdata)
393 {
394         int cfra = *(int *)customdata;
395
396         BKE_image_user_check_frame_calc(iuser, cfra, 0);
397 }
398
399 void ED_image_update_frame(const Main *mainp, int cfra)
400 {
401         BKE_image_walk_all_users(mainp, &cfra, image_update_frame);
402 }