Blender: wmGesture Struct Reference

Blender V4.3

#include <WM_types.hh>

Public Attributes
wmGesture *	next

wmGesture *	prev

int	event_type

uint8_t	event_modifier

short	event_keymodifier

int	type

rcti	winrct

int	points

int	points_alloc

int	modal_state

bool	draw_active_side

blender::int2	mval

uint	is_active: 1

uint	is_active_prev: 1

uint	wait_for_input: 1

uint	move: 1

uint	use_snap: 1

uint	use_flip: 1

uint	use_smooth: 1

void *	customdata

wmGenericUserData	user_data

Detailed Description

wmGesture is registered to wmWindow.gesture, handled by operator callbacks.

Definition at line 578 of file WM_types.hh.

Member Data Documentation

◆ customdata

void* wmGesture::customdata

customdata

for border is a rcti.
for circle is rcti, (xmin, ymin) is center, xmax radius.
for lasso is short array.
for straight line is a rcti: (xmin, ymin) is start, (xmax, ymax) is end.

Definition at line 629 of file WM_types.hh.

Referenced by draw_filled_lasso(), draw_lasso_smooth_stroke_indicator(), draw_start_vertex_circle(), gesture_box_apply_rect(), gesture_circle_apply(), gesture_lasso_apply(), gesture_polyline_apply(), gesture_polyline_valid_points(), gesture_straightline_apply(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), wm_gesture_draw_circle(), wm_gesture_draw_cross(), wm_gesture_draw_lasso(), wm_gesture_draw_line(), wm_gesture_draw_polyline(), wm_gesture_draw_rect(), WM_gesture_end(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_polyline_modal(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ draw_active_side

bool wmGesture::draw_active_side

Optional, draw the active side of the straight-line gesture.

Definition at line 596 of file WM_types.hh.

Referenced by wm_gesture_draw_line(), and WM_gesture_straightline_active_side_invoke().

◆ event_keymodifier

short wmGesture::event_keymodifier

wmEvent.keymodifier.

Definition at line 585 of file WM_types.hh.

Referenced by WM_gesture_new().

◆ event_modifier

uint8_t wmGesture::event_modifier

wmEvent.modifier.

Definition at line 583 of file WM_types.hh.

Referenced by WM_gesture_new().

◆ event_type

int wmGesture::event_type

Definition at line 581 of file WM_types.hh.

Referenced by WM_gesture_new().

◆ is_active

uint wmGesture::is_active

For modal operators which may be running idle, waiting for an event to activate the gesture. Typically this is set when the user is click-dragging the gesture (box and circle select for eg).

Definition at line 605 of file WM_types.hh.

Referenced by blender::ed::greasepencil::grease_pencil_texture_gradient_invoke(), paint_weight_gradient_invoke(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), wm_gesture_draw(), WM_gesture_lasso_modal(), WM_gesture_polyline_modal(), WM_gesture_straightline_invoke(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ is_active_prev

uint wmGesture::is_active_prev

Previous value of is-active (use to detect first run & edge cases).

Definition at line 607 of file WM_types.hh.

Referenced by WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), WM_gesture_is_modal_first(), WM_gesture_lasso_modal(), WM_gesture_polyline_modal(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ modal_state

int wmGesture::modal_state

Definition at line 594 of file WM_types.hh.

Referenced by gesture_box_apply(), gesture_circle_apply(), WM_gesture_box_modal(), WM_gesture_circle_modal(), WM_gesture_new(), and WM_gesture_straightline_oneshot_modal().

◆ move

uint wmGesture::move

Use for gestures that can be moved, like box selection.

Definition at line 611 of file WM_types.hh.

Referenced by WM_gesture_box_modal(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_polyline_modal(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ mval

blender::int2 wmGesture::mval

Latest mouse position relative to area. Currently only used by lasso drawing code.

Definition at line 598 of file WM_types.hh.

Referenced by draw_lasso_smooth_stroke_indicator(), draw_start_vertex_circle(), gesture_polyline_apply(), gesture_polyline_valid_points(), wm_gesture_draw_polyline(), WM_gesture_lasso_modal(), WM_gesture_new(), and WM_gesture_polyline_modal().

◆ next

wmGesture* wmGesture::next

Definition at line 579 of file WM_types.hh.

Referenced by wm_gesture_draw().

◆ points

int wmGesture::points

Optional, amount of points stored.

Definition at line 591 of file WM_types.hh.

Referenced by draw_filled_lasso(), draw_lasso_smooth_stroke_indicator(), draw_start_vertex_circle(), gesture_lasso_apply(), gesture_polyline_apply(), gesture_polyline_can_apply(), gesture_polyline_valid_points(), wm_gesture_draw_lasso(), wm_gesture_draw_polyline(), WM_gesture_lasso_modal(), WM_gesture_new(), and WM_gesture_polyline_modal().

◆ points_alloc

int wmGesture::points_alloc

Optional, maximum amount of points stored.

Definition at line 593 of file WM_types.hh.

Referenced by WM_gesture_lasso_modal(), WM_gesture_new(), and WM_gesture_polyline_modal().

◆ prev

wmGesture * wmGesture::prev

Definition at line 579 of file WM_types.hh.

◆ type

int wmGesture::type

Gesture type define.

Definition at line 587 of file WM_types.hh.

Referenced by WM_gesture_box_modal(), wm_gesture_draw(), wm_gesture_draw_lasso(), and WM_gesture_new().

◆ use_flip

uint wmGesture::use_flip

For gestures that support flip, stores if flip is enabled using the modal keymap toggle.

Definition at line 617 of file WM_types.hh.

Referenced by gesture_straightline_apply(), wm_gesture_draw_line(), WM_gesture_straightline_active_side_invoke(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ use_smooth

uint wmGesture::use_smooth

For gestures that support smoothing, stores if smoothing is enabled using the modal keymap toggle.

Definition at line 620 of file WM_types.hh.

Referenced by wm_gesture_draw_lasso(), WM_gesture_lasso_invoke(), WM_gesture_lasso_modal(), and WM_gesture_lines_invoke().

◆ use_snap

uint wmGesture::use_snap

For gestures that support snapping, stores if snapping is enabled using the modal keymap toggle.

Definition at line 614 of file WM_types.hh.

Referenced by WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

◆ user_data

wmGenericUserData wmGesture::user_data

Free pointer to use for operator allocations (if set, its freed on exit).

Definition at line 632 of file WM_types.hh.

Referenced by mesh_bisect_exec(), mesh_bisect_invoke(), mesh_bisect_modal(), paint_weight_gradient_exec(), paint_weight_gradient_modal(), view3d_circle_select_exec(), WM_gesture_end(), and WM_gesture_new().

◆ wait_for_input

uint wmGesture::wait_for_input

Use for gestures that support both immediate or delayed activation.

Definition at line 609 of file WM_types.hh.

Referenced by gesture_box_apply(), gesture_circle_apply(), WM_gesture_box_invoke(), WM_gesture_box_modal(), WM_gesture_circle_invoke(), WM_gesture_circle_modal(), and WM_gesture_straightline_oneshot_modal().

◆ winrct

rcti wmGesture::winrct

Bounds of region to draw gesture within.

Definition at line 589 of file WM_types.hh.

Referenced by draw_filled_lasso(), WM_gesture_box_modal(), WM_gesture_circle_modal(), wm_gesture_draw(), WM_gesture_lasso_modal(), WM_gesture_new(), WM_gesture_polyline_modal(), WM_gesture_straightline_modal(), and WM_gesture_straightline_oneshot_modal().

The documentation for this struct was generated from the following file:

WM_types.hh