#include "BLI_compiler_attrs.h"
#include "BLI_rect.h"

Classes
struct	View2DEdgePanData

Macros
Defines for Scroll Bars
#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))

#define	V2D_SCROLL_MIN_ALPHA (0.4f)

#define	V2D_SCROLL_MIN_WIDTH ((5.0f * UI_SCALE_FAC) + (2.0f * U.pixelsize))

#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)

Define for #UI_view2d_sync
#define	V2D_LOCK_SET 0

#define	V2D_LOCK_COPY 1

Macros
#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))

Functions
Prototypes
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)

View Matrix Operations
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)

Grid Drawing
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)

Scroll-bar Drawing
void	UI_view2d_scrollers_draw_ex (View2D v2d, const rcti mask_custom, bool use_full_hide)

void	UI_view2d_scrollers_draw (View2D v2d, const rcti mask_custom)

List View Tools
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)

Coordinate Conversion
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()

Utilities
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

char char	UI_view2d_mouse_in_scrollers (const ARegion region, const View2D v2d, const int xy[2]) ATTR_NONNULL(1

char char char	UI_view2d_rect_in_scrollers_ex (const ARegion region, const View2D v2d, const rcti rect, int r_scroll) ATTR_NONNULL(1

char char char char	UI_view2d_rect_in_scrollers (const ARegion region, const View2D v2d, const rcti *rect) ATTR_NONNULL(1

char char char char 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)

Gizmo Types
void	VIEW2D_GGT_navigate_impl (wmGizmoGroupType gzgt, const char idname)

Edge Pan
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

void 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)

General Defines
#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 }

Operators
#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)

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)

Detailed Description

Generic 2D view with should allow drawing grids, panning, zooming, scrolling, .. etc.

Definition in file UI_view2d.hh.

Macro Definition Documentation

◆ IN_2D_HORIZ_SCROLL

#define IN_2D_HORIZ_SCROLL	(		v2d,
			co ) (BLI_rcti_isect_pt_v(&v2d->hor, co))

Definition at line 95 of file UI_view2d.hh.

Referenced by UI_view2d_mouse_in_scrollers_ex().

◆ IN_2D_HORIZ_SCROLL_RECT

#define IN_2D_HORIZ_SCROLL_RECT	(		v2d,
			rct ) (BLI_rcti_isect(&v2d->hor, rct, NULL))

Definition at line 98 of file UI_view2d.hh.

Referenced by UI_view2d_rect_in_scrollers_ex().

◆ IN_2D_VERT_SCROLL

#define IN_2D_VERT_SCROLL	(		v2d,
			co ) (BLI_rcti_isect_pt_v(&v2d->vert, co))

Definition at line 94 of file UI_view2d.hh.

Referenced by UI_view2d_mouse_in_scrollers_ex().

◆ IN_2D_VERT_SCROLL_RECT

#define IN_2D_VERT_SCROLL_RECT	(		v2d,
			rct ) (BLI_rcti_isect(&v2d->vert, rct, NULL))

Definition at line 97 of file UI_view2d.hh.

Referenced by UI_view2d_rect_in_scrollers_ex().

◆ UI_MARKER_MARGIN_Y

#define UI_MARKER_MARGIN_Y (42 * UI_SCALE_FAC)

Definition at line 471 of file UI_view2d.hh.

Referenced by add_region_padding(), event_in_markers_region(), get_marker_region_rect(), graphkeys_viewall(), nla_track_region_draw(), SEQ_get_timeline_region_padding(), sequencer_main_clamp_view(), and set_v2d_height().

◆ UI_TIME_CACHE_MARGIN_Y

#define UI_TIME_CACHE_MARGIN_Y (UI_TIME_SCRUB_MARGIN_Y / 6.0f)

Definition at line 473 of file UI_view2d.hh.

Referenced by draw_cache_background(), draw_cache_view_iter_fn(), and SEQ_get_timeline_region_padding().

◆ UI_TIME_SCRUB_MARGIN_Y

#define UI_TIME_SCRUB_MARGIN_Y (23 * UI_SCALE_FAC)

Definition at line 472 of file UI_view2d.hh.

