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