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