Referenced by add_region_padding(), ANIM_UI_get_first_channel_top(), draw_cache_background(), draw_cache_view_iter_fn(), ED_time_scrub_channel_search_draw(), ED_time_scrub_clamp_scroller_mask(), ED_time_scrub_event_in_region(), ED_time_scrub_region_rect_get(), graph_main_region_draw_overlay(), graph_region_draw(), graphkeys_viewall(), SEQ_get_timeline_region_padding(), and sequencer_main_cursor().

◆ V2D_IS_CLIPPED

#define V2D_IS_CLIPPED 12000

Generic value to use when coordinate lies out of view when converting.

Definition at line 21 of file UI_view2d.hh.

Referenced by annotation_stroke_eraser_dostroke(), do_lasso_select_marker(), do_lasso_select_mesh_uv_is_edge_inside(), do_lasso_select_mesh_uv_is_point_inside(), gpencil_point_to_xy(), blender::io::grease_pencil::GreasePencilExporter::project_to_screen(), UI_view2d_view_to_region_clip(), UI_view2d_view_to_region_rcti_clip(), and UI_view2d_view_to_region_segment_clip().

◆ V2D_LOCK_COPY

#define V2D_LOCK_COPY 1

Definition at line 85 of file UI_view2d.hh.

Referenced by actkeys_viewall(), clip_draw_dopesheet_channels(), draw_channel_names(), draw_nla_track_list(), edge_pan_apply_delta(), nlaedit_viewall(), reset_exec(), scene_range_frame_exec(), scroller_activate_apply(), sequencer_view_all_preview_exec(), UI_view2d_edge_pan_cancel(), UI_view2d_smooth_view(), UI_view2d_sync(), view2d_smoothview_invoke(), view_pan_apply_ex(), view_zoomdrag_apply(), and view_zoomstep_apply_ex().

◆ V2D_LOCK_SET

#define V2D_LOCK_SET 0

Definition at line 83 of file UI_view2d.hh.

◆ V2D_SCROLL_HANDLE_HEIGHT

#define V2D_SCROLL_HANDLE_HEIGHT (0.6f * U.widget_unit)

Scroll bars with 'handles' used for scale (zoom).

Definition at line 67 of file UI_view2d.hh.

Referenced by add_region_padding(), graphkeys_viewall(), SEQ_get_timeline_region_padding(), timeline_cache_draw_geometry_nodes(), timeline_cache_draw_single(), and UI_view2d_scroller_size_get().

◆ V2D_SCROLL_HANDLE_SIZE_HOTSPOT

#define V2D_SCROLL_HANDLE_SIZE_HOTSPOT (0.6f * U.widget_unit)

Scroll bar with 'handles' hot-spot radius for cursor proximity.

Definition at line 71 of file UI_view2d.hh.

Referenced by mouse_in_scroller_handle(), UI_view2d_scrollers_draw_ex(), and view2d_scrollers_calc().

◆ V2D_SCROLL_HANDLE_WIDTH

#define V2D_SCROLL_HANDLE_WIDTH (0.6f * U.widget_unit)

Definition at line 68 of file UI_view2d.hh.

Referenced by UI_view2d_scroller_size_get().

◆ V2D_SCROLL_HEIGHT

#define V2D_SCROLL_HEIGHT ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))

Scroll bar area.

Definition at line 53 of file UI_view2d.hh.

Referenced by ED_fileselect_init_layout(), blender::ed::outliner::outliner_update_viewable_area(), and UI_view2d_scroller_size_get().

◆ V2D_SCROLL_HIDE_HEIGHT

#define V2D_SCROLL_HIDE_HEIGHT (HEADERY * UI_SCALE_FAC)

Definition at line 64 of file UI_view2d.hh.

Referenced by area_actionzone_get_rect(), and area_actionzone_refresh_xy().

◆ V2D_SCROLL_HIDE_WIDTH

#define V2D_SCROLL_HIDE_WIDTH (AREAMINX * UI_SCALE_FAC)

Definition at line 63 of file UI_view2d.hh.

Referenced by area_actionzone_get_rect(), and area_actionzone_refresh_xy().

◆ V2D_SCROLL_MIN_ALPHA

