UI_view2d.hh

Go to the documentation of this file.

/* SPDX-FileCopyrightText: 2008 Blender Authors
 *
 * SPDX-License-Identifier: GPL-2.0-or-later */

 
#pragma once
 
#include "BLI_compiler_attrs.h"
#include "BLI_rect.h"
 
/* -------------------------------------------------------------------- */

#define V2D_IS_CLIPPED 12000

enum eView2D_CommonViewTypes {
  V2D_COMMONVIEW_CUSTOM = -1,
  V2D_COMMONVIEW_STANDARD,
  V2D_COMMONVIEW_LIST,
  V2D_COMMONVIEW_STACK,
  V2D_COMMONVIEW_HEADER,
  V2D_COMMONVIEW_PANELS_UI,
};

 
/* -------------------------------------------------------------------- */

 
/* Maximum has to include outline which varies with line width. */
#define V2D_SCROLL_HEIGHT ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))
#define V2D_SCROLL_WIDTH ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))
 
/* Alpha of scroll-bar when at minimum size. */
#define V2D_SCROLL_MIN_ALPHA (0.4f)
 
/* Minimum size needs to include outline which varies with line width. */
#define V2D_SCROLL_MIN_WIDTH ((5.0f * UI_SCALE_FAC) + (2.0f * U.pixelsize))
 
/* When to start showing the full-width scroller. */
#define V2D_SCROLL_HIDE_WIDTH (AREAMINX * UI_SCALE_FAC)
#define V2D_SCROLL_HIDE_HEIGHT (HEADERY * UI_SCALE_FAC)

#define V2D_SCROLL_HANDLE_HEIGHT (0.6f * U.widget_unit)
#define V2D_SCROLL_HANDLE_WIDTH (0.6f * U.widget_unit)

#define V2D_SCROLL_HANDLE_SIZE_HOTSPOT (0.6f * U.widget_unit)

#define V2D_SCROLL_THUMB_SIZE_MIN (30.0 * UI_SCALE_FAC)

 
/* -------------------------------------------------------------------- */
 
/* means copy it from another v2d */
#define V2D_LOCK_SET 0
/* means copy it to the other v2ds */
#define V2D_LOCK_COPY 1

 
/* -------------------------------------------------------------------- */
 
/* Test if mouse in a scroll-bar (assume that scroller availability has been tested). */
#define IN_2D_VERT_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->vert, co))
#define IN_2D_HORIZ_SCROLL(v2d, co) (BLI_rcti_isect_pt_v(&v2d->hor, co))
 
#define IN_2D_VERT_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->vert, rct, NULL))
#define IN_2D_HORIZ_SCROLL_RECT(v2d, rct) (BLI_rcti_isect(&v2d->hor, rct, NULL))

 
/* -------------------------------------------------------------------- */
 
struct View2D;
 
struct ARegion;
struct Scene;
struct ScrArea;
struct bContext;
struct bScreen;
struct rctf;
struct rcti;
struct wmEvent;
struct wmGizmoGroupType;
struct wmKeyConfig;
struct wmOperator;
struct wmOperatorType;

 
/* -------------------------------------------------------------------- */

void UI_view2d_region_reinit(View2D *v2d, short type, int winx, int winy);
 
void UI_view2d_curRect_validate(View2D *v2d);
void UI_view2d_curRect_reset(View2D *v2d);
bool UI_view2d_area_supports_sync(ScrArea *area);
void UI_view2d_sync(bScreen *screen, ScrArea *area, View2D *v2dcur, int flag);

void UI_view2d_curRect_changed(const bContext *C, View2D *v2d);
 
void UI_view2d_totRect_set(View2D *v2d, int width, int height);
 
void UI_view2d_mask_from_win(const View2D *v2d, rcti *r_mask);
 
void UI_view2d_zoom_cache_reset();

void UI_view2d_curRect_clamp_y(View2D *v2d);

 
/* -------------------------------------------------------------------- */

void UI_view2d_view_ortho(const View2D *v2d);
void UI_view2d_view_orthoSpecial(ARegion *region, View2D *v2d, bool xaxis);
void UI_view2d_view_restore(const bContext *C);

 
/* -------------------------------------------------------------------- */

