Blender V5.3
UI_view2d.hh
Go to the documentation of this file.
1/* SPDX-FileCopyrightText: 2008 Blender Authors
2 *
3 * SPDX-License-Identifier: GPL-2.0-or-later */
4
10
11#pragma once
12
13#include "BLI_compiler_attrs.hh"
14#include "BLI_rect.hh"
15
16namespace blender {
17
18/* -------------------------------------------------------------------- */
21
22struct View2D;
23
24struct ARegion;
25struct Scene;
26struct ScrArea;
27struct bContext;
28struct bScreen;
29struct rctf;
30struct rcti;
31struct wmEvent;
32struct wmGizmoGroupType;
33struct wmKeyConfig;
34struct wmOperator;
35struct wmOperatorType;
36
38
39namespace ui {
40
41/* -------------------------------------------------------------------- */
44
46#define V2D_IS_CLIPPED 12000
47
68
70
71/* -------------------------------------------------------------------- */
74
76
77/* Maximum has to include outline which varies with line width. */
78#define V2D_SCROLL_HEIGHT ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))
79#define V2D_SCROLL_WIDTH ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))
80
81/* Alpha of scroll-bar when at minimum size. */
82#define V2D_SCROLL_MIN_ALPHA (0.4f)
83
84/* Minimum size needs to include outline which varies with line width. */
85#define V2D_SCROLL_MIN_WIDTH ((5.0f * UI_SCALE_FAC) + (2.0f * U.pixelsize))
86
87/* When to start showing the full-width scroller. */
88#define V2D_SCROLL_HIDE_WIDTH (AREAMINX * UI_SCALE_FAC)
89#define V2D_SCROLL_HIDE_HEIGHT (HEADERY * UI_SCALE_FAC)
90
92#define V2D_SCROLL_HANDLE_HEIGHT (0.6f * U.widget_unit)
93#define V2D_SCROLL_HANDLE_WIDTH (0.6f * U.widget_unit)
94
96#define V2D_SCROLL_HANDLE_SIZE_HOTSPOT (0.6f * U.widget_unit)
97
99#define V2D_SCROLL_THUMB_SIZE_MIN (30.0 * UI_SCALE_FAC)
100
102
103/* -------------------------------------------------------------------- */
106
107/* means copy it from another v2d */
108#define V2D_LOCK_SET 0
109/* means copy it to the other v2ds */
110#define V2D_LOCK_COPY 1
111
113
114/* -------------------------------------------------------------------- */
117
118/* Test if mouse in a scroll-bar (assume that scroller availability has been tested). */
119#define IN_2D_VERT_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->vert, co))
120#define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->hor, co))
121
122#define IN_2D_VERT_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->vert, rct, NULL))
123#define IN_2D_HORIZ_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->hor, rct, NULL))
124
126
127/* -------------------------------------------------------------------- */
130
143void view2d_region_reinit(View2D *v2d, short type, int winx, int winy);
144
145void view2d_curRect_validate(View2D *v2d);
151void view2d_curRect_reset(View2D *v2d);
152bool view2d_area_supports_sync(ScrArea *area);
157void view2d_sync(bScreen *screen, ScrArea *area, View2D *v2dcur, int flag);
158
165void view2d_curRect_changed(const bContext *C, View2D *v2d);
166
167void view2d_totRect_set(View2D *v2d, int width, int height);
168
169void view2d_mask_from_win(const View2D *v2d, rcti *r_mask);
170
172
177void view2d_curRect_clamp_y(View2D *v2d);
178
180
181/* -------------------------------------------------------------------- */
184
188void view2d_view_ortho(const View2D *v2d);
195void view2d_view_orthoSpecial(ARegion *region, View2D *v2d, bool xaxis);
199void view2d_view_restore(const bContext *C);
200
202
203/* -------------------------------------------------------------------- */
206
211 const View2D *v2d, int colorid, float step, int level_size, int totlevels);
220void view2d_dot_grid_draw(const View2D *v2d,
221 int grid_color_id,
222 float min_step,
223 int grid_subdivisions);
224
231void view2d_draw_lines_y(const View2D *v2d, bool show_fractions, int base);
241void view2d_draw_lines_x(const View2D *v2d,
242 const Scene *scene,
243 bool display_seconds,
244 bool show_fractions,
245 bool draw_minor_lines,
246 int base);
250void view2d_draw_lines_x_frames(const View2D *v2d,
251 const Scene *scene,
252 bool display_seconds,
253 bool show_fractions,
254 bool draw_minor_lines);
255
256float view2d_grid_resolution_x(const View2D *v2d, const Scene *scene, bool display_seconds);
257float view2d_grid_resolution_y__values(const View2D *v2d, int base);
258
263 const ARegion *region, const View2D *v2d, const rcti *rect, int colorid, int base);
274void view2d_draw_scale_x(const ARegion *region,
275 const View2D *v2d,
276 const rcti *rect,
277 const Scene *scene,
278 bool display_seconds,
279 bool show_fractions,
280 int colorid,
281 int base);
282
284
285/* -------------------------------------------------------------------- */
288
292void view2d_scrollers_draw(View2D *v2d, const rcti *mask_custom);
293
295
296/* -------------------------------------------------------------------- */
299
312void view2d_listview_view_to_cell(float columnwidth,
313 float rowheight,
314 float startx,
315 float starty,
316 float viewx,
317 float viewy,
318 int *r_column,
319 int *r_row);
320
322
323/* -------------------------------------------------------------------- */
326
327float view2d_region_to_view_x(const View2D *v2d, float x);
328float view2d_region_to_view_y(const View2D *v2d, float y);
335void view2d_region_to_view(const View2D *v2d, float x, float y, float *r_view_x, float *r_view_y)
336 ATTR_NONNULL();
337void view2d_region_to_view_rctf(const View2D *v2d, const rctf *rect_src, rctf *rect_dst)
338 ATTR_NONNULL();
339
340float view2d_view_to_region_x(const View2D *v2d, float x);
341float view2d_view_to_region_y(const View2D *v2d, float y);
350 const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
351
352bool view2d_view_to_region_segment_clip(const View2D *v2d,
353 const float xy_a[2],
354 const float xy_b[2],
355 int r_region_a[2],
356 int r_region_b[2]) ATTR_NONNULL();
357
366void view2d_view_to_region(const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y)
367 ATTR_NONNULL();
369 const View2D *v2d, float x, float y, float *r_region_x, float *r_region_y) ATTR_NONNULL();
370void view2d_view_to_region_m4(const View2D *v2d, float matrix[4][4]) ATTR_NONNULL();
371void view2d_view_to_region_rcti(const View2D *v2d, const rctf *rect_src, rcti *rect_dst)
372 ATTR_NONNULL();
373bool view2d_view_to_region_rcti_clip(const View2D *v2d, const rctf *rect_src, rcti *rect_dst)
374 ATTR_NONNULL();
375
377
378/* -------------------------------------------------------------------- */
381
385View2D *view2d_fromcontext(const bContext *C);
390View2D *view2d_fromcontext_rwin(const bContext *C);
391
398void view2d_scroller_size_get(const View2D *v2d, bool mapped, float *r_x, float *r_y);
407void view2d_scale_get(const View2D *v2d, float *r_x, float *r_y);
408float view2d_scale_get_x(const View2D *v2d);
409float view2d_scale_get_y(const View2D *v2d);
413void view2d_pixel_size_get(const View2D *v2d, float *r_x, float *r_y);
414float view2d_pixel_size_get_x(const View2D *v2d);
415float view2d_pixel_size_get_y(const View2D *v2d);
416
421void view2d_center_get(const View2D *v2d, float *r_x, float *r_y);
422void view2d_center_set(View2D *v2d, float x, float y);
423void view2d_size_x_set(View2D *v2d, float size_x);
424
431void view2d_offset(View2D *v2d, float xfac, float yfac);
432
437
449char view2d_mouse_in_scrollers_ex(const ARegion *region,
450 const View2D *v2d,
451 const int xy[2],
452 int *r_scroll) ATTR_NONNULL(1, 2, 3, 4);
453char view2d_mouse_in_scrollers(const ARegion *region, const View2D *v2d, const int xy[2])
454 ATTR_NONNULL(1, 2, 3);
455char view2d_rect_in_scrollers_ex(const ARegion *region,
456 const View2D *v2d,
457 const rcti *rect,
458 int *r_scroll) ATTR_NONNULL(1, 2, 3);
459char view2d_rect_in_scrollers(const ARegion *region, const View2D *v2d, const rcti *rect)
460 ATTR_NONNULL(1, 2, 3);
461
466 View2D *v2d, float x, float y, const char *str, size_t str_len, const unsigned char col[4]);
470void view2d_text_cache_add_rectf(View2D *v2d,
471 const rctf *rect_view,
472 const char *str,
473 size_t str_len,
474 const unsigned char col[4]);
475void view2d_text_cache_draw(ARegion *region);
476
478
479/* -------------------------------------------------------------------- */
482
484void ED_keymap_view2d(wmKeyConfig *keyconf);
485
490void view2d_smooth_view(const bContext *C, ARegion *region, const rctf *cur, int smooth_viewtx);
491
492#define UI_MARKER_MARGIN_Y (34 * UI_SCALE_FAC)
493#define UI_TIME_SCRUB_MARGIN_Y (23 * UI_SCALE_FAC)
494#define UI_TIME_CACHE_MARGIN_Y (UI_TIME_SCRUB_MARGIN_Y / 6.0f)
495#define UI_ANIM_MINY (HEADERY * UI_SCALE_FAC * 1.1f)
496#define UI_MARKERS_MINY (HEADERY * UI_SCALE_FAC * 2.0f)
497
499
500/* -------------------------------------------------------------------- */
503
504/* `view2d_gizmo_navigate.cc` */
505
509void VIEW2D_GGT_navigate_impl(wmGizmoGroupType *gzgt, const char *idname);
510
512
513/* -------------------------------------------------------------------- */
516
567
572
575 float inside_pad,
576 float outside_pad,
577 float speed_ramp,
578 float max_speed,
579 float delay,
580 float zoom_influence);
581
586 View2DEdgePanData *vpd, float xmin, float xmax, float ymin, float ymax);
587
589
593void view2d_edge_pan_apply(bContext *C, View2DEdgePanData *vpd, const int xy[2])
594 ATTR_NONNULL(1, 2, 3);
595
600
602
604
606 float inside_pad,
607 float outside_pad,
608 float speed_ramp,
609 float max_speed,
610 float delay,
611 float zoom_influence);
612
617
619
620} // namespace ui
621} // namespace blender
#define ATTR_NONNULL(...)
#define C
Definition RandGen.cpp:29
Definition scene.h:133
#define str(s)
VecBase< float, D > step(VecOp< float, D >, VecOp< float, D >) RET
char char char char void view2d_text_cache_add(View2D *v2d, float x, float y, const char *str, size_t str_len, const unsigned char col[4])
Definition view2d.cc:2079
void view2d_view_to_region_fl(const View2D *v2d, float x, float y, float *r_region_x, float *r_region_y) ATTR_NONNULL()
Definition view2d.cc:1720
void view2d_view_ortho(const View2D *v2d)
Definition view2d.cc:1080
void view2d_draw_scale_x(const ARegion *region, const View2D *v2d, const rcti *rect, const Scene *scene, bool display_seconds, bool show_fractions, int colorid, int base)
void view2d_totRect_set(View2D *v2d, int width, int height)
Definition view2d.cc:1021
void view2d_curRect_validate(View2D *v2d)
Definition view2d.cc:810
void view2d_offset_y_snap_to_closest_page(View2D *v2d)
Definition view2d.cc:1977
float view2d_pixel_size_get_y(const View2D *v2d)
Definition view2d.cc:1924
void ED_keymap_view2d(wmKeyConfig *keyconf)
float view2d_grid_resolution_y__values(const View2D *v2d, int base)
void view2d_view_restore(const bContext *C)
Definition view2d.cc:1147
void view2d_region_reinit(View2D *v2d, short type, int winx, int winy)
Definition view2d.cc:223
void view2d_draw_lines_x(const View2D *v2d, const Scene *scene, bool display_seconds, bool show_fractions, bool draw_minor_lines, int base)
void view2d_edge_pan_apply(bContext *C, View2DEdgePanData *vpd, const int xy[2]) ATTR_NONNULL(1
bool view2d_view_to_region_rcti_clip(const View2D *v2d, const rctf *rect_src, rcti *rect_dst) ATTR_NONNULL()
Definition view2d.cc:1797
float view2d_view_to_region_y(const View2D *v2d, float y)
Definition view2d.cc:1678
void view2d_edge_pan_operator_properties_ex(wmOperatorType *ot, float inside_pad, float outside_pad, float speed_ramp, float max_speed, float delay, float zoom_influence)
void view2d_mask_from_win(const View2D *v2d, rcti *r_mask)
Definition view2d.cc:111
void view2d_view_to_region_rcti(const View2D *v2d, const rctf *rect_src, rcti *rect_dst) ATTR_NONNULL()
Definition view2d.cc:1767
void view2d_text_cache_draw(ARegion *region)
Definition view2d.cc:2139
char char view2d_mouse_in_scrollers(const ARegion *region, const View2D *v2d, const int xy[2]) ATTR_NONNULL(1
Definition view2d.cc:2044
void view2d_view_to_region(const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL()
Definition view2d.cc:1705
void view2d_edge_pan_operator_init(bContext *C, View2DEdgePanData *vpd, wmOperator *op)
void view2d_center_set(View2D *v2d, float x, float y)
Definition view2d.cc:1939
void view2d_curRect_reset(View2D *v2d)
Definition view2d.cc:913
void view2d_draw_lines_y(const View2D *v2d, bool show_fractions, int base)
bool view2d_view_to_region_segment_clip(const View2D *v2d, const float xy_a[2], const float xy_b[2], int r_region_a[2], int r_region_b[2]) ATTR_NONNULL()
Definition view2d.cc:1732
void view2d_scrollers_draw(View2D *v2d, const rcti *mask_custom)
Definition view2d.cc:1487
View2D * view2d_fromcontext_rwin(const bContext *C)
Definition view2d.cc:1850
float view2d_scale_get_y(const View2D *v2d)
Definition view2d.cc:1906
void ED_operatortypes_view2d()
void view2d_region_to_view(const View2D *v2d, float x, float y, float *r_view_x, float *r_view_y) ATTR_NONNULL()
Definition view2d.cc:1651
void view2d_edge_pan_cancel(bContext *C, View2DEdgePanData *vpd)
void view2d_pixel_size_get(const View2D *v2d, float *r_x, float *r_y)
Definition view2d.cc:1911
void view2d_scroller_size_get(const View2D *v2d, bool mapped, float *r_x, float *r_y)
Definition view2d.cc:1868
void view2d_dot_grid_draw(const View2D *v2d, int grid_color_id, float min_step, int grid_subdivisions)
Definition view2d.cc:1271
float view2d_grid_resolution_x(const View2D *v2d, const Scene *scene, bool display_seconds)
bool view2d_view_to_region_clip(const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL()
Definition view2d.cc:1684
void view2d_smooth_view(const bContext *C, ARegion *region, const rctf *cur, int smooth_viewtx)
void view2d_text_cache_add_rectf(View2D *v2d, const rctf *rect_view, const char *str, size_t str_len, const unsigned char col[4])
Definition view2d.cc:2109
float view2d_region_to_view_x(const View2D *v2d, float x)
Definition view2d.cc:1640
void view2d_edge_pan_reset(View2DEdgePanData *vpd)
float view2d_region_to_view_y(const View2D *v2d, float y)
Definition view2d.cc:1645
void view2d_listview_view_to_cell(float columnwidth, float rowheight, float startx, float starty, float viewx, float viewy, int *r_column, int *r_row)
Definition view2d.cc:1604
float view2d_pixel_size_get_x(const View2D *v2d)
Definition view2d.cc:1920
void view2d_center_get(const View2D *v2d, float *r_x, float *r_y)
Definition view2d.cc:1929
void view2d_curRect_clamp_y(View2D *v2d)
Definition view2d.cc:829
char view2d_mouse_in_scrollers_ex(const ARegion *region, const View2D *v2d, const int xy[2], int *r_scroll) ATTR_NONNULL(1
Definition view2d.cc:1988
void view2d_sync(bScreen *screen, ScrArea *area, View2D *v2dcur, int flag)
Definition view2d.cc:850
float view2d_scale_get_x(const View2D *v2d)
Definition view2d.cc:1902
void VIEW2D_GGT_navigate_impl(wmGizmoGroupType *gzgt, const char *idname)
void view2d_curRect_changed(const bContext *C, View2D *v2d)
Definition view2d.cc:815
void view2d_region_to_view_rctf(const View2D *v2d, const rctf *rect_src, rctf *rect_dst) ATTR_NONNULL()
Definition view2d.cc:1657
void view2d_draw_scale_y(const ARegion *region, const View2D *v2d, const rcti *rect, int colorid, int base)
void view2d_view_to_region_m4(const View2D *v2d, float matrix[4][4]) ATTR_NONNULL()
Definition view2d.cc:1789
void view2d_edge_pan_set_limits(View2DEdgePanData *vpd, float xmin, float xmax, float ymin, float ymax)
void view2d_edge_pan_init(bContext *C, View2DEdgePanData *vpd, float inside_pad, float outside_pad, float speed_ramp, float max_speed, float delay, float zoom_influence)
eView2D_CommonViewTypes
Definition UI_view2d.hh:54
@ V2D_COMMONVIEW_LIST
Definition UI_view2d.hh:60
@ V2D_COMMONVIEW_STANDARD
Definition UI_view2d.hh:58
@ V2D_COMMONVIEW_CUSTOM
Definition UI_view2d.hh:56
@ V2D_COMMONVIEW_STACK
Definition UI_view2d.hh:62
@ V2D_COMMONVIEW_HEADER
Definition UI_view2d.hh:64
@ V2D_COMMONVIEW_PANELS_UI
Definition UI_view2d.hh:66
View2D * view2d_fromcontext(const bContext *C)
Definition view2d.cc:1836
void void view2d_edge_pan_apply_event(bContext *C, View2DEdgePanData *vpd, const wmEvent *event)
char char char view2d_rect_in_scrollers_ex(const ARegion *region, const View2D *v2d, const rcti *rect, int *r_scroll) ATTR_NONNULL(1
Definition view2d.cc:2017
char char char char view2d_rect_in_scrollers(const ARegion *region, const View2D *v2d, const rcti *rect) ATTR_NONNULL(1
Definition view2d.cc:2050
void view2d_multi_grid_draw(const View2D *v2d, int colorid, float step, int level_size, int totlevels)
Definition view2d.cc:1165
void view2d_draw_lines_x_frames(const View2D *v2d, const Scene *scene, bool display_seconds, bool show_fractions, bool draw_minor_lines)
void view2d_scale_get(const View2D *v2d, float *r_x, float *r_y)
Definition view2d.cc:1893
bool view2d_area_supports_sync(ScrArea *area)
Definition view2d.cc:845
void view2d_view_orthoSpecial(ARegion *region, View2D *v2d, bool xaxis)
Definition view2d.cc:1121
void view2d_size_x_set(View2D *v2d, float size_x)
Definition view2d.cc:1947
void view2d_edge_pan_operator_properties(wmOperatorType *ot)
void view2d_zoom_cache_reset()
Definition view2d.cc:1026
bool view2d_edge_pan_poll(bContext *C)
void view2d_offset(View2D *v2d, float xfac, float yfac)
Definition view2d.cc:1954
float view2d_view_to_region_x(const View2D *v2d, float x)
Definition view2d.cc:1673
BMesh Iterators.
void ATTR_NONNULL(1, 2)