#define V2D_SCROLL_MIN_ALPHA (0.4f)

Definition at line 57 of file UI_view2d.hh.

Referenced by UI_view2d_scrollers_draw_ex().

◆ V2D_SCROLL_MIN_WIDTH

#define V2D_SCROLL_MIN_WIDTH ((5.0f * UI_SCALE_FAC) + (2.0f * U.pixelsize))

Definition at line 60 of file UI_view2d.hh.

Referenced by UI_view2d_scroller_size_get().

◆ V2D_SCROLL_THUMB_SIZE_MIN

#define V2D_SCROLL_THUMB_SIZE_MIN (30.0 * UI_SCALE_FAC)

Don't allow scroll thumb to show below this size (so it's never too small to click on).

Definition at line 74 of file UI_view2d.hh.

Referenced by view2d_scrollers_calc().

◆ V2D_SCROLL_WIDTH

#define V2D_SCROLL_WIDTH ((0.45f * U.widget_unit) + (2.0f * U.pixelsize))

Definition at line 54 of file UI_view2d.hh.

Referenced by ANIM_channel_draw(), blender::ui::TreeViewLayoutBuilder::build_from_tree(), console_textview_draw_rect_calc(), ED_spacetype_ipo(), graph_draw_channel_names(), info_textview_draw_rect_calc(), blender::ed::outliner::outliner_draw_restrictbuts(), blender::ed::outliner::outliner_right_columns_width(), blender::ed::spreadsheet::register_spacetype(), ui_template_list_layout_draw(), and UI_view2d_scroller_size_get().

Enumeration Type Documentation

◆ eView2D_CommonViewTypes

enum eView2D_CommonViewTypes

Common View2D view types.

Note: only define a type here if it completely sets all (+/- a few) of the relevant flags and settings for a View2D region, and that set of settings is used in more than one specific place.

Enumerator
V2D_COMMONVIEW_CUSTOM	custom view type (region has defined all necessary flags already).
V2D_COMMONVIEW_STANDARD	standard (only use this when setting up a new view, as a sensible base for most settings).
V2D_COMMONVIEW_LIST	List-view (i.e. Outliner).
V2D_COMMONVIEW_STACK	Stack-view (this is basically a list where new items are added at the top).
V2D_COMMONVIEW_HEADER	headers (this is basically the same as list-view, but no Y-panning).
V2D_COMMONVIEW_PANELS_UI	UI region containing panels.

Definition at line 29 of file UI_view2d.hh.

Function Documentation

◆ ED_keymap_view2d()

void ED_keymap_view2d ( wmKeyConfig * keyconf )

Definition at line 2361 of file view2d_ops.cc.

References RGN_TYPE_WINDOW, SPACE_EMPTY, and WM_keymap_ensure().

Referenced by ED_spacetypes_keymap().

◆ ED_operatortypes_view2d()

void ED_operatortypes_view2d ( )

Definition at line 2334 of file view2d_ops.cc.

References VIEW2D_OT_edge_pan(), VIEW2D_OT_pan(), VIEW2D_OT_reset(), VIEW2D_OT_scroll_down(), VIEW2D_OT_scroll_left(), VIEW2D_OT_scroll_right(), VIEW2D_OT_scroll_up(), VIEW2D_OT_scroller_activate(), VIEW2D_OT_smoothview(), VIEW2D_OT_zoom(), VIEW2D_OT_zoom_border(), VIEW2D_OT_zoom_in(), VIEW2D_OT_zoom_out(), and WM_operatortype_append().

Referenced by ED_spacetypes_init().

◆ UI_view2d_area_supports_sync()

bool UI_view2d_area_supports_sync ( ScrArea * area )

Definition at line 856 of file view2d.cc.

References ELEM, SPACE_ACTION, SPACE_CLIP, SPACE_GRAPH, SPACE_NLA, and SPACE_SEQ.

Referenced by UI_view2d_sync().

◆ UI_view2d_center_get()

void UI_view2d_center_get	(	const View2D *	v2d,
		float *	r_x,
		float *	r_y )

Simple functions for consistent center offset access. Used by node editor to shift view center for each individual node tree.

Definition at line 1934 of file view2d.cc.