void UI_view2d_multi_grid_draw(
    const View2D *v2d, int colorid, float step, int level_size, int totlevels);
void UI_view2d_dot_grid_draw(const View2D *v2d,
                             int grid_color_id,
                             float min_step,
                             int grid_subdivisions);
 
void UI_view2d_draw_lines_y__values(const View2D *v2d);
void UI_view2d_draw_lines_x__values(const View2D *v2d);
void UI_view2d_draw_lines_x__discrete_values(const View2D *v2d, bool display_minor_lines);
void UI_view2d_draw_lines_x__discrete_time(const View2D *v2d,
                                           const Scene *scene,
                                           bool display_minor_lines);
void UI_view2d_draw_lines_x__discrete_frames_or_seconds(const View2D *v2d,
                                                        const Scene *scene,
                                                        bool display_seconds,
                                                        bool display_minor_lines);
void UI_view2d_draw_lines_x__frames_or_seconds(const View2D *v2d,
                                               const Scene *scene,
                                               bool display_seconds);
 
float UI_view2d_grid_resolution_x__frames_or_seconds(const View2D *v2d,
                                                     const Scene *scene,
                                                     bool display_seconds);
float UI_view2d_grid_resolution_y__values(const View2D *v2d);

void UI_view2d_draw_scale_y__values(const ARegion *region,
                                    const View2D *v2d,
                                    const rcti *rect,
                                    int colorid);
void UI_view2d_draw_scale_y__block(const ARegion *region,
                                   const View2D *v2d,
                                   const rcti *rect,
                                   int colorid);
void UI_view2d_draw_scale_x__discrete_frames_or_seconds(const ARegion *region,
                                                        const View2D *v2d,
                                                        const rcti *rect,
                                                        const Scene *scene,
                                                        bool display_seconds,
                                                        int colorid);
void UI_view2d_draw_scale_x__frames_or_seconds(const ARegion *region,
                                               const View2D *v2d,
                                               const rcti *rect,
                                               const Scene *scene,
                                               bool display_seconds,
                                               int colorid);

 
/* -------------------------------------------------------------------- */

void UI_view2d_scrollers_draw(View2D *v2d, const rcti *mask_custom);

 
/* -------------------------------------------------------------------- */

void UI_view2d_listview_view_to_cell(float columnwidth,
                                     float rowheight,
                                     float startx,
                                     float starty,
                                     float viewx,
                                     float viewy,
                                     int *r_column,
                                     int *r_row);

 
/* -------------------------------------------------------------------- */
 
float UI_view2d_region_to_view_x(const View2D *v2d, float x);
float UI_view2d_region_to_view_y(const View2D *v2d, float y);
void UI_view2d_region_to_view(
    const View2D *v2d, float x, float y, float *r_view_x, float *r_view_y) ATTR_NONNULL();
void UI_view2d_region_to_view_rctf(const View2D *v2d, const rctf *rect_src, rctf *rect_dst)
    ATTR_NONNULL();
 
