changes to mask editing
[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         /* weak, but same as image/space */
99         if (sima->mask_info.mask && sima->mask_info.mask->id.us == 0)
100                 sima->mask_info.mask->id.us = 1;
101
102         if (C) {
103                 WM_event_add_notifier(C, NC_MASK | NA_SELECTED, mask);
104         }
105 }
106
107 ImBuf *ED_space_image_acquire_buffer(SpaceImage *sima, void **lock_r)
108 {
109         ImBuf *ibuf;
110
111         if (sima && sima->image) {
112 #if 0
113                 if (sima->image->type == IMA_TYPE_R_RESULT && BIF_show_render_spare())
114                         return BIF_render_spare_imbuf();
115                 else
116 #endif
117                 ibuf = BKE_image_acquire_ibuf(sima->image, &sima->iuser, lock_r);
118
119                 if (ibuf && (ibuf->rect || ibuf->rect_float))
120                         return ibuf;
121         }
122
123         return NULL;
124 }
125
126 void ED_space_image_release_buffer(SpaceImage *sima, void *lock)
127 {
128         if (sima && sima->image)
129                 BKE_image_release_ibuf(sima->image, lock);
130 }
131
132 int ED_space_image_has_buffer(SpaceImage *sima)
133 {
134         ImBuf *ibuf;
135         void *lock;
136         int has_buffer;
137
138         ibuf = ED_space_image_acquire_buffer(sima, &lock);
139         has_buffer = (ibuf != NULL);
140         ED_space_image_release_buffer(sima, lock);
141
142         return has_buffer;
143 }
144
145 void ED_image_get_size(Image *ima, int *width, int *height)
146 {
147         ImBuf *ibuf = NULL;
148         void *lock;
149
150         if (ima)
151                 ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
152
153         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
154                 *width = ibuf->x;
155                 *height = ibuf->y;
156         }
157         else {
158                 *width  = IMG_SIZE_FALLBACK;
159                 *height = IMG_SIZE_FALLBACK;
160         }
161
162         if (ima)
163                 BKE_image_release_ibuf(ima, lock);
164 }
165
166 void ED_space_image_get_size(SpaceImage *sima, int *width, int *height)
167 {
168         Scene *scene = sima->iuser.scene;
169         ImBuf *ibuf;
170         void *lock;
171
172         ibuf = ED_space_image_acquire_buffer(sima, &lock);
173
174         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
175                 *width = ibuf->x;
176                 *height = ibuf->y;
177         }
178         else if (sima->image && sima->image->type == IMA_TYPE_R_RESULT && scene) {
179                 /* not very important, just nice */
180                 *width = (scene->r.xsch * scene->r.size) / 100;
181                 *height = (scene->r.ysch * scene->r.size) / 100;
182
183                 if ((scene->r.mode & R_BORDER) && (scene->r.mode & R_CROP)) {
184                         *width *= (scene->r.border.xmax - scene->r.border.xmin);
185                         *height *= (scene->r.border.ymax - scene->r.border.ymin);
186                 }
187
188         }
189         /* I know a bit weak... but preview uses not actual image size */
190         // XXX else if (image_preview_active(sima, width, height));
191         else {
192                 *width  = IMG_SIZE_FALLBACK;
193                 *height = IMG_SIZE_FALLBACK;
194         }
195
196         ED_space_image_release_buffer(sima, lock);
197 }
198
199 void ED_space_image_get_size_fl(SpaceImage *sima, float size[2])
200 {
201         int size_i[2];
202         ED_space_image_get_size(sima, &size_i[0], &size_i[1]);
203         size[0] = size_i[0];
204         size[1] = size_i[1];
205 }
206
207 void ED_image_get_aspect(Image *ima, float *aspx, float *aspy)
208 {
209         *aspx = *aspy = 1.0;
210
211         if ((ima == NULL) || (ima->type == IMA_TYPE_R_RESULT) || (ima->type == IMA_TYPE_COMPOSITE) ||
212             (ima->aspx == 0.0f || ima->aspy == 0.0f))
213         {
214                 return;
215         }
216
217         /* x is always 1 */
218         *aspy = ima->aspy / ima->aspx;
219 }
220
221 void ED_space_image_get_aspect(SpaceImage *sima, float *aspx, float *aspy)
222 {
223         ED_image_get_aspect(ED_space_image(sima), aspx, aspy);
224 }
225
226 void ED_space_image_get_zoom(SpaceImage *sima, ARegion *ar, float *zoomx, float *zoomy)
227 {
228         int width, height;
229
230         ED_space_image_get_size(sima, &width, &height);
231
232         *zoomx = (float)(ar->winrct.xmax - ar->winrct.xmin + 1) / (float)((ar->v2d.cur.xmax - ar->v2d.cur.xmin) * width);
233         *zoomy = (float)(ar->winrct.ymax - ar->winrct.ymin + 1) / (float)((ar->v2d.cur.ymax - ar->v2d.cur.ymin) * height);
234 }
235
236 void ED_space_image_get_uv_aspect(SpaceImage *sima, float *aspx, float *aspy)
237 {
238         int w, h;
239
240         ED_space_image_get_aspect(sima, aspx, aspy);
241         ED_space_image_get_size(sima, &w, &h);
242
243         *aspx *= (float)w;
244         *aspy *= (float)h;
245
246         if (*aspx < *aspy) {
247                 *aspy = *aspy / *aspx;
248                 *aspx = 1.0f;
249         }
250         else {
251                 *aspx = *aspx / *aspy;
252                 *aspy = 1.0f;
253         }
254 }
255
256 void ED_image_get_uv_aspect(Image *ima, float *aspx, float *aspy)
257 {
258         int w, h;
259
260         ED_image_get_aspect(ima, aspx, aspy);
261         ED_image_get_size(ima, &w, &h);
262
263         *aspx *= (float)w;
264         *aspy *= (float)h;
265 }
266
267 /* takes event->mval */
268 void ED_image_mouse_pos(SpaceImage *sima, ARegion *ar, const int mval[2], float co[2])
269 {
270         int sx, sy, width, height;
271         float zoomx, zoomy;
272
273         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
274         ED_space_image_get_size(sima, &width, &height);
275
276         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
277
278         co[0] = ((mval[0] - sx) / zoomx) / width;
279         co[1] = ((mval[1] - sy) / zoomy) / height;
280 }
281
282 void ED_image_point_pos(SpaceImage *sima, ARegion *ar, float x, float y, float *xr, float *yr)
283 {
284         int sx, sy, width, height;
285         float zoomx, zoomy;
286
287         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
288         ED_space_image_get_size(sima, &width, &height);
289
290         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
291
292         *xr = ((x - sx) / zoomx) / width;
293         *yr = ((y - sy) / zoomy) / height;
294 }
295
296 void ED_image_point_pos__reverse(SpaceImage *sima, ARegion *ar, const float co[2], float r_co[2])
297 {
298         float zoomx, zoomy;
299         int width, height;
300         int sx, sy;
301
302         UI_view2d_to_region_no_clip(&ar->v2d, 0.0f, 0.0f, &sx, &sy);
303         ED_space_image_get_size(sima, &width, &height);
304         ED_space_image_get_zoom(sima, ar, &zoomx, &zoomy);
305
306         r_co[0] = (co[0] * width  * zoomx) + (float)sx;
307         r_co[1] = (co[1] * height * zoomy) + (float)sy;
308 }
309
310 int ED_space_image_show_render(SpaceImage *sima)
311 {
312         return (sima->image && ELEM(sima->image->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE));
313 }
314
315 int ED_space_image_show_paint(SpaceImage *sima)
316 {
317         if (ED_space_image_show_render(sima))
318                 return 0;
319
320         return (sima->mode == SI_MODE_PAINT);
321 }
322
323 int ED_space_image_show_uvedit(SpaceImage *sima, Object *obedit)
324 {
325         if (sima && (ED_space_image_show_render(sima) || ED_space_image_show_paint(sima)))
326                 return 0;
327
328         if (obedit && obedit->type == OB_MESH) {
329                 struct BMEditMesh *em = BMEdit_FromObject(obedit);
330                 int ret;
331
332                 ret = EDBM_mtexpoly_check(em);
333
334                 return ret;
335         }
336
337         return 0;
338 }
339
340 int ED_space_image_show_uvshadow(SpaceImage *sima, Object *obedit)
341 {
342         if (ED_space_image_show_render(sima))
343                 return 0;
344
345         if (ED_space_image_show_paint(sima))
346                 if (obedit && obedit->type == OB_MESH) {
347                         struct BMEditMesh *em = BMEdit_FromObject(obedit);
348                         int ret;
349
350                         ret = EDBM_mtexpoly_check(em);
351
352                         return ret;
353                 }
354
355         return 0;
356 }
357
358 /* matches clip function */
359 int ED_space_image_check_show_maskedit(Scene *scene, SpaceImage *sima)
360 {
361         /* check editmode - this is reserved for UV editing */
362         Object *ob = OBACT;
363         if (ob && ob->mode & OB_MODE_EDIT && ED_space_image_show_uvedit(sima, ob)) {
364                 return FALSE;
365         }
366
367         return (sima->mode == SI_MODE_MASK);
368 }
369
370 int ED_space_image_maskedit_poll(bContext *C)
371 {
372         SpaceImage *sima = CTX_wm_space_image(C);
373
374         if (sima && sima->image) {
375                 Scene *scene = CTX_data_scene(C);
376                 return ED_space_image_check_show_maskedit(scene, sima);
377         }
378
379         return FALSE;
380 }
381
382 int ED_space_image_maskedit_mask_poll(bContext *C)
383 {
384         if (ED_space_image_maskedit_poll(C)) {
385                 Image *ima = CTX_data_edit_image(C);
386
387                 if (ima) {
388                         SpaceImage *sima = CTX_wm_space_image(C);
389
390                         return sima->mask_info.mask != NULL;
391                 }
392         }
393
394         return FALSE;
395 }
396
397 /******************** TODO ********************/
398
399 /* XXX notifier? */
400
401 /* goes over all ImageUsers, and sets frame numbers if auto-refresh is set */
402
403 static void image_update_frame(struct Image *UNUSED(ima), struct ImageUser *iuser, void *customdata)
404 {
405         int cfra = *(int *)customdata;
406
407         BKE_image_user_check_frame_calc(iuser, cfra, 0);
408 }
409
410 void ED_image_update_frame(const Main *mainp, int cfra)
411 {
412         BKE_image_walk_all_users(mainp, &cfra, image_update_frame);
413 }