References BLI_rctf_cent_x(), BLI_rctf_cent_y(), and View2D::cur.

Referenced by actkeys_viewall(), nlaedit_viewall(), and blender::ed::space_node::node_draw_space().

◆ UI_view2d_center_set()

void UI_view2d_center_set	(	View2D *	v2d,
		float	x,
		float	y )

Definition at line 1944 of file view2d.cc.

References BLI_rctf_recenter(), View2D::cur, and UI_view2d_curRect_validate().

Referenced by actkeys_viewall(), nlaedit_viewall(), blender::ed::space_node::node_area_listener(), and blender::ed::space_node::snode_setup_v2d().

◆ UI_view2d_curRect_changed()

void UI_view2d_curRect_changed	(	const bContext *	C,
		View2D *	v2d )

Perform all required updates after v2d->cur as been modified. This includes like validation view validation (UI_view2d_curRect_validate).

Current intent is to use it from user code, such as view navigation and zoom operations.

Definition at line 829 of file view2d.cc.

References CTX_wm_region(), and UI_view2d_curRect_validate().

Referenced by edge_pan_apply_delta(), reset_exec(), scroller_activate_apply(), sequencer_view_all_preview_exec(), sequencer_view_zoom_ratio_exec(), UI_but_ensure_in_view(), UI_view2d_edge_pan_cancel(), UI_view2d_smooth_view(), view2d_smoothview_invoke(), view_pan_apply_ex(), view_zoomdrag_apply(), and view_zoomstep_apply_ex().

◆ UI_view2d_curRect_clamp_y()

void UI_view2d_curRect_clamp_y ( View2D * v2d )

Clamp view2d area to what's visible, preventing scrolling vertically to infinity.

Definition at line 840 of file view2d.cc.

References BLI_rctf_size_y(), View2D::cur, View2D::tot, rctf::ymax, and rctf::ymin.

Referenced by nla_track_region_draw(), set_v2d_height(), and set_v2d_height().

◆ UI_view2d_curRect_reset()

void UI_view2d_curRect_reset ( View2D * v2d )

Restore 'cur' rect to standard orientation (i.e. optimal maximum view of tot). This does not take into account if zooming the view on an axis will improve the view (if allowed).

Definition at line 924 of file view2d.cc.

References View2D::align, BLI_rcti_size_x(), BLI_rcti_size_y(), View2D::cur, float, View2D::mask, V2D_ALIGN_NO_NEG_X, V2D_ALIGN_NO_NEG_Y, V2D_ALIGN_NO_POS_X, V2D_ALIGN_NO_POS_Y, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

◆ UI_view2d_curRect_validate()

void UI_view2d_curRect_validate ( View2D * v2d )

Definition at line 824 of file view2d.cc.

References ui_view2d_curRect_validate_resize().

Referenced by file_ensure_inside_viewbounds(), blender::ed::asset::shelf::region_layout(), region_scale_toggle_hidden(), sequencer_draw_preview(), UI_view2d_center_set(), UI_view2d_curRect_changed(), UI_view2d_offset(), and UI_view2d_offset_y_snap_to_closest_page().

◆ UI_view2d_dot_grid_draw()

void UI_view2d_dot_grid_draw	(	const View2D *	v2d,
		int	grid_color_id,
		float	min_step,
		int	grid_subdivisions )

Draw a multi-level grid of dots, with a dynamic number of levels based on the fading.

Parameters

grid_color_id	The theme color used for the points. Faded dynamically based on zoom.
min_step	The base size of the grid. At different zoom levels, the visible grid may have a larger step size.
grid_subdivisions	The maximum number of sub-levels drawn at once.

Definition at line 1283 of file view2d.cc.