float UI_view2d_view_to_region_x(const View2D *v2d, float x);
float UI_view2d_view_to_region_y(const View2D *v2d, float y);
bool UI_view2d_view_to_region_clip(
    const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
 
bool UI_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();

void UI_view2d_view_to_region(
    const View2D *v2d, float x, float y, int *r_region_x, int *r_region_y) ATTR_NONNULL();
void UI_view2d_view_to_region_fl(
    const View2D *v2d, float x, float y, float *r_region_x, float *r_region_y) ATTR_NONNULL();
void UI_view2d_view_to_region_m4(const View2D *v2d, float matrix[4][4]) ATTR_NONNULL();
void UI_view2d_view_to_region_rcti(const View2D *v2d, const rctf *rect_src, rcti *rect_dst)
    ATTR_NONNULL();
bool UI_view2d_view_to_region_rcti_clip(const View2D *v2d, const rctf *rect_src, rcti *rect_dst)
    ATTR_NONNULL();

 
/* -------------------------------------------------------------------- */

View2D *UI_view2d_fromcontext(const bContext *C);
View2D *UI_view2d_fromcontext_rwin(const bContext *C);

void UI_view2d_scroller_size_get(const View2D *v2d, bool mapped, float *r_x, float *r_y);
void UI_view2d_scale_get(const View2D *v2d, float *r_x, float *r_y);
float UI_view2d_scale_get_x(const View2D *v2d);
float UI_view2d_scale_get_y(const View2D *v2d);
void UI_view2d_scale_get_inverse(const View2D *v2d, float *r_x, float *r_y);

void UI_view2d_center_get(const View2D *v2d, float *r_x, float *r_y);
void UI_view2d_center_set(View2D *v2d, float x, float y);

void UI_view2d_offset(View2D *v2d, float xfac, float yfac);

void UI_view2d_offset_y_snap_to_closest_page(View2D *v2d);

char UI_view2d_mouse_in_scrollers_ex(const ARegion *region,
                                     const View2D *v2d,
                                     const int xy[2],
                                     int *r_scroll) ATTR_NONNULL(1, 2, 3, 4);
char UI_view2d_mouse_in_scrollers(const ARegion *region, const View2D *v2d, const int xy[2])
    ATTR_NONNULL(1, 2, 3);
char UI_view2d_rect_in_scrollers_ex(const ARegion *region,
                                    const View2D *v2d,
                                    const rcti *rect,
                                    int *r_scroll) ATTR_NONNULL(1, 2, 3);
char UI_view2d_rect_in_scrollers(const ARegion *region, const View2D *v2d, const rcti *rect)
    ATTR_NONNULL(1, 2, 3);

void UI_view2d_text_cache_add(
    View2D *v2d, float x, float y, const char *str, size_t str_len, const unsigned char col[4]);
void UI_view2d_text_cache_add_rectf(View2D *v2d,
                                    const rctf *rect_view,
                                    const char *str,
                                    size_t str_len,
                                    const unsigned char col[4]);
void UI_view2d_text_cache_draw(ARegion *region);

 
/* -------------------------------------------------------------------- */
 
void ED_operatortypes_view2d();
void ED_keymap_view2d(wmKeyConfig *keyconf);

void UI_view2d_smooth_view(const bContext *C, ARegion *region, const rctf *cur, int smooth_viewtx);
 
#define UI_MARKER_MARGIN_Y (42 * UI_SCALE_FAC)
#define UI_TIME_SCRUB_MARGIN_Y (23 * UI_SCALE_FAC)
#define UI_TIME_CACHE_MARGIN_Y (UI_TIME_SCRUB_MARGIN_Y / 6.0f)
#define UI_ANIM_MINY (HEADERY * UI_SCALE_FAC * 1.1f)
#define UI_MARKERS_MINY (HEADERY * UI_SCALE_FAC * 2.0f)

 
/* -------------------------------------------------------------------- */
 
/* `view2d_gizmo_navigate.cc` */

void VIEW2D_GGT_navigate_impl(wmGizmoGroupType *gzgt, const char *idname);

 
/* -------------------------------------------------------------------- */

struct View2DEdgePanData {
  bScreen *screen;
  ScrArea *area;
  ARegion *region;
  View2D *v2d;
  struct rctf limit;

  bool enabled;
  float inside_pad;
  float outside_pad;
  float speed_ramp;
  float max_speed;
  float delay;
  float zoom_influence;

  rctf initial_rect;

  float facx, facy;
 
  /* Timers. */
  double edge_pan_last_time;
  double edge_pan_start_time_x, edge_pan_start_time_y;
};
 
void UI_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);

void UI_view2d_edge_pan_set_limits(
    View2DEdgePanData *vpd, float xmin, float xmax, float ymin, float ymax);
 
void UI_view2d_edge_pan_reset(View2DEdgePanData *vpd);

void UI_view2d_edge_pan_apply(bContext *C, View2DEdgePanData *vpd, const int xy[2])
    ATTR_NONNULL(1, 2, 3);

void UI_view2d_edge_pan_apply_event(bContext *C, View2DEdgePanData *vpd, const wmEvent *event);
 
void UI_view2d_edge_pan_cancel(bContext *C, View2DEdgePanData *vpd);
 
void UI_view2d_edge_pan_operator_properties(wmOperatorType *ot);
 
void UI_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 UI_view2d_edge_pan_operator_init(bContext *C, View2DEdgePanData *vpd, wmOperator *op);