f3ed84b327757cd9f5ec0b566a441c382195edbb
[blender.git] / source / blender / editors / space_image / space_image.c
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2008 Blender Foundation.
17  * All rights reserved.
18  */
19
20 /** \file
21  * \ingroup spimage
22  */
23
24 #include "DNA_gpencil_types.h"
25 #include "DNA_mesh_types.h"
26 #include "DNA_mask_types.h"
27 #include "DNA_meshdata_types.h"
28 #include "DNA_object_types.h"
29 #include "DNA_scene_types.h"
30 #include "DNA_image_types.h"
31
32 #include "MEM_guardedalloc.h"
33
34 #include "BLI_blenlib.h"
35 #include "BLI_math.h"
36 #include "BLI_threads.h"
37
38 #include "BKE_colortools.h"
39 #include "BKE_context.h"
40 #include "BKE_editmesh.h"
41 #include "BKE_image.h"
42 #include "BKE_layer.h"
43 #include "BKE_library.h"
44 #include "BKE_material.h"
45 #include "BKE_scene.h"
46 #include "BKE_screen.h"
47 #include "BKE_workspace.h"
48
49 #include "RNA_access.h"
50 #include "RNA_define.h"
51 #include "RNA_enum_types.h"
52
53 #include "DEG_depsgraph.h"
54
55 #include "IMB_imbuf_types.h"
56
57 #include "ED_image.h"
58 #include "ED_mask.h"
59 #include "ED_mesh.h"
60 #include "ED_node.h"
61 #include "ED_render.h"
62 #include "ED_space_api.h"
63 #include "ED_screen.h"
64 #include "ED_uvedit.h"
65 #include "ED_transform.h"
66
67 #include "WM_api.h"
68 #include "WM_types.h"
69 #include "WM_message.h"
70
71 #include "UI_resources.h"
72 #include "UI_interface.h"
73 #include "UI_view2d.h"
74
75 #include "image_intern.h"
76 #include "GPU_framebuffer.h"
77 #include "GPU_batch_presets.h"
78 #include "GPU_viewport.h"
79
80 /* TODO(fclem) remove bad level calls */
81 #include "../draw/DRW_engine.h"
82 #include "wm_draw.h"
83
84 /**************************** common state *****************************/
85
86 static void image_scopes_tag_refresh(ScrArea *sa)
87 {
88   SpaceImage *sima = (SpaceImage *)sa->spacedata.first;
89   ARegion *ar;
90
91   /* only while histogram is visible */
92   for (ar = sa->regionbase.first; ar; ar = ar->next) {
93     if (ar->regiontype == RGN_TYPE_TOOL_PROPS && ar->flag & RGN_FLAG_HIDDEN) {
94       return;
95     }
96   }
97
98   sima->scopes.ok = 0;
99 }
100
101 static void image_user_refresh_scene(const bContext *C, SpaceImage *sima)
102 {
103   /* Update scene image user for acquiring render results. */
104   sima->iuser.scene = CTX_data_scene(C);
105
106   if (sima->image && sima->image->type == IMA_TYPE_R_RESULT) {
107     /* While rendering, prefer scene that is being rendered. */
108     Scene *render_scene = ED_render_job_get_current_scene(C);
109     if (render_scene) {
110       sima->iuser.scene = render_scene;
111     }
112   }
113
114   /* Auto switch image to show in UV editor when selection changes. */
115   ED_space_image_auto_set(C, sima);
116 }
117
118 /* ******************** manage regions ********************* */
119
120 ARegion *image_has_buttons_region(ScrArea *sa)
121 {
122   ARegion *ar, *arnew;
123
124   ar = BKE_area_find_region_type(sa, RGN_TYPE_UI);
125   if (ar) {
126     return ar;
127   }
128
129   /* add subdiv level; after header */
130   ar = BKE_area_find_region_type(sa, RGN_TYPE_HEADER);
131
132   /* is error! */
133   if (ar == NULL) {
134     return NULL;
135   }
136
137   arnew = MEM_callocN(sizeof(ARegion), "buttons for image");
138
139   BLI_insertlinkafter(&sa->regionbase, ar, arnew);
140   arnew->regiontype = RGN_TYPE_UI;
141   arnew->alignment = RGN_ALIGN_RIGHT;
142
143   arnew->flag = RGN_FLAG_HIDDEN;
144
145   return arnew;
146 }
147
148 ARegion *image_has_tools_region(ScrArea *sa)
149 {
150   ARegion *ar, *arnew;
151
152   ar = BKE_area_find_region_type(sa, RGN_TYPE_TOOLS);
153   if (ar) {
154     return ar;
155   }
156
157   /* add subdiv level; after buttons */
158   ar = BKE_area_find_region_type(sa, RGN_TYPE_UI);
159
160   /* is error! */
161   if (ar == NULL) {
162     return NULL;
163   }
164
165   arnew = MEM_callocN(sizeof(ARegion), "scopes for image");
166
167   BLI_insertlinkafter(&sa->regionbase, ar, arnew);
168   arnew->regiontype = RGN_TYPE_TOOLS;
169   arnew->alignment = RGN_ALIGN_LEFT;
170
171   arnew->flag = RGN_FLAG_HIDDEN;
172
173   image_scopes_tag_refresh(sa);
174
175   return arnew;
176 }
177
178 /* ******************** default callbacks for image space ***************** */
179
180 static SpaceLink *image_new(const ScrArea *UNUSED(area), const Scene *UNUSED(scene))
181 {
182   ARegion *ar;
183   SpaceImage *simage;
184
185   simage = MEM_callocN(sizeof(SpaceImage), "initimage");
186   simage->spacetype = SPACE_IMAGE;
187   simage->zoom = 1.0f;
188   simage->lock = true;
189   simage->flag = SI_SHOW_GPENCIL | SI_USE_ALPHA | SI_COORDFLOATS;
190
191   BKE_imageuser_default(&simage->iuser);
192   simage->iuser.flag = IMA_SHOW_STEREO | IMA_ANIM_ALWAYS;
193
194   scopes_new(&simage->scopes);
195   simage->sample_line_hist.height = 100;
196
197   /* header */
198   ar = MEM_callocN(sizeof(ARegion), "header for image");
199
200   BLI_addtail(&simage->regionbase, ar);
201   ar->regiontype = RGN_TYPE_HEADER;
202   ar->alignment = (U.uiflag & USER_HEADER_BOTTOM) ? RGN_ALIGN_BOTTOM : RGN_ALIGN_TOP;
203
204   /* buttons/list view */
205   ar = MEM_callocN(sizeof(ARegion), "buttons for image");
206
207   BLI_addtail(&simage->regionbase, ar);
208   ar->regiontype = RGN_TYPE_UI;
209   ar->alignment = RGN_ALIGN_RIGHT;
210   ar->flag = RGN_FLAG_HIDDEN;
211
212   /* scopes/uv sculpt/paint */
213   ar = MEM_callocN(sizeof(ARegion), "buttons for image");
214
215   BLI_addtail(&simage->regionbase, ar);
216   ar->regiontype = RGN_TYPE_TOOLS;
217   ar->alignment = RGN_ALIGN_LEFT;
218   ar->flag = RGN_FLAG_HIDDEN;
219
220   /* main area */
221   ar = MEM_callocN(sizeof(ARegion), "main area for image");
222
223   BLI_addtail(&simage->regionbase, ar);
224   ar->regiontype = RGN_TYPE_WINDOW;
225
226   return (SpaceLink *)simage;
227 }
228
229 /* not spacelink itself */
230 static void image_free(SpaceLink *sl)
231 {
232   SpaceImage *simage = (SpaceImage *)sl;
233
234   scopes_free(&simage->scopes);
235 }
236
237 /* spacetype; init callback, add handlers */
238 static void image_init(struct wmWindowManager *UNUSED(wm), ScrArea *sa)
239 {
240   ListBase *lb = WM_dropboxmap_find("Image", SPACE_IMAGE, 0);
241
242   /* add drop boxes */
243   WM_event_add_dropbox_handler(&sa->handlers, lb);
244 }
245
246 static SpaceLink *image_duplicate(SpaceLink *sl)
247 {
248   SpaceImage *simagen = MEM_dupallocN(sl);
249
250   /* clear or remove stuff from old */
251
252   scopes_new(&simagen->scopes);
253
254   return (SpaceLink *)simagen;
255 }
256
257 static void image_operatortypes(void)
258 {
259   WM_operatortype_append(IMAGE_OT_view_all);
260   WM_operatortype_append(IMAGE_OT_view_pan);
261   WM_operatortype_append(IMAGE_OT_view_selected);
262   WM_operatortype_append(IMAGE_OT_view_zoom);
263   WM_operatortype_append(IMAGE_OT_view_zoom_in);
264   WM_operatortype_append(IMAGE_OT_view_zoom_out);
265   WM_operatortype_append(IMAGE_OT_view_zoom_ratio);
266   WM_operatortype_append(IMAGE_OT_view_zoom_border);
267 #ifdef WITH_INPUT_NDOF
268   WM_operatortype_append(IMAGE_OT_view_ndof);
269 #endif
270
271   WM_operatortype_append(IMAGE_OT_new);
272   WM_operatortype_append(IMAGE_OT_open);
273   WM_operatortype_append(IMAGE_OT_match_movie_length);
274   WM_operatortype_append(IMAGE_OT_replace);
275   WM_operatortype_append(IMAGE_OT_reload);
276   WM_operatortype_append(IMAGE_OT_save);
277   WM_operatortype_append(IMAGE_OT_save_as);
278   WM_operatortype_append(IMAGE_OT_save_sequence);
279   WM_operatortype_append(IMAGE_OT_pack);
280   WM_operatortype_append(IMAGE_OT_unpack);
281
282   WM_operatortype_append(IMAGE_OT_invert);
283
284   WM_operatortype_append(IMAGE_OT_cycle_render_slot);
285   WM_operatortype_append(IMAGE_OT_clear_render_slot);
286   WM_operatortype_append(IMAGE_OT_add_render_slot);
287   WM_operatortype_append(IMAGE_OT_remove_render_slot);
288
289   WM_operatortype_append(IMAGE_OT_sample);
290   WM_operatortype_append(IMAGE_OT_sample_line);
291   WM_operatortype_append(IMAGE_OT_curves_point_set);
292
293   WM_operatortype_append(IMAGE_OT_change_frame);
294
295   WM_operatortype_append(IMAGE_OT_read_viewlayers);
296   WM_operatortype_append(IMAGE_OT_render_border);
297   WM_operatortype_append(IMAGE_OT_clear_render_border);
298 }
299
300 static void image_keymap(struct wmKeyConfig *keyconf)
301 {
302   WM_keymap_ensure(keyconf, "Image Generic", SPACE_IMAGE, 0);
303   WM_keymap_ensure(keyconf, "Image", SPACE_IMAGE, 0);
304 }
305
306 /* dropboxes */
307 static bool image_drop_poll(bContext *UNUSED(C),
308                             wmDrag *drag,
309                             const wmEvent *UNUSED(event),
310                             const char **UNUSED(tooltip))
311 {
312   if (drag->type == WM_DRAG_PATH) {
313     /* rule might not work? */
314     if (ELEM(drag->icon, 0, ICON_FILE_IMAGE, ICON_FILE_MOVIE, ICON_FILE_BLANK)) {
315       return 1;
316     }
317   }
318   return 0;
319 }
320
321 static void image_drop_copy(wmDrag *drag, wmDropBox *drop)
322 {
323   /* copy drag path to properties */
324   RNA_string_set(drop->ptr, "filepath", drag->path);
325 }
326
327 /* area+region dropbox definition */
328 static void image_dropboxes(void)
329 {
330   ListBase *lb = WM_dropboxmap_find("Image", SPACE_IMAGE, 0);
331
332   WM_dropbox_add(lb, "IMAGE_OT_open", image_drop_poll, image_drop_copy);
333 }
334
335 /**
336  * \note take care not to get into feedback loop here,
337  *       calling composite job causes viewer to refresh.
338  */
339 static void image_refresh(const bContext *C, ScrArea *sa)
340 {
341   Scene *scene = CTX_data_scene(C);
342   SpaceImage *sima = sa->spacedata.first;
343   Image *ima;
344
345   ima = ED_space_image(sima);
346
347   BKE_image_user_frame_calc(&sima->iuser, scene->r.cfra);
348
349   /* check if we have to set the image from the editmesh */
350   if (ima && (ima->source == IMA_SRC_VIEWER && sima->mode == SI_MODE_MASK)) {
351     if (scene->nodetree) {
352       Mask *mask = ED_space_image_get_mask(sima);
353       if (mask) {
354         ED_node_composite_job(C, scene->nodetree, scene);
355       }
356     }
357   }
358 }
359
360 static void image_listener(wmWindow *win, ScrArea *sa, wmNotifier *wmn, Scene *UNUSED(scene))
361 {
362   SpaceImage *sima = (SpaceImage *)sa->spacedata.first;
363
364   /* context changes */
365   switch (wmn->category) {
366     case NC_WINDOW:
367       /* notifier comes from editing color space */
368       image_scopes_tag_refresh(sa);
369       ED_area_tag_redraw(sa);
370       break;
371     case NC_SCENE:
372       switch (wmn->data) {
373         case ND_FRAME:
374           image_scopes_tag_refresh(sa);
375           ED_area_tag_refresh(sa);
376           ED_area_tag_redraw(sa);
377           break;
378         case ND_MODE:
379           if (wmn->subtype == NS_EDITMODE_MESH) {
380             ED_area_tag_refresh(sa);
381           }
382           ED_area_tag_redraw(sa);
383           break;
384         case ND_RENDER_RESULT:
385         case ND_RENDER_OPTIONS:
386         case ND_COMPO_RESULT:
387           if (ED_space_image_show_render(sima)) {
388             image_scopes_tag_refresh(sa);
389           }
390           ED_area_tag_redraw(sa);
391           break;
392       }
393       break;
394     case NC_IMAGE:
395       if (wmn->reference == sima->image || !wmn->reference) {
396         if (wmn->action != NA_PAINTING) {
397           image_scopes_tag_refresh(sa);
398           ED_area_tag_refresh(sa);
399           ED_area_tag_redraw(sa);
400         }
401       }
402       break;
403     case NC_SPACE:
404       if (wmn->data == ND_SPACE_IMAGE) {
405         image_scopes_tag_refresh(sa);
406         ED_area_tag_redraw(sa);
407       }
408       break;
409     case NC_MASK: {
410       // Scene *scene = wmn->window->screen->scene;
411       /* ideally would check for: ED_space_image_check_show_maskedit(scene, sima)
412        * but we cant get the scene */
413       if (sima->mode == SI_MODE_MASK) {
414         switch (wmn->data) {
415           case ND_SELECT:
416             ED_area_tag_redraw(sa);
417             break;
418           case ND_DATA:
419           case ND_DRAW:
420             /* causes node-recalc */
421             ED_area_tag_redraw(sa);
422             ED_area_tag_refresh(sa);
423             break;
424         }
425         switch (wmn->action) {
426           case NA_SELECTED:
427             ED_area_tag_redraw(sa);
428             break;
429           case NA_EDITED:
430             /* causes node-recalc */
431             ED_area_tag_redraw(sa);
432             ED_area_tag_refresh(sa);
433             break;
434         }
435       }
436       break;
437     }
438     case NC_GEOM: {
439       switch (wmn->data) {
440         case ND_DATA:
441         case ND_SELECT:
442           image_scopes_tag_refresh(sa);
443           ED_area_tag_refresh(sa);
444           ED_area_tag_redraw(sa);
445           break;
446       }
447       break;
448     }
449     case NC_OBJECT: {
450       switch (wmn->data) {
451         case ND_TRANSFORM:
452         case ND_MODIFIER: {
453           ViewLayer *view_layer = WM_window_get_active_view_layer(win);
454           Object *ob = OBACT(view_layer);
455           if (ob && (ob == wmn->reference) && (ob->mode & OB_MODE_EDIT)) {
456             if (sima->lock && (sima->flag & SI_DRAWSHADOW)) {
457               ED_area_tag_refresh(sa);
458               ED_area_tag_redraw(sa);
459             }
460           }
461           break;
462         }
463       }
464
465       break;
466     }
467     case NC_ID: {
468       if (wmn->action == NA_RENAME) {
469         ED_area_tag_redraw(sa);
470       }
471       break;
472     }
473     case NC_WM:
474       if (wmn->data == ND_UNDO) {
475         ED_area_tag_redraw(sa);
476         ED_area_tag_refresh(sa);
477       }
478       break;
479   }
480 }
481
482 const char *image_context_dir[] = {"edit_image", "edit_mask", NULL};
483
484 static int image_context(const bContext *C, const char *member, bContextDataResult *result)
485 {
486   SpaceImage *sima = CTX_wm_space_image(C);
487
488   if (CTX_data_dir(member)) {
489     CTX_data_dir_set(result, image_context_dir);
490   }
491   else if (CTX_data_equals(member, "edit_image")) {
492     CTX_data_id_pointer_set(result, (ID *)ED_space_image(sima));
493     return 1;
494   }
495   else if (CTX_data_equals(member, "edit_mask")) {
496     Mask *mask = ED_space_image_get_mask(sima);
497     if (mask) {
498       CTX_data_id_pointer_set(result, &mask->id);
499     }
500     return true;
501   }
502   return 0;
503 }
504
505 static void IMAGE_GGT_gizmo2d(wmGizmoGroupType *gzgt)
506 {
507   gzgt->name = "UV Transform Gizmo";
508   gzgt->idname = "IMAGE_GGT_gizmo2d";
509
510   gzgt->gzmap_params.spaceid = SPACE_IMAGE;
511   gzgt->gzmap_params.regionid = RGN_TYPE_WINDOW;
512
513   gzgt->poll = ED_widgetgroup_gizmo2d_poll;
514   gzgt->setup = ED_widgetgroup_gizmo2d_setup;
515   gzgt->refresh = ED_widgetgroup_gizmo2d_refresh;
516   gzgt->draw_prepare = ED_widgetgroup_gizmo2d_draw_prepare;
517 }
518
519 static void image_widgets(void)
520 {
521   WM_gizmogrouptype_append(IMAGE_GGT_gizmo2d);
522 }
523
524 /************************** main region ***************************/
525
526 /* sets up the fields of the View2D from zoom and offset */
527 static void image_main_region_set_view2d(SpaceImage *sima, ARegion *ar)
528 {
529   Image *ima = ED_space_image(sima);
530
531   int width, height;
532   ED_space_image_get_size(sima, &width, &height);
533
534   float w = width;
535   float h = height;
536
537   if (ima) {
538     h *= ima->aspy / ima->aspx;
539   }
540
541   int winx = BLI_rcti_size_x(&ar->winrct) + 1;
542   int winy = BLI_rcti_size_y(&ar->winrct) + 1;
543
544   /* For region overlap, move center so image doesn't overlap header. */
545   rcti visible_rect;
546   ED_region_visible_rect(ar, &visible_rect);
547   const int visible_winy = BLI_rcti_size_y(&visible_rect) + 1;
548   int visible_centerx = 0;
549   int visible_centery = visible_rect.ymin + (visible_winy - winy) / 2;
550
551   ar->v2d.tot.xmin = 0;
552   ar->v2d.tot.ymin = 0;
553   ar->v2d.tot.xmax = w;
554   ar->v2d.tot.ymax = h;
555
556   ar->v2d.mask.xmin = ar->v2d.mask.ymin = 0;
557   ar->v2d.mask.xmax = winx;
558   ar->v2d.mask.ymax = winy;
559
560   /* which part of the image space do we see? */
561   float x1 = ar->winrct.xmin + visible_centerx + (winx - sima->zoom * w) / 2.0f;
562   float y1 = ar->winrct.ymin + visible_centery + (winy - sima->zoom * h) / 2.0f;
563
564   x1 -= sima->zoom * sima->xof;
565   y1 -= sima->zoom * sima->yof;
566
567   /* relative display right */
568   ar->v2d.cur.xmin = ((ar->winrct.xmin - (float)x1) / sima->zoom);
569   ar->v2d.cur.xmax = ar->v2d.cur.xmin + ((float)winx / sima->zoom);
570
571   /* relative display left */
572   ar->v2d.cur.ymin = ((ar->winrct.ymin - (float)y1) / sima->zoom);
573   ar->v2d.cur.ymax = ar->v2d.cur.ymin + ((float)winy / sima->zoom);
574
575   /* normalize 0.0..1.0 */
576   ar->v2d.cur.xmin /= w;
577   ar->v2d.cur.xmax /= w;
578   ar->v2d.cur.ymin /= h;
579   ar->v2d.cur.ymax /= h;
580 }
581
582 /* add handlers, stuff you only do once or on area/region changes */
583 static void image_main_region_init(wmWindowManager *wm, ARegion *ar)
584 {
585   wmKeyMap *keymap;
586
587   // image space manages own v2d
588   // UI_view2d_region_reinit(&ar->v2d, V2D_COMMONVIEW_STANDARD, ar->winx, ar->winy);
589
590   /* mask polls mode */
591   keymap = WM_keymap_ensure(wm->defaultconf, "Mask Editing", 0, 0);
592   WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
593
594   /* image paint polls for mode */
595   keymap = WM_keymap_ensure(wm->defaultconf, "Curve", 0, 0);
596   WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
597
598   keymap = WM_keymap_ensure(wm->defaultconf, "Paint Curve", 0, 0);
599   WM_event_add_keymap_handler(&ar->handlers, keymap);
600
601   keymap = WM_keymap_ensure(wm->defaultconf, "Image Paint", 0, 0);
602   WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
603
604   keymap = WM_keymap_ensure(wm->defaultconf, "UV Editor", 0, 0);
605   WM_event_add_keymap_handler(&ar->handlers, keymap);
606
607   keymap = WM_keymap_ensure(wm->defaultconf, "UV Sculpt", 0, 0);
608   WM_event_add_keymap_handler(&ar->handlers, keymap);
609
610   /* own keymaps */
611   keymap = WM_keymap_ensure(wm->defaultconf, "Image Generic", SPACE_IMAGE, 0);
612   WM_event_add_keymap_handler(&ar->handlers, keymap);
613   keymap = WM_keymap_ensure(wm->defaultconf, "Image", SPACE_IMAGE, 0);
614   WM_event_add_keymap_handler_bb(&ar->handlers, keymap, &ar->v2d.mask, &ar->winrct);
615 }
616
617 static void image_main_region_draw(const bContext *C, ARegion *ar)
618 {
619   /* draw entirely, view changes should be handled here */
620   SpaceImage *sima = CTX_wm_space_image(C);
621   Object *obact = CTX_data_active_object(C);
622   Object *obedit = CTX_data_edit_object(C);
623   Depsgraph *depsgraph = CTX_data_depsgraph(C);
624   Mask *mask = NULL;
625   bool curve = false;
626   Scene *scene = CTX_data_scene(C);
627   ViewLayer *view_layer = CTX_data_view_layer(C);
628   View2D *v2d = &ar->v2d;
629   //View2DScrollers *scrollers;
630   float col[3];
631
632   /* XXX This is in order to draw UI batches with the DRW
633    * olg context since we now use it for drawing the entire area */
634   gpu_batch_presets_reset();
635
636   /* TODO(fclem) port to draw manager and remove the depth buffer allocation. */
637   GPUViewport *viewport =
638       ar->draw_buffer->viewport[ar->draw_buffer->stereo ? sima->iuser.multiview_eye : 0];
639   DefaultFramebufferList *fbl = GPU_viewport_framebuffer_list_get(viewport);
640   GPU_framebuffer_bind(fbl->color_only_fb);
641
642   /* XXX not supported yet, disabling for now */
643   scene->r.scemode &= ~R_COMP_CROP;
644
645   /* clear and setup matrix */
646   UI_GetThemeColor3fv(TH_BACK, col);
647   GPU_clear_color(col[0], col[1], col[2], 0.0);
648   GPU_clear(GPU_COLOR_BIT);
649
650   image_user_refresh_scene(C, sima);
651
652   /* we set view2d from own zoom and offset each time */
653   image_main_region_set_view2d(sima, ar);
654
655   /* we draw image in pixelspace */
656   draw_image_main(C, ar);
657
658   /* and uvs in 0.0-1.0 space */
659   UI_view2d_view_ortho(v2d);
660
661   ED_region_draw_cb_draw(C, ar, REGION_DRAW_PRE_VIEW);
662
663   ED_uvedit_draw_main(sima, ar, scene, view_layer, obedit, obact, depsgraph);
664
665   /* check for mask (delay draw) */
666   if (ED_space_image_show_uvedit(sima, obedit)) {
667     /* pass */
668   }
669   else if (sima->mode == SI_MODE_MASK) {
670     mask = ED_space_image_get_mask(sima);
671   }
672   else if (ED_space_image_paint_curve(C)) {
673     curve = true;
674   }
675
676   ED_region_draw_cb_draw(C, ar, REGION_DRAW_POST_VIEW);
677
678   if (sima->flag & SI_SHOW_GPENCIL) {
679     /* Grease Pencil too (in addition to UV's) */
680     draw_image_grease_pencil((bContext *)C, true);
681   }
682
683   /* sample line */
684   draw_image_sample_line(sima);
685
686   UI_view2d_view_restore(C);
687
688   if (sima->flag & SI_SHOW_GPENCIL) {
689     /* draw Grease Pencil - screen space only */
690     draw_image_grease_pencil((bContext *)C, false);
691   }
692
693   if (mask) {
694     Image *image = ED_space_image(sima);
695     int width, height, show_viewer;
696     float aspx, aspy;
697
698     show_viewer = (image && image->source == IMA_SRC_VIEWER);
699
700     if (show_viewer) {
701       /* ED_space_image_get* will acquire image buffer which requires
702        * lock here by the same reason why lock is needed in draw_image_main
703        */
704       BLI_thread_lock(LOCK_DRAW_IMAGE);
705     }
706
707     ED_space_image_get_size(sima, &width, &height);
708     ED_space_image_get_aspect(sima, &aspx, &aspy);
709
710     if (show_viewer) {
711       BLI_thread_unlock(LOCK_DRAW_IMAGE);
712     }
713
714     ED_mask_draw_region(mask,
715                         ar,
716                         sima->mask_info.draw_flag,
717                         sima->mask_info.draw_type,
718                         sima->mask_info.overlay_mode,
719                         width,
720                         height,
721                         aspx,
722                         aspy,
723                         true,
724                         false,
725                         NULL,
726                         C);
727
728     UI_view2d_view_ortho(v2d);
729     ED_image_draw_cursor(ar, sima->cursor);
730     UI_view2d_view_restore(C);
731   }
732   else if (curve) {
733     UI_view2d_view_ortho(v2d);
734     ED_image_draw_cursor(ar, sima->cursor);
735     UI_view2d_view_restore(C);
736   }
737
738   WM_gizmomap_draw(ar->gizmo_map, C, WM_GIZMOMAP_DRAWSTEP_2D);
739
740   draw_image_cache(C, ar);
741
742   /* scrollers? */
743 #if 0
744   scrollers = UI_view2d_scrollers_calc(
745       C, v2d, V2D_UNIT_VALUES, V2D_GRID_CLAMP, V2D_ARG_DUMMY, V2D_ARG_DUMMY);
746   UI_view2d_scrollers_draw(C, v2d, scrollers);
747   UI_view2d_scrollers_free(scrollers);
748 #endif
749 }
750
751 static void image_main_region_listener(
752     wmWindow *UNUSED(win), ScrArea *sa, ARegion *ar, wmNotifier *wmn, const Scene *UNUSED(scene))
753 {
754   /* context changes */
755   switch (wmn->category) {
756     case NC_GEOM:
757       if (ELEM(wmn->data, ND_DATA, ND_SELECT)) {
758         WM_gizmomap_tag_refresh(ar->gizmo_map);
759       }
760       break;
761     case NC_GPENCIL:
762       if (ELEM(wmn->action, NA_EDITED, NA_SELECTED)) {
763         ED_region_tag_redraw(ar);
764       }
765       else if (wmn->data & ND_GPENCIL_EDITMODE) {
766         ED_region_tag_redraw(ar);
767       }
768       break;
769     case NC_IMAGE:
770       if (wmn->action == NA_PAINTING) {
771         ED_region_tag_redraw(ar);
772       }
773       WM_gizmomap_tag_refresh(ar->gizmo_map);
774       break;
775     case NC_MATERIAL:
776       if (wmn->data == ND_SHADING_LINKS) {
777         SpaceImage *sima = sa->spacedata.first;
778
779         if (sima->iuser.scene && (sima->iuser.scene->toolsettings->uv_flag & UV_SHOW_SAME_IMAGE)) {
780           ED_region_tag_redraw(ar);
781         }
782       }
783       break;
784     case NC_SCREEN:
785       if (ELEM(wmn->data, ND_LAYER)) {
786         ED_region_tag_redraw(ar);
787       }
788       break;
789   }
790 }
791
792 /* *********************** buttons region ************************ */
793
794 /* add handlers, stuff you only do once or on area/region changes */
795 static void image_buttons_region_init(wmWindowManager *wm, ARegion *ar)
796 {
797   wmKeyMap *keymap;
798
799   ar->v2d.scroll = V2D_SCROLL_RIGHT | V2D_SCROLL_VERTICAL_HIDE;
800   ED_region_panels_init(wm, ar);
801
802   keymap = WM_keymap_ensure(wm->defaultconf, "Image Generic", SPACE_IMAGE, 0);
803   WM_event_add_keymap_handler(&ar->handlers, keymap);
804 }
805
806 static void image_buttons_region_draw(const bContext *C, ARegion *ar)
807 {
808   SpaceImage *sima = CTX_wm_space_image(C);
809   Scene *scene = CTX_data_scene(C);
810   void *lock;
811   ImBuf *ibuf = ED_space_image_acquire_buffer(sima, &lock);
812   /* XXX performance regression if name of scopes category changes! */
813   PanelCategoryStack *category = UI_panel_category_active_find(ar, "Scopes");
814
815   /* only update scopes if scope category is active */
816   if (category) {
817     if (ibuf) {
818       if (!sima->scopes.ok) {
819         BKE_histogram_update_sample_line(
820             &sima->sample_line_hist, ibuf, &scene->view_settings, &scene->display_settings);
821       }
822       if (sima->image->flag & IMA_VIEW_AS_RENDER) {
823         ED_space_image_scopes_update(C, sima, ibuf, true);
824       }
825       else {
826         ED_space_image_scopes_update(C, sima, ibuf, false);
827       }
828     }
829   }
830   ED_space_image_release_buffer(sima, ibuf, lock);
831
832   ED_region_panels(C, ar);
833 }
834
835 static void image_buttons_region_listener(wmWindow *UNUSED(win),
836                                           ScrArea *UNUSED(sa),
837                                           ARegion *ar,
838                                           wmNotifier *wmn,
839                                           const Scene *UNUSED(scene))
840 {
841   /* context changes */
842   switch (wmn->category) {
843     case NC_TEXTURE:
844     case NC_MATERIAL:
845       /* sending by texture render job and needed to properly update displaying
846        * brush texture icon */
847       ED_region_tag_redraw(ar);
848       break;
849     case NC_SCENE:
850       switch (wmn->data) {
851         case ND_MODE:
852         case ND_RENDER_RESULT:
853         case ND_COMPO_RESULT:
854           ED_region_tag_redraw(ar);
855           break;
856       }
857       break;
858     case NC_IMAGE:
859       if (wmn->action != NA_PAINTING) {
860         ED_region_tag_redraw(ar);
861       }
862       break;
863     case NC_NODE:
864       ED_region_tag_redraw(ar);
865       break;
866     case NC_GPENCIL:
867       if (ELEM(wmn->action, NA_EDITED, NA_SELECTED)) {
868         ED_region_tag_redraw(ar);
869       }
870       break;
871   }
872 }
873
874 /* *********************** scopes region ************************ */
875
876 /* add handlers, stuff you only do once or on area/region changes */
877 static void image_tools_region_init(wmWindowManager *wm, ARegion *ar)
878 {
879   wmKeyMap *keymap;
880
881   ar->v2d.scroll = V2D_SCROLL_RIGHT | V2D_SCROLL_VERTICAL_HIDE;
882   ED_region_panels_init(wm, ar);
883
884   keymap = WM_keymap_ensure(wm->defaultconf, "Image Generic", SPACE_IMAGE, 0);
885   WM_event_add_keymap_handler(&ar->handlers, keymap);
886 }
887
888 static void image_tools_region_draw(const bContext *C, ARegion *ar)
889 {
890   ED_region_panels(C, ar);
891 }
892
893 static void image_tools_region_listener(wmWindow *UNUSED(win),
894                                         ScrArea *UNUSED(sa),
895                                         ARegion *ar,
896                                         wmNotifier *wmn,
897                                         const Scene *UNUSED(scene))
898 {
899   /* context changes */
900   switch (wmn->category) {
901     case NC_GPENCIL:
902       if (wmn->data == ND_DATA || ELEM(wmn->action, NA_EDITED, NA_SELECTED)) {
903         ED_region_tag_redraw(ar);
904       }
905       break;
906     case NC_BRUSH:
907       /* NA_SELECTED is used on brush changes */
908       if (ELEM(wmn->action, NA_EDITED, NA_SELECTED)) {
909         ED_region_tag_redraw(ar);
910       }
911       break;
912     case NC_SCENE:
913       switch (wmn->data) {
914         case ND_MODE:
915         case ND_RENDER_RESULT:
916         case ND_COMPO_RESULT:
917           ED_region_tag_redraw(ar);
918           break;
919       }
920       break;
921     case NC_IMAGE:
922       if (wmn->action != NA_PAINTING) {
923         ED_region_tag_redraw(ar);
924       }
925       break;
926     case NC_NODE:
927       ED_region_tag_redraw(ar);
928       break;
929   }
930 }
931
932 /************************* header region **************************/
933
934 /* add handlers, stuff you only do once or on area/region changes */
935 static void image_header_region_init(wmWindowManager *UNUSED(wm), ARegion *ar)
936 {
937   ED_region_header_init(ar);
938 }
939
940 static void image_header_region_draw(const bContext *C, ARegion *ar)
941 {
942   ScrArea *sa = CTX_wm_area(C);
943   SpaceImage *sima = sa->spacedata.first;
944
945   image_user_refresh_scene(C, sima);
946
947   ED_region_header(C, ar);
948 }
949
950 static void image_header_region_listener(wmWindow *UNUSED(win),
951                                          ScrArea *UNUSED(sa),
952                                          ARegion *ar,
953                                          wmNotifier *wmn,
954                                          const Scene *UNUSED(scene))
955 {
956   /* context changes */
957   switch (wmn->category) {
958     case NC_SCENE:
959       switch (wmn->data) {
960         case ND_MODE:
961         case ND_TOOLSETTINGS:
962           ED_region_tag_redraw(ar);
963           break;
964       }
965       break;
966     case NC_GEOM:
967       switch (wmn->data) {
968         case ND_DATA:
969         case ND_SELECT:
970           ED_region_tag_redraw(ar);
971           break;
972       }
973       break;
974   }
975 }
976
977 static void image_id_remap(ScrArea *UNUSED(sa), SpaceLink *slink, ID *old_id, ID *new_id)
978 {
979   SpaceImage *simg = (SpaceImage *)slink;
980
981   if (!ELEM(GS(old_id->name), ID_IM, ID_GD, ID_MSK)) {
982     return;
983   }
984
985   if ((ID *)simg->image == old_id) {
986     simg->image = (Image *)new_id;
987     id_us_ensure_real(new_id);
988   }
989
990   if ((ID *)simg->gpd == old_id) {
991     simg->gpd = (bGPdata *)new_id;
992     id_us_min(old_id);
993     id_us_plus(new_id);
994   }
995
996   if ((ID *)simg->mask_info.mask == old_id) {
997     simg->mask_info.mask = (Mask *)new_id;
998     id_us_ensure_real(new_id);
999   }
1000 }
1001
1002 /**
1003  * \note Used for splitting out a subset of modes is more involved,
1004  * The previous non-uv-edit mode is stored so switching back to the
1005  * image doesn't always reset the sub-mode.
1006  */
1007 static int image_space_subtype_get(ScrArea *sa)
1008 {
1009   SpaceImage *sima = sa->spacedata.first;
1010   return sima->mode == SI_MODE_UV ? SI_MODE_UV : SI_MODE_VIEW;
1011 }
1012
1013 static void image_space_subtype_set(ScrArea *sa, int value)
1014 {
1015   SpaceImage *sima = sa->spacedata.first;
1016   if (value == SI_MODE_UV) {
1017     if (sima->mode != SI_MODE_UV) {
1018       sima->mode_prev = sima->mode;
1019     }
1020     sima->mode = value;
1021   }
1022   else {
1023     sima->mode = sima->mode_prev;
1024   }
1025 }
1026
1027 static void image_space_subtype_item_extend(bContext *UNUSED(C),
1028                                             EnumPropertyItem **item,
1029                                             int *totitem)
1030 {
1031   RNA_enum_items_add(item, totitem, rna_enum_space_image_mode_items);
1032 }
1033
1034 /**************************** spacetype *****************************/
1035
1036 /* only called once, from space/spacetypes.c */
1037 void ED_spacetype_image(void)
1038 {
1039   SpaceType *st = MEM_callocN(sizeof(SpaceType), "spacetype image");
1040   ARegionType *art;
1041
1042   st->spaceid = SPACE_IMAGE;
1043   strncpy(st->name, "Image", BKE_ST_MAXNAME);
1044
1045   st->new = image_new;
1046   st->free = image_free;
1047   st->init = image_init;
1048   st->duplicate = image_duplicate;
1049   st->operatortypes = image_operatortypes;
1050   st->keymap = image_keymap;
1051   st->dropboxes = image_dropboxes;
1052   st->refresh = image_refresh;
1053   st->listener = image_listener;
1054   st->context = image_context;
1055   st->gizmos = image_widgets;
1056   st->id_remap = image_id_remap;
1057   st->space_subtype_item_extend = image_space_subtype_item_extend;
1058   st->space_subtype_get = image_space_subtype_get;
1059   st->space_subtype_set = image_space_subtype_set;
1060
1061   /* regions: main window */
1062   art = MEM_callocN(sizeof(ARegionType), "spacetype image region");
1063   art->regionid = RGN_TYPE_WINDOW;
1064   art->keymapflag = ED_KEYMAP_GIZMO | ED_KEYMAP_TOOL | ED_KEYMAP_FRAMES | ED_KEYMAP_GPENCIL;
1065   art->init = image_main_region_init;
1066   art->draw = image_main_region_draw;
1067   art->listener = image_main_region_listener;
1068   BLI_addhead(&st->regiontypes, art);
1069
1070   /* regions: listview/buttons/scopes */
1071   art = MEM_callocN(sizeof(ARegionType), "spacetype image region");
1072   art->regionid = RGN_TYPE_UI;
1073   art->prefsizex = 220;  // XXX
1074   art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_FRAMES;
1075   art->listener = image_buttons_region_listener;
1076   art->init = image_buttons_region_init;
1077   art->draw = image_buttons_region_draw;
1078   BLI_addhead(&st->regiontypes, art);
1079
1080   ED_uvedit_buttons_register(art);
1081   image_buttons_register(art);
1082
1083   /* regions: tool(bar) */
1084   art = MEM_callocN(sizeof(ARegionType), "spacetype image region");
1085   art->regionid = RGN_TYPE_TOOLS;
1086   art->prefsizex = 58; /* XXX */
1087   art->prefsizey = 50; /* XXX */
1088   art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_FRAMES;
1089   art->listener = image_tools_region_listener;
1090   art->message_subscribe = ED_region_generic_tools_region_message_subscribe;
1091   art->snap_size = ED_region_generic_tools_region_snap_size;
1092   art->init = image_tools_region_init;
1093   art->draw = image_tools_region_draw;
1094   BLI_addhead(&st->regiontypes, art);
1095
1096   /* regions: header */
1097   art = MEM_callocN(sizeof(ARegionType), "spacetype image region");
1098   art->regionid = RGN_TYPE_HEADER;
1099   art->prefsizey = HEADERY;
1100   art->keymapflag = ED_KEYMAP_UI | ED_KEYMAP_VIEW2D | ED_KEYMAP_FRAMES | ED_KEYMAP_HEADER;
1101   art->listener = image_header_region_listener;
1102   art->init = image_header_region_init;
1103   art->draw = image_header_region_draw;
1104
1105   BLI_addhead(&st->regiontypes, art);
1106
1107   /* regions: hud */
1108   art = ED_area_type_hud(st->spaceid);
1109   BLI_addhead(&st->regiontypes, art);
1110
1111   BKE_spacetype_register(st);
1112 }