References BLI_assert, BLI_rctf_size_x(), BLI_rcti_size_x(), ceilf, clamp_f(), View2D::cur, float, fractf(), GPU_COMP_F32, GPU_FETCH_FLOAT, GPU_PRIM_POINTS, GPU_program_point_size(), GPU_SHADER_2D_POINT_UNIFORM_SIZE_UNIFORM_COLOR_AA, GPU_vertformat_attr_add(), grid_axis_start_and_count(), immBegin(), immBindBuiltinProgram(), immEnd(), immUnbindProgram(), immUniform1f(), immUniform4fv(), immVertex2f(), immVertexFormat(), int, logf, View2D::mask, pos, pow2f(), powf, UI_GetThemeColor3fv(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by blender::ed::space_node::node_draw_space().

◆ UI_view2d_draw_lines_x__discrete_frames_or_seconds()

void UI_view2d_draw_lines_x__discrete_frames_or_seconds	(	const View2D *	v2d,
		const Scene *	scene,
		bool	display_seconds,
		bool	display_minor_lines )

Definition at line 495 of file view2d_draw.cc.

References UI_view2d_draw_lines_x__discrete_time(), and UI_view2d_draw_lines_x__discrete_values().

Referenced by action_main_region_draw(), dopesheet_region_draw(), draw_timeline_grid(), and nla_main_region_draw().

◆ UI_view2d_draw_lines_x__discrete_time()

void UI_view2d_draw_lines_x__discrete_time	(	const View2D *	v2d,
		const Scene *	scene,
		bool	display_minor_lines )

Definition at line 486 of file view2d_draw.cc.

References view2d_draw_lines(), and view2d_major_step_x__time().

Referenced by UI_view2d_draw_lines_x__discrete_frames_or_seconds(), and UI_view2d_draw_lines_x__frames_or_seconds().

◆ UI_view2d_draw_lines_x__discrete_values()

void UI_view2d_draw_lines_x__discrete_values	(	const View2D *	v2d,
		bool	display_minor_lines )

Definition at line 467 of file view2d_draw.cc.

References view2d_draw_lines(), and view2d_major_step_x__discrete().

Referenced by UI_view2d_draw_lines_x__discrete_frames_or_seconds().

◆ UI_view2d_draw_lines_x__frames_or_seconds()

void UI_view2d_draw_lines_x__frames_or_seconds	(	const View2D *	v2d,
		const Scene *	scene,
		bool	display_seconds )

Definition at line 508 of file view2d_draw.cc.

References UI_view2d_draw_lines_x__discrete_time(), and UI_view2d_draw_lines_x__values().

Referenced by graph_main_region_draw().

◆ UI_view2d_draw_lines_x__values()

void UI_view2d_draw_lines_x__values ( const View2D * v2d )

Definition at line 474 of file view2d_draw.cc.

References view2d_draw_lines(), and view2d_major_step_x__continuous().

Referenced by clip_draw_graph(), and UI_view2d_draw_lines_x__frames_or_seconds().

◆ UI_view2d_draw_lines_y__values()

void UI_view2d_draw_lines_y__values ( const View2D * v2d )

Definition at line 480 of file view2d_draw.cc.

References view2d_draw_lines(), and view2d_major_step_y__continuous().

Referenced by clip_draw_graph(), and graph_main_region_draw().

◆ UI_view2d_draw_scale_x__discrete_frames_or_seconds()

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 )

Definition at line 570 of file view2d_draw.cc.

References UI_view2d_draw_scale_x__discrete_time(), and UI_view2d_draw_scale_x__discrete_values().

Referenced by ED_time_scrub_draw().

◆ UI_view2d_draw_scale_x__frames_or_seconds()

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 )

Definition at line 585 of file view2d_draw.cc.

References UI_view2d_draw_scale_x__discrete_time(), and UI_view2d_draw_scale_x__values().

Referenced by ED_time_scrub_draw().

◆ UI_view2d_draw_scale_y__block()

void UI_view2d_draw_scale_y__block	(	const ARegion *	region,
		const View2D *	v2d,
		const rcti *	rect,
		int	colorid )

Definition at line 561 of file view2d_draw.cc.

References draw_vertical_scale_indicators(), and view_to_string__value().

◆ UI_view2d_draw_scale_y__values()

void UI_view2d_draw_scale_y__values	(	const ARegion *	region,
		const View2D *	v2d,
		const rcti *	rect,
		int	colorid )

Scale indicator text drawing.

Definition at line 551 of file view2d_draw.cc.

References draw_vertical_scale_indicators(), view2d_major_step_y__continuous(), and view_to_string__value().

Referenced by graph_main_region_draw_overlay(), and graph_region_draw().

