wip mask/image commit, mostly internal function & added some TODO's
[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 "WM_api.h"
51 #include "WM_types.h"
52
53 /* note; image_panel_properties() uses pointer to sima->image directly */
54 Image *ED_space_image(SpaceImage *sima)
55 {
56         return sima->image;
57 }
58
59 /* called to assign images to UV faces */
60 void ED_space_image_set(SpaceImage *sima, Scene *scene, Object *obedit, Image *ima)
61 {
62         /* context may be NULL, so use global */
63         ED_uvedit_assign_image(G.main, scene, obedit, ima, sima->image);
64
65         /* change the space ima after because uvedit_face_visible_test uses the space ima
66          * to check if the face is displayed in UV-localview */
67         sima->image = ima;
68
69         if (ima == NULL || ima->type == IMA_TYPE_R_RESULT || ima->type == IMA_TYPE_COMPOSITE)
70                 sima->flag &= ~SI_DRAWTOOL;
71
72         if (sima->image)
73                 BKE_image_signal(sima->image, &sima->iuser, IMA_SIGNAL_USER_NEW_IMAGE);
74
75         if (sima->image && sima->image->id.us == 0)
76                 sima->image->id.us = 1;
77
78         if (obedit)
79                 WM_main_add_notifier(NC_GEOM | ND_DATA, obedit->data);
80
81         WM_main_add_notifier(NC_SPACE | ND_SPACE_IMAGE, NULL);
82 }
83
84 Mask *ED_space_image_get_mask(SpaceImage *sima)
85 {
86         return sima->mask_info.mask;
87 }
88
89 void ED_space_image_set_mask(bContext *C, SpaceImage *sima, Mask *mask)
90 {
91         sima->mask_info.mask = mask;
92
93         if (C) {
94                 WM_event_add_notifier(C, NC_MASK | NA_SELECTED, mask);
95         }
96 }
97
98 ImBuf *ED_space_image_acquire_buffer(SpaceImage *sima, void **lock_r)
99 {
100         ImBuf *ibuf;
101
102         if (sima && sima->image) {
103 #if 0
104                 if (sima->image->type == IMA_TYPE_R_RESULT && BIF_show_render_spare())
105                         return BIF_render_spare_imbuf();
106                 else
107 #endif
108                 ibuf = BKE_image_acquire_ibuf(sima->image, &sima->iuser, lock_r);
109
110                 if (ibuf && (ibuf->rect || ibuf->rect_float))
111                         return ibuf;
112         }
113
114         return NULL;
115 }
116
117 void ED_space_image_release_buffer(SpaceImage *sima, void *lock)
118 {
119         if (sima && sima->image)
120                 BKE_image_release_ibuf(sima->image, lock);
121 }
122
123 int ED_space_image_has_buffer(SpaceImage *sima)
124 {
125         ImBuf *ibuf;
126         void *lock;
127         int has_buffer;
128
129         ibuf = ED_space_image_acquire_buffer(sima, &lock);
130         has_buffer = (ibuf != NULL);
131         ED_space_image_release_buffer(sima, lock);
132
133         return has_buffer;
134 }
135
136 void ED_image_size(Image *ima, int *width, int *height)
137 {
138         ImBuf *ibuf = NULL;
139         void *lock;
140
141         if (ima)
142                 ibuf = BKE_image_acquire_ibuf(ima, NULL, &lock);
143
144         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
145                 *width = ibuf->x;
146                 *height = ibuf->y;
147         }
148         else {
149                 *width = 256;
150                 *height = 256;
151         }
152
153         if (ima)
154                 BKE_image_release_ibuf(ima, lock);
155 }
156
157 void ED_space_image_size(SpaceImage *sima, int *width, int *height)
158 {
159         Scene *scene = sima->iuser.scene;
160         ImBuf *ibuf;
161         void *lock;
162
163         ibuf = ED_space_image_acquire_buffer(sima, &lock);
164
165         if (ibuf && ibuf->x > 0 && ibuf->y > 0) {
166                 *width = ibuf->x;
167                 *height = ibuf->y;
168         }
169         else if (sima->image && sima->image->type == IMA_TYPE_R_RESULT && scene) {
170                 /* not very important, just nice */
171                 *width = (scene->r.xsch * scene->r.size) / 100;
172                 *height = (scene->r.ysch * scene->r.size) / 100;
173
174                 if ((scene->r.mode & R_BORDER) && (scene->r.mode & R_CROP)) {
175                         *width *= (scene->r.border.xmax - scene->r.border.xmin);
176                         *height *= (scene->r.border.ymax - scene->r.border.ymin);
177                 }
178
179         }
180         /* I know a bit weak... but preview uses not actual image size */
181         // XXX else if (image_preview_active(sima, width, height));
182         else {
183                 *width = 256;
184                 *height = 256;
185         }
186
187         ED_space_image_release_buffer(sima, lock);
188 }
189
190 void ED_image_aspect(Image *ima, float *aspx, float *aspy)
191 {
192         *aspx = *aspy = 1.0;
193
194         if ((ima == NULL) || (ima->type == IMA_TYPE_R_RESULT) || (ima->type == IMA_TYPE_COMPOSITE) ||
195             (ima->aspx == 0.0f || ima->aspy == 0.0f))
196         {
197                 return;
198         }
199
200         /* x is always 1 */
201         *aspy = ima->aspy / ima->aspx;
202 }
203
204 void ED_space_image_aspect(SpaceImage *sima, float *aspx, float *aspy)
205 {
206         ED_image_aspect(ED_space_image(sima), aspx, aspy);
207 }
208
209 void ED_space_image_zoom(SpaceImage *sima, ARegion *ar, float *zoomx, float *zoomy)
210 {
211         int width, height;
212
213         ED_space_image_size(sima, &width, &height);
214
215         *zoomx = (float)(ar->winrct.xmax - ar->winrct.xmin + 1) / (float)((ar->v2d.cur.xmax - ar->v2d.cur.xmin) * width);
216         *zoomy = (float)(ar->winrct.ymax - ar->winrct.ymin + 1) / (float)((ar->v2d.cur.ymax - ar->v2d.cur.ymin) * height);
217 }
218
219 void ED_space_image_uv_aspect(SpaceImage *sima, float *aspx, float *aspy)
220 {
221         int w, h;
222
223         ED_space_image_aspect(sima, aspx, aspy);
224         ED_space_image_size(sima, &w, &h);
225
226         *aspx *= (float)w;
227         *aspy *= (float)h;
228
229         if (*aspx < *aspy) {
230                 *aspy = *aspy / *aspx;
231                 *aspx = 1.0f;
232         }
233         else {
234                 *aspx = *aspx / *aspy;
235                 *aspy = 1.0f;
236         }
237 }
238
239 void ED_image_uv_aspect(Image *ima, float *aspx, float *aspy)
240 {
241         int w, h;
242
243         ED_image_aspect(ima, aspx, aspy);
244         ED_image_size(ima, &w, &h);
245
246         *aspx *= (float)w;
247         *aspy *= (float)h;
248 }
249
250 int ED_space_image_show_render(SpaceImage *sima)
251 {
252         return (sima->image && ELEM(sima->image->type, IMA_TYPE_R_RESULT, IMA_TYPE_COMPOSITE));
253 }
254
255 int ED_space_image_show_paint(SpaceImage *sima)
256 {
257         if (ED_space_image_show_render(sima))
258                 return 0;
259
260         return (sima->flag & SI_DRAWTOOL);
261 }
262
263 int ED_space_image_show_uvedit(SpaceImage *sima, Object *obedit)
264 {
265         if (sima && (ED_space_image_show_render(sima) || ED_space_image_show_paint(sima)))
266                 return 0;
267
268         if (obedit && obedit->type == OB_MESH) {
269                 struct BMEditMesh *em = BMEdit_FromObject(obedit);
270                 int ret;
271
272                 ret = EDBM_mtexpoly_check(em);
273
274                 return ret;
275         }
276
277         return 0;
278 }
279
280 int ED_space_image_show_uvshadow(SpaceImage *sima, Object *obedit)
281 {
282         if (ED_space_image_show_render(sima))
283                 return 0;
284
285         if (ED_space_image_show_paint(sima))
286                 if (obedit && obedit->type == OB_MESH) {
287                         struct BMEditMesh *em = BMEdit_FromObject(obedit);
288                         int ret;
289
290                         ret = EDBM_mtexpoly_check(em);
291
292                         return ret;
293                 }
294
295         return 0;
296 }
297
298 /* matches clip function */
299 int ED_space_image_check_show_maskedit(SpaceImage *sima)
300 {
301         /* MASKTODO - whem we have a mask edit option */
302         (void)sima;
303         return TRUE;
304 }
305
306 int ED_space_image_maskedit_poll(bContext *C)
307 {
308         SpaceImage *sima = CTX_wm_space_image(C);
309
310         if (sima && sima->image) {
311                 return ED_space_image_check_show_maskedit(sima);
312         }
313
314         return FALSE;
315 }
316
317 int ED_space_image_maskedit_mask_poll(bContext *C)
318 {
319         if (ED_space_image_maskedit_poll(C)) {
320                 Image *ima = CTX_data_edit_image(C);
321
322                 if (ima) {
323                         SpaceImage *sima = CTX_wm_space_image(C);
324
325                         return sima->mask_info.mask != NULL;
326                 }
327         }
328
329         return FALSE;
330 }
331
332 /******************** TODO ********************/
333
334 /* XXX notifier? */
335
336 /* goes over all ImageUsers, and sets frame numbers if auto-refresh is set */
337
338 static void image_update_frame(struct Image *UNUSED(ima), struct ImageUser *iuser, void *customdata)
339 {
340         int cfra = *(int *)customdata;
341
342         BKE_image_user_check_frame_calc(iuser, cfra, 0);
343 }
344
345 void ED_image_update_frame(const Main *mainp, int cfra)
346 {
347         BKE_image_walk_all_users(mainp, &cfra, image_update_frame);
348 }