UI: ignore events in empty region overlap areas
[blender.git] / source / blender / editors / screen / area_query.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
17 /** \file
18  * \ingroup edscr
19  *
20  * Query functions for area/region.
21  */
22
23 #include "DNA_userdef_types.h"
24
25 #include "BLI_blenlib.h"
26 #include "BLI_utildefines.h"
27
28 #include "RNA_types.h"
29
30 #include "WM_api.h"
31
32 #include "ED_screen.h"
33
34 #include "UI_interface.h"
35 #include "UI_view2d.h"
36
37 bool ED_region_overlap_isect_x(const ARegion *ar, const int event_x)
38 {
39   BLI_assert(ar->overlap);
40   /* No contents, skip it. */
41   if (ar->v2d.mask.xmin == ar->v2d.mask.xmax) {
42     return false;
43   }
44   return BLI_rctf_isect_x(&ar->v2d.tot,
45                           UI_view2d_region_to_view_x(&ar->v2d, event_x - ar->winrct.xmin));
46 }
47
48 bool ED_region_overlap_isect_y(const ARegion *ar, const int event_y)
49 {
50   BLI_assert(ar->overlap);
51   /* No contents, skip it. */
52   if (ar->v2d.mask.ymin == ar->v2d.mask.ymax) {
53     return false;
54   }
55   return BLI_rctf_isect_y(&ar->v2d.tot,
56                           UI_view2d_region_to_view_y(&ar->v2d, event_y - ar->winrct.ymin));
57 }
58
59 bool ED_region_overlap_isect_xy(const ARegion *ar, const int event_xy[2])
60 {
61   return (ED_region_overlap_isect_x(ar, event_xy[0]) &&
62           ED_region_overlap_isect_y(ar, event_xy[1]));
63 }
64
65 bool ED_region_overlap_isect_x_with_margin(const ARegion *ar, const int event_x, const int margin)
66 {
67   BLI_assert(ar->overlap);
68   /* No contents, skip it. */
69   if (ar->v2d.mask.xmin == ar->v2d.mask.xmax) {
70     return false;
71   }
72   int region_x = event_x - ar->winrct.xmin;
73   return ((ar->v2d.tot.xmin <= UI_view2d_region_to_view_x(&ar->v2d, region_x + margin)) &&
74           (ar->v2d.tot.xmax >= UI_view2d_region_to_view_x(&ar->v2d, region_x - margin)));
75 }
76
77 bool ED_region_overlap_isect_y_with_margin(const ARegion *ar, const int event_y, const int margin)
78 {
79   BLI_assert(ar->overlap);
80   /* No contents, skip it. */
81   if (ar->v2d.mask.ymin == ar->v2d.mask.ymax) {
82     return false;
83   }
84   int region_y = event_y - ar->winrct.ymin;
85   return ((ar->v2d.tot.ymin <= UI_view2d_region_to_view_y(&ar->v2d, region_y + margin)) &&
86           (ar->v2d.tot.ymax >= UI_view2d_region_to_view_y(&ar->v2d, region_y - margin)));
87 }
88
89 bool ED_region_overlap_isect_xy_with_margin(const ARegion *ar,
90                                             const int event_xy[2],
91                                             const int margin)
92 {
93   return (ED_region_overlap_isect_x_with_margin(ar, event_xy[0], margin) &&
94           ED_region_overlap_isect_y_with_margin(ar, event_xy[1], margin));
95 }
96
97 bool ED_region_contains_xy(const ARegion *ar, const int event_xy[2])
98 {
99   /* Only use the margin when inside the region. */
100   if (BLI_rcti_isect_pt_v(&ar->winrct, event_xy)) {
101     if (ar->overlap) {
102       const int overlap_margin = UI_REGION_OVERLAP_MARGIN;
103       /* Note the View2D.tot isn't reliable for headers with spacers otherwise
104        * we'd check #ED_region_overlap_isect_xy_with_margin for both bases. */
105       if (ar->v2d.keeptot == V2D_KEEPTOT_STRICT) {
106         /* Header. */
107         rcti rect;
108         BLI_rcti_init_pt_radius(&rect, event_xy, overlap_margin);
109         if (UI_region_but_find_rect_over(ar, &rect) == NULL) {
110           return false;
111         }
112       }
113       else {
114         /* Side-bar & any other kind of overlapping region. */
115         if (!ED_region_overlap_isect_xy_with_margin(ar, event_xy, overlap_margin)) {
116           return false;
117         }
118       }
119     }
120     return true;
121   }
122   return false;
123 }