◆ UI_view2d_edge_pan_apply()

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

Apply transform to view (i.e. adjust 'cur' rect).

Referenced by blender::ed::transform::flushTransNodes(), and view2d_edge_pan_loc_compensate().

◆ UI_view2d_edge_pan_apply_event()

void void UI_view2d_edge_pan_apply_event	(	bContext *	C,
		View2DEdgePanData *	vpd,
		const wmEvent *	event )

Apply transform to view using mouse events.

Definition at line 273 of file view2d_edge_pan.cc.

References MOUSEMOVE, wmEvent::type, UI_view2d_edge_pan_apply(), and wmEvent::xy.

Referenced by blender::ed::space_node::node_link_modal(), and view_edge_pan_modal().

◆ UI_view2d_edge_pan_cancel()

void UI_view2d_edge_pan_cancel	(	bContext *	C,
		View2DEdgePanData *	vpd )

Definition at line 283 of file view2d_edge_pan.cc.

References View2DEdgePanData::area, CTX_wm_window(), View2D::cur, ED_region_tag_redraw_no_rebuild(), View2DEdgePanData::initial_rect, View2DEdgePanData::region, View2DEdgePanData::screen, UI_view2d_curRect_changed(), UI_view2d_sync(), View2DEdgePanData::v2d, V2D_LOCK_COPY, and WM_event_add_mousemove().

Referenced by blender::ed::transform::flushTransNodes(), blender::ed::space_node::node_link_cancel(), and view2d_edge_pan_loc_compensate().

◆ UI_view2d_edge_pan_init()

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 )

Definition at line 52 of file view2d_edge_pan.cc.

Referenced by blender::ed::transform::createTransNodeData(), createTransSeqData(), and UI_view2d_edge_pan_operator_init().

◆ UI_view2d_edge_pan_operator_init()

void UI_view2d_edge_pan_operator_init	(	bContext *	C,
		View2DEdgePanData *	vpd,
		wmOperator *	op )

Initialize panning data with operator settings.

Definition at line 382 of file view2d_edge_pan.cc.

References wmOperator::ptr, RNA_float_get(), and UI_view2d_edge_pan_init().

Referenced by blender::ed::space_node::node_link_invoke(), and view_edge_pan_invoke().

◆ UI_view2d_edge_pan_operator_properties()

void UI_view2d_edge_pan_operator_properties ( wmOperatorType * ot )

Definition at line 304 of file view2d_edge_pan.cc.

References ot, and UI_view2d_edge_pan_operator_properties_ex().

Referenced by VIEW2D_OT_edge_pan().

◆ UI_view2d_edge_pan_operator_properties_ex()

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 )

Definition at line 316 of file view2d_edge_pan.cc.

References ot, RNA_def_float(), and wmOperatorType::srna.

Referenced by blender::ed::space_node::NODE_OT_link(), and UI_view2d_edge_pan_operator_properties().

◆ UI_view2d_edge_pan_reset()

void UI_view2d_edge_pan_reset ( View2DEdgePanData * vpd )

Definition at line 97 of file view2d_edge_pan.cc.

References BLI_time_now_seconds(), View2D::cur, View2DEdgePanData::edge_pan_last_time, View2DEdgePanData::edge_pan_start_time_x, View2DEdgePanData::edge_pan_start_time_y, View2DEdgePanData::initial_rect, View2DEdgePanData::region, and ARegion::v2d.

Referenced by UI_view2d_edge_pan_init().

◆ UI_view2d_edge_pan_set_limits()

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

Set area which can be panned

Definition at line 91 of file view2d_edge_pan.cc.

References BLI_rctf_init(), and View2DEdgePanData::limit.

Referenced by createTransSeqData().

◆ UI_view2d_fromcontext()

View2D * UI_view2d_fromcontext ( const bContext * C )

View2D data by default resides in region, so get from region stored in context.

Definition at line 1850 of file view2d.cc.

References CTX_wm_area(), and CTX_wm_region().

Referenced by draw_cache_background(), draw_cache_view(), ed_marker_box_select_exec(), ed_marker_move_modal(), ed_marker_select(), ED_markers_draw(), mouse_over_key_get_from_strip(), pixels_to_view_height(), pixels_to_view_width(), retiming_fake_key_frame_clicked(), retiming_mouseover_key_get(), seq_select_seq_from_preview(), sequencer_box_select_exec(), sequencer_box_select_invoke(), sequencer_retiming_box_select_exec(), sequencer_select_exec(), sequencer_select_handle_exec(), sequencer_select_linked_pick_invoke(), sequencer_skip_for_handle_tweak(), sequencer_slip_invoke(), sequencer_slip_modal(), sequencer_split_invoke(), sequencer_view_all_preview_exec(), sequencer_view_selected_exec(), sequencer_view_zoom_ratio_exec(), sequencer_visible_strips_get(), timeline_draw_context_get(), and view_ghost_border_exec().

◆ UI_view2d_fromcontext_rwin()

View2D * UI_view2d_fromcontext_rwin ( const bContext * C )

Same as UI_view2d_fromcontext, but it returns region-window. Utility for pull-downs or buttons.

Definition at line 1864 of file view2d.cc.

References BKE_area_find_region_type(), CTX_wm_area(), CTX_wm_region(), RGN_TYPE_WINDOW, and ARegion::v2d.

◆ UI_view2d_grid_resolution_x__frames_or_seconds()

float UI_view2d_grid_resolution_x__frames_or_seconds	(	const View2D *	v2d,
		const Scene *	scene,
		bool	display_seconds )

Definition at line 449 of file view2d_draw.cc.

References view2d_major_step_x__continuous(), and view2d_major_step_x__time().

Referenced by snap_increment_apply().

◆ UI_view2d_grid_resolution_y__values()

float UI_view2d_grid_resolution_y__values ( const View2D * v2d )

Definition at line 459 of file view2d_draw.cc.

References view2d_major_step_y__continuous().

Referenced by snap_increment_apply().

◆ UI_view2d_listview_view_to_cell()

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 )

Get the 'cell' (row, column) that the given 2D-view coordinates (i.e. in 'tot' rect space) lie in.

Parameters

columnwidth,rowheight	size of each 'cell'
startx,starty	coordinates (in 'tot' rect space) that the list starts from. This should be (0,0) for most views. However, for those where the starting row was offsetted (like for Animation Editor channel lists, to make the first entry more visible), these will be the min-coordinates of the first item.
viewx,viewy	2D-coordinates (in 2D-view / 'tot' rect space) to get the cell for
r_column,r_row	The 'coordinates' of the relevant 'cell'.

Definition at line 1616 of file view2d.cc.

References floorf.

Referenced by actkeys_find_list_element_at_position(), animchannels_channel_get(), animchannels_mouseclick_invoke(), nlaedit_strip_at_region_position(), and nlatracks_mouseclick_invoke().

◆ UI_view2d_mask_from_win()

void UI_view2d_mask_from_win	(	const View2D *	v2d,
		rcti *	r_mask )

Definition at line 109 of file view2d.cc.

References View2D::winx, View2D::winy, rcti::xmax, rcti::xmin, rcti::ymax, and rcti::ymin.

Referenced by ED_region_panels_draw(), and view2d_masks().

◆ UI_view2d_mouse_in_scrollers()

char char UI_view2d_mouse_in_scrollers	(	const ARegion *	region,
		const View2D *	v2d,
		const int	xy[2] )

Referenced by console_cursor(), scroller_activate_invoke(), scroller_activate_poll(), ui_handler_panel_region(), and ui_region_contains_point_px().

◆ UI_view2d_mouse_in_scrollers_ex()

char UI_view2d_mouse_in_scrollers_ex	(	const ARegion *	region,
		const View2D *	v2d,
		const int	xy[2],
		int *	r_scroll )

Check if mouse is within scrollers

Parameters

xy	Mouse coordinates in screen (not region) space.
r_scroll	Return argument for the mapped view2d scroll flag.

Returns

appropriate code for match.

'h' = in horizontal scroller.
'v' = in vertical scroller.
0 = not in scroller.

Referenced by area_actionzone_refresh_xy().

◆ UI_view2d_multi_grid_draw()

void UI_view2d_multi_grid_draw	(	const View2D *	v2d,
		int	colorid,
		float	step,
		int	level_size,
		int	totlevels )

Draw a multi-level grid in given 2d-region.

Definition at line 1176 of file view2d.cc.

References View2D::cur, GPU_COMP_F32, GPU_COMP_U8, GPU_FETCH_FLOAT, GPU_FETCH_INT_TO_FLOAT_UNIT, GPU_line_width(), GPU_PRIM_LINES, GPU_SHADER_3D_FLAT_COLOR, GPU_vertformat_attr_add(), immAttr3ubv(), immAttrSkip(), immBeginAtMost(), immBindBuiltinProgram(), immEnd(), immUnbindProgram(), immVertex2f(), immVertexFormat(), int, pos, TH_GRID, UI_GetThemeColorBlendShade3ubv(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

◆ UI_view2d_offset()

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

Simple pan function (0.0, 0.0) bottom left (0.5, 0.5) center (1.0, 1.0) top right.

Definition at line 1952 of file view2d.cc.

References BLI_rctf_size_x(), BLI_rctf_size_y(), View2D::cur, View2D::tot, UI_view2d_curRect_validate(), rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.

Referenced by ui_handle_panel_header(), and ui_handler_panel_region().

◆ UI_view2d_offset_y_snap_to_closest_page()

void UI_view2d_offset_y_snap_to_closest_page ( View2D * v2d )

Scrolls the view so that the upper edge is at a multiple of the page size.

Definition at line 1975 of file view2d.cc.

References BLI_rctf_size_y(), View2D::cur, UI_view2d_curRect_validate(), view2d_page_size_y(), rctf::ymax, and rctf::ymin.

Referenced by blender::ed::asset::shelf::region_init().

◆ UI_view2d_rect_in_scrollers()

char char char char UI_view2d_rect_in_scrollers	(	const ARegion *	region,
		const View2D *	v2d,
		const rcti *	rect )

Referenced by ui_region_contains_rect_px().

◆ UI_view2d_rect_in_scrollers_ex()

char char char UI_view2d_rect_in_scrollers_ex	(	const ARegion *	region,
		const View2D *	v2d,
		const rcti *	rect,
		int *	r_scroll )

◆ UI_view2d_region_reinit()

void UI_view2d_region_reinit	(	View2D *	v2d,
		short	type,
		int	winx,
		int	winy )

Refresh and validation (of view rects).

Initialize all relevant View2D data (including view rects if first time) and/or refresh mask sizes after view resize.

For some of these presets, it is expected that the region will have defined some additional settings necessary for the customization of the 2D viewport to its requirements
This function should only be called from region init() callbacks, where it is expected that this is called before #UI_view2d_size_update(), as this one checks that the rects are properly initialized.

Definition at line 212 of file view2d.cc.

References View2D::align, View2D::alpha_hor, View2D::alpha_vert, View2D::cur, View2D::flag, float, View2D::keepofs, View2D::keeptot, View2D::keepzoom, View2D::max, View2D::maxzoom, View2D::min, View2D::minzoom, uiStyle::panelzoom, View2D::scroll, View2D::tot, UI_style_get(), ui_view2d_curRect_validate_resize(), V2D_ALIGN_NO_NEG_X, V2D_ALIGN_NO_NEG_Y, V2D_ALIGN_NO_POS_Y, V2D_COMMONVIEW_HEADER, V2D_COMMONVIEW_LIST, V2D_COMMONVIEW_PANELS_UI, V2D_COMMONVIEW_STACK, V2D_COMMONVIEW_STANDARD, V2D_IS_INIT, V2D_KEEPASPECT, V2D_KEEPTOT_BOUNDS, V2D_KEEPTOT_STRICT, V2D_KEEPZOOM, V2D_LIMITZOOM, V2D_LOCKOFS_Y, V2D_LOCKZOOM_X, V2D_LOCKZOOM_Y, V2D_SCROLL_HORIZONTAL_HIDE, V2D_SCROLL_VERTICAL_HIDE, view2d_masks(), view2d_totRect_set_resize(), View2D::winx, View2D::winy, rctf::xmax, rctf::xmin, rctf::ymax, and rctf